com.maxxton.microdocs.publisher

Class MicroDocsPublisher

java.lang.Object

com.maxxton.microdocs.publisher.MicroDocsPublisher

public class MicroDocsPublisher
extends java.lang.Object

Publish or check reports to the MicroDocs server

Constructor Summary

Constructors

Constructor and Description
MicroDocsPublisher()

Method Summary

Modifier and Type	Method and Description
static CheckResponse	checkProject(ServerConfiguration configuration, java.io.File microDocsReport, java.lang.String projectName, java.lang.String env) Check report at the MicroDocs server for problems
static boolean	printCheckResponse(CheckResponse response, java.io.File rootDir) Print check response to console
static CheckResponse	publishProject(ServerConfiguration configuration, java.io.File microDocsReport, java.lang.String projectName, java.lang.String groupName, java.lang.String version, boolean failOnProblems, java.lang.String env) Publish report on the MicroDocs server

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MicroDocsPublisher

public MicroDocsPublisher()

Method Detail

publishProject

public static CheckResponse publishProject(ServerConfiguration configuration,
                                           java.io.File microDocsReport,
                                           java.lang.String projectName,
                                           java.lang.String groupName,
                                           java.lang.String version,
                                           boolean failOnProblems,
                                           java.lang.String env)
                                    throws java.io.IOException

Publish report on the MicroDocs server

Parameters:

microDocsReport -

projectName -

groupName -

version -

configuration -

Returns:

check response

Throws:

java.io.IOException

checkProject

public static CheckResponse checkProject(ServerConfiguration configuration,
                                         java.io.File microDocsReport,
                                         java.lang.String projectName,
                                         java.lang.String env)
                                  throws java.io.IOException

Check report at the MicroDocs server for problems

Parameters:

microDocsReport -

configuration -

Returns:

check response

Throws:

java.io.IOException

printCheckResponse

public static boolean printCheckResponse(CheckResponse response,
                                         java.io.File rootDir)

Print check response to console

Parameters:

response -

rootDir -

Returns:

succeed or failed