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

Class AbstractAxisServiceContentGenerator

  • All Implemented Interfaces:
    Serializable, org.pentaho.platform.api.engine.IContentGenerator, org.pentaho.platform.api.engine.ILogger
    Direct Known Subclasses:
    AxisWebServiceRequestDispatcher, HtmlAxisServiceLister
    public abstract class AbstractAxisServiceContentGenerator
extends org.pentaho.platform.engine.services.solution.SimpleContentGenerator
    The base class for serving GenericServlet, i.e. /content/ requests through to an Axis webservice. This class ensures that the webservices system is properly configured before handing over to a subclass for processing of the request.
    Author:
    jamesdixon
    See Also:
    Serialized Form

    • Field Summary

      • Fields inherited from class org.pentaho.platform.engine.services.solution.BaseContentGenerator

        callbacks, instanceId, itemName, messages, outputHandler, parameterProviders, urlFactory, userSession

      • 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
      void createContent​(OutputStream out)  
      abstract void createContent​(org.apache.axis2.engine.AxisConfiguration axisConfiguration, org.apache.axis2.context.ConfigurationContext context, OutputStream out)
      Creates content for this request.
      protected void handleFault​(org.apache.axis2.context.MessageContext msgContext, OutputStream out, boolean http, Throwable e)  
      protected void processAxisFault​(org.apache.axis2.context.MessageContext msgContext, OutputStream out, Throwable e)
      Handles processing of Axis exceptions.

      • Methods inherited from class org.pentaho.platform.engine.services.solution.SimpleContentGenerator

        createContent, getMimeType

      • Methods inherited from class org.pentaho.platform.engine.services.solution.BaseContentGenerator

        getCallback, getItemName, getLogger, setCallbacks, setInstanceId, setItemName, setMessagesList, setOutputHandler, setParameterProviders, setSession, setUrlFactory

      • 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

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

        debug, debug, error, error, fatal, fatal, getLoggingLevel, info, info, setLoggingLevel, trace, trace, warn, warn

    • Constructor Detail

      • AbstractAxisServiceContentGenerator

        public AbstractAxisServiceContentGenerator()

    • Method Detail

      • createContent

        public void createContent​(OutputStream out)
                   throws Exception
        Specified by:
        createContent in class org.pentaho.platform.engine.services.solution.SimpleContentGenerator
        Throws:
        Exception

      • createContent

        public abstract void createContent​(org.apache.axis2.engine.AxisConfiguration axisConfiguration,
                                   org.apache.axis2.context.ConfigurationContext context,
                                   OutputStream out)
                            throws Exception
        Creates content for this request. Subclasses of this class implement this method to handle the processing of a web services request.
        Parameters:
        axisConfiguration - AxisConfiguration
        context - ConfigurationContext
        out - The output stream to write to
        Throws:
        Exception

      • processAxisFault

        protected void processAxisFault​(org.apache.axis2.context.MessageContext msgContext,
                                OutputStream out,
                                Throwable e)
        Handles processing of Axis exceptions.
        Parameters:
        msgContext - The message context that experienced an error
        out - The output stream to write to
        e - The error that occurred