Package org.pentaho.platform.plugin.services.webservices

Class AbstractAxisConfigurator

  • All Implemented Interfaces:
    Serializable, org.apache.axis2.engine.AxisConfigurator, org.pentaho.platform.api.engine.ILogger
    Direct Known Subclasses:
    SystemSolutionAxisConfigurator
    public abstract class AbstractAxisConfigurator
extends org.pentaho.platform.engine.core.system.PentahoBase
implements org.apache.axis2.engine.AxisConfigurator
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected org.apache.axis2.engine.AxisConfiguration axisConfig  
      protected boolean loaded  
      protected org.pentaho.platform.api.engine.IPentahoSession session  

      • Fields inherited from class org.pentaho.platform.engine.core.system.PentahoBase

        EMPTYLOGID, loggingLevel, LOGID_MASK1, LOGID_MASK2, LOGID_SEPARATOR

      • Fields inherited from interface org.pentaho.platform.api.engine.ILogger

        ACTIVITY_LOG, DEBUG, ERROR, FATAL, INFO, INSTANCE_LOG, SESSION_LOG, SOLUTION_LOG, TRACE, UNKNOWN, WARN

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      abstract void addService​(org.pentaho.platform.api.engine.IServiceConfig ws)  
      protected abstract void addServiceEndPoints​(org.apache.axis2.description.AxisService axisService)
      Adds any implementation-specific web service endpoints for a Axis service
      protected abstract void addTransports​(org.apache.axis2.description.AxisService axisService)
      Adds any implementation-specific transports for a Axis service
      void cleanup()
      An AxisConfigurator method that we don't need
      void engageGlobalModules()
      An AxisConfigurator method that we don't need
      org.apache.axis2.engine.AxisConfiguration getAxisConfiguration()
      Creates the AxisConfiguration object using an XML document.
      abstract InputStream getConfigXml()  
      abstract org.apache.commons.logging.Log getLogger()  
      org.pentaho.platform.api.engine.IServiceConfig getWebServiceDefinition​(String name)  
      protected abstract List<org.pentaho.platform.api.engine.IServiceConfig> getWebServiceDefinitions()
      Returns a list of the web service wrappers for this implmentation
      abstract void init()  
      protected void loadService​(org.pentaho.platform.api.engine.IServiceConfig wsDef)
      Loads a web service from a web service wrapper
      void loadServices()
      Load the web services from the list of web service wrappers
      void reloadServices()  
      abstract boolean setEnabled​(String name, boolean enabled)  
      void setSession​(org.pentaho.platform.api.engine.IPentahoSession session)  
      void unloadServices()  

      • Methods inherited from class org.pentaho.platform.engine.core.system.PentahoBase

        debug, debug, error, error, fatal, fatal, genLogIdFromInfo, genLogIdFromInfo, genLogIdFromSession, getLoggingLevel, getLogId, getObjectName, info, info, setLoggingLevel, setLogId, trace, trace, warn, warn

    • Field Detail

      • axisConfig

        protected org.apache.axis2.engine.AxisConfiguration axisConfig

      • session

        protected org.pentaho.platform.api.engine.IPentahoSession session

      • loaded

        protected boolean loaded

    • Constructor Detail

      • AbstractAxisConfigurator

        public AbstractAxisConfigurator()

    • Method Detail

      • getLogger

        public abstract org.apache.commons.logging.Log getLogger()
        Specified by:
        getLogger in class org.pentaho.platform.engine.core.system.PentahoBase

      • addService

        public abstract void addService​(org.pentaho.platform.api.engine.IServiceConfig ws)

      • reloadServices

        public void reloadServices()
                    throws org.apache.axis2.AxisFault
        Throws:
        org.apache.axis2.AxisFault

      • unloadServices

        public void unloadServices()
                    throws org.apache.axis2.AxisFault
        Throws:
        org.apache.axis2.AxisFault

      • getWebServiceDefinition

        public org.pentaho.platform.api.engine.IServiceConfig getWebServiceDefinition​(String name)

      • getAxisConfiguration

        public org.apache.axis2.engine.AxisConfiguration getAxisConfiguration()
                                                               throws org.apache.axis2.AxisFault
        Creates the AxisConfiguration object using an XML document. Subclasses of this class must provide the XML via an input stream. The concrete implementation can store the XML file wherever it wants as we only need an InputStream
        Specified by:
        getAxisConfiguration in interface org.apache.axis2.engine.AxisConfigurator
        Throws:
        org.apache.axis2.AxisFault

      • getConfigXml

        public abstract InputStream getConfigXml()

      • setEnabled

        public abstract boolean setEnabled​(String name,
                                   boolean enabled)
                            throws org.apache.axis2.AxisFault
        Throws:
        org.apache.axis2.AxisFault

      • init

        public abstract void init()

      • addServiceEndPoints

        protected abstract void addServiceEndPoints​(org.apache.axis2.description.AxisService axisService)
        Adds any implementation-specific web service endpoints for a Axis service
        Parameters:
        axisService - The Axis web service to add end points to

      • addTransports

        protected abstract void addTransports​(org.apache.axis2.description.AxisService axisService)
        Adds any implementation-specific transports for a Axis service
        Parameters:
        axisService - The Axis web service to add end points to

      • getWebServiceDefinitions

        protected abstract List<org.pentaho.platform.api.engine.IServiceConfig> getWebServiceDefinitions()
        Returns a list of the web service wrappers for this implmentation
        Returns:

      • loadServices

        public void loadServices()
        Load the web services from the list of web service wrappers
        Specified by:
        loadServices in interface org.apache.axis2.engine.AxisConfigurator

      • loadService

        protected void loadService​(org.pentaho.platform.api.engine.IServiceConfig wsDef)
                    throws Exception
        Loads a web service from a web service wrapper
        Parameters:
        wrapper - Web service wrapper
        Throws:
        Exception

      • engageGlobalModules

        public void engageGlobalModules()
                         throws org.apache.axis2.AxisFault
        An AxisConfigurator method that we don't need
        Specified by:
        engageGlobalModules in interface org.apache.axis2.engine.AxisConfigurator
        Throws:
        org.apache.axis2.AxisFault

      • cleanup

        public void cleanup()
        An AxisConfigurator method that we don't need
        Specified by:
        cleanup in interface org.apache.axis2.engine.AxisConfigurator

      • setSession

        public void setSession​(org.pentaho.platform.api.engine.IPentahoSession session)