Package adams.flow.rest.feature

Class OpenAPIFeature

  • All Implemented Interfaces:
    adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.SizeOfHandler, Serializable
    public class OpenAPIFeature
extends AbstractFeature
    Enables OpenAPI documentation at /api-docs/?url=/openapi.json
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      • Fields inherited from class adams.core.option.AbstractOptionHandler

        m_OptionManager

      • Fields inherited from class adams.core.logging.LoggingObject

        m_Logger, m_LoggingIsEnabled, m_LoggingLevel

    • Constructor Summary

      Constructors 
      Constructor Description
      OpenAPIFeature()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean applyFeature​(org.apache.cxf.jaxrs.JAXRSServerFactoryBean factory, RESTPlugin[] plugins)
      Applies the feature to the server factory bean.
      String globalInfo()
      Returns a string describing the object.

      • Methods inherited from class adams.core.option.AbstractOptionHandler

        cleanUpOptions, defineOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, reset, toCommandLine, toString

      • Methods inherited from class adams.core.logging.CustomLoggingLevelObject

        setLoggingLevel

      • Methods inherited from class adams.core.logging.LoggingObject

        configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

      • Methods inherited from interface adams.core.logging.LoggingLevelHandler

        getLoggingLevel

    • Constructor Detail

      • OpenAPIFeature

        public OpenAPIFeature()

    • Method Detail

      • globalInfo

        public String globalInfo()
        Returns a string describing the object.
        Specified by:
        globalInfo in interface adams.core.GlobalInfoSupporter
        Specified by:
        globalInfo in class adams.core.option.AbstractOptionHandler
        Returns:
        a description suitable for displaying in the gui

      • applyFeature

        public boolean applyFeature​(org.apache.cxf.jaxrs.JAXRSServerFactoryBean factory,
                            RESTPlugin[] plugins)
        Applies the feature to the server factory bean.
        Specified by:
        applyFeature in class AbstractFeature
        Parameters:
        factory - the factory to update
        plugins - the REST plugins that are to be used
        Returns:
        true if successfully applied