Package com.maxxton.microdocs.publisher

Class MicroDocsPublisher

  • public class MicroDocsPublisher
extends java.lang.Object
    Publish or check reports to the MicroDocs server

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method 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:
        configuration - the config object
        microDocsReport - the report
        projectName - the current project name
        groupName - the group name
        version - the version of the api
        failOnProblems - fail in case of compatibility problems
        env - current environment
        Returns:
        check response
        Throws:
        java.io.IOException - possible IO exception when file is not found

      • 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 - the report
        configuration - configuration server
        projectName - the current project name
        env - current environment
        Returns:
        check response
        Throws:
        java.io.IOException - possible IO exception when file is not found

      • printCheckResponse

        public static boolean printCheckResponse​(CheckResponse response,
                                         java.io.File rootDir)
        Print check response to console
        Parameters:
        response - the response
        rootDir - the rootdir
        Returns:
        succeed or failed