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

Class HtmlAxisServiceLister

java.lang.Object

org.pentaho.platform.engine.core.system.PentahoBase

org.pentaho.platform.engine.services.solution.BaseContentGenerator

org.pentaho.platform.engine.services.solution.SimpleContentGenerator

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

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

All Implemented Interfaces:

Serializable, org.pentaho.platform.api.engine.IContentGenerator, org.pentaho.platform.api.engine.ILogger

Direct Known Subclasses:

StyledHtmlAxisServiceLister

public class HtmlAxisServiceLister
extends AbstractAxisServiceContentGenerator

A content generator for listing metadata on Axis web services.

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

Constructor Summary

Constructors

Constructor and Description
HtmlAxisServiceLister()

Method Summary

Modifier and Type	Method and Description
void	createContent(org.apache.axis2.engine.AxisConfiguration axisConfiguration, org.apache.axis2.context.ConfigurationContext context, OutputStream out) Creates content for this request.
org.apache.commons.logging.Log	getLogger()
String	getMimeType()
protected void	getOperationsSection(org.apache.axis2.description.AxisService axisService, StringBuilder sb) Writes the list of operations for a service to the HTML page
protected void	getPageFooter(HashMap serviceMap, StringBuilder sb) Writes the HTML page footer
protected void	getPageTitle(HashMap serviceMap, StringBuilder sb) Writes the HTML page title area
protected void	getRunSection(org.apache.axis2.description.AxisService axisService, StringBuilder sb) Writes the execute URL section for a service to the HTML page
protected void	getTitleSection(org.apache.axis2.description.AxisService axisService, org.apache.axis2.engine.AxisConfiguration axisConfiguration, StringBuilder sb) Writes the title section for a service to the HTML page
protected void	getWsdlSection(org.apache.axis2.description.AxisService axisService, StringBuilder sb) Writes the WSDL section for a service to the HTML page

Methods inherited from class org.pentaho.platform.plugin.services.webservices.content.AbstractAxisServiceContentGenerator

createContent, handleFault, processAxisFault

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

createContent

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

getCallback, getItemName, 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 class java.lang.Object

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

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

HtmlAxisServiceLister

public HtmlAxisServiceLister()

Method Detail

createContent

public void createContent(org.apache.axis2.engine.AxisConfiguration axisConfiguration,
                          org.apache.axis2.context.ConfigurationContext context,
                          OutputStream out)
                   throws Exception

Description copied from class: AbstractAxisServiceContentGenerator

Creates content for this request. Subclasses of this class implement this method to handle the processing of a web services request.

Specified by:

createContent in class AbstractAxisServiceContentGenerator

Parameters:

axisConfiguration - AxisConfiguration

context - ConfigurationContext

out - The output stream to write to

Throws:

Exception

getPageTitle

protected void getPageTitle(HashMap serviceMap,
                            StringBuilder sb)

Writes the HTML page title area

Parameters:

serviceMap - Map of current web services

sb - StringBuilder to write content to

getTitleSection

protected void getTitleSection(org.apache.axis2.description.AxisService axisService,
                               org.apache.axis2.engine.AxisConfiguration axisConfiguration,
                               StringBuilder sb)

Writes the title section for a service to the HTML page

Parameters:

axisService - the Axis service

axisConfiguration - the Axis configuration

sb - StringBuilder to write content to

getWsdlSection

protected void getWsdlSection(org.apache.axis2.description.AxisService axisService,
                              StringBuilder sb)

Writes the WSDL section for a service to the HTML page

Parameters:

axisService - the Axis service

sb - StringBuilder to write content to

getRunSection

protected void getRunSection(org.apache.axis2.description.AxisService axisService,
                             StringBuilder sb)

Writes the execute URL section for a service to the HTML page

Parameters:

axisService - the Axis service

sb - StringBuilder to write content to

getOperationsSection

protected void getOperationsSection(org.apache.axis2.description.AxisService axisService,
                                    StringBuilder sb)

Writes the list of operations for a service to the HTML page

Parameters:

axisService - the Axis service

sb - StringBuilder to write content to

getPageFooter

protected void getPageFooter(HashMap serviceMap,
                             StringBuilder sb)

Writes the HTML page footer

Parameters:

serviceMap - Map of current web services

sb - StringBuilder to write content to

getMimeType

public String getMimeType()

Specified by:

getMimeType in class org.pentaho.platform.engine.services.solution.SimpleContentGenerator

getLogger

public org.apache.commons.logging.Log getLogger()

Specified by:

getLogger in class org.pentaho.platform.engine.services.solution.BaseContentGenerator