com.sapportals.wcm.service.pipeline
Interface IPipelineService

[contained in: com.sap.netweaver.bc.rf.service.par - bc.rf.global.service.pipeline_api.jar]

All Superinterfaces:

IService

public interface IPipelineService

extends IService

Interface for the WCM pipeline service.

Copyright 2004 SAP AG

Method Summary

java.util.Properties	getConfiguration() this method returns the configuration data von the PipelineService
java.lang.Object	getTool(java.lang.String toolName) this method returns a tool of the PipelineService.
IXmlParser	getXmlParser() this method returns the XML Parser used by the PipelineService
IXslTransformer	getXslTransformer() this method returns the XSL transfomer used by the PipelineService
IContent	handle(IProducer producer, IProcessor defaultProcessor, java.util.Hashtable properties)

Methods inherited from interface com.sapportals.wcm.service.IService

getDescription, getDescription, getID

Method Detail

handle

public IContent handle(IProducer producer,
                       IProcessor defaultProcessor,
                       java.util.Hashtable properties)
                throws WcmException

Parameters:

producer - data to transform.

defaultProcessor - the default processor.

properties - Properties are passed to the processor and formatter. E.g. they can be used to define additinonal XSL top level parameters. All property names starting with "wpl_" are reserved for intenal use of the WCM pipeline service!

Returns:

result of the XSL transformation

Throws:

WcmException - Exception raised in failure situation

getTool

public java.lang.Object getTool(java.lang.String toolName)
                         throws WcmException

this method returns a tool of the PipelineService.

Parameters:

toolName - name of the tool

Returns:

tool of the PipelineService

Throws:

WcmException - Exception raised in failure situation

getXmlParser

public IXmlParser getXmlParser()
                        throws WcmException

this method returns the XML Parser used by the PipelineService

Returns:

XML Parser

Throws:

WcmException - Exception raised in failure situation

See Also:

IXmlParser

getXslTransformer

public IXslTransformer getXslTransformer()
                                  throws WcmException

this method returns the XSL transfomer used by the PipelineService

Returns:

XSL transfomer

Throws:

WcmException - Exception raised in failure situation

getConfiguration

public java.util.Properties getConfiguration()
                                      throws WcmException

this method returns the configuration data von the PipelineService

Returns:

configuration data

Throws:

WcmException - Exception raised in failure situation