Package com.sap.portal.httpconnectivity.transformationservice

Provides portal services, classes and interfaces that enable transformation of XML sources.

See:
Description

Interface Summary

IPageContextHolder	The interface that provides holders for the HTMLB page context in the transformation service.
ITransformerInformation	The interface that represents transformer information, and is used to initialize transformers, get their properties and to specify transformers.
ITransformerProperties	The interface for getting the transformer input fields.
ITransformerService	The interface for the transformation service that enables the transformation of XML to a scheme.

Class Summary

AbstractTransformerHolder	An abstract class for creating a transformer holder.
EPSAXDefaultHandler	An abstract base class for the SAX transformers used in the transformation service.
TransformersProvider	A class that implements a simple transformer provider for the transformation service.
TransformerType	A class that defines the transformers type.

Exception Summary

TransformationServiceException

The general exception thrown by the transformation service.

Package com.sap.portal.httpconnectivity.transformationservice Description

Provides portal services, classes and interfaces that enable transformation of XML sources.

This package is part of the HTTP connectivity framework provided by the portal. XML iViews use this package as their engine for transfomation, retrieving the content and setting transformation options. The package is divided into two parts:

• Transformation Service: Transforms an XML source using transformers.
• Transformers Provider: Registers and removes transformers.

The main interface in the package is ITransformerService , the transformation service. The transformation service is responsible for the actual transformation of the XML sources (see com.sap.portal.httpconnectivity.transformationservice.xmlsource).

The transformation service is based on the SAP XML toolkit that implements JAXP. It supports all JAXP XML source and result formats and provides the HTTPStreamSource source. Based on the content fetching service, the HTTPStreamSource source enables caching, proxy settings and access to properties defined in the Portal Content Directory (PCD). The transformation service comes with built-in transformers.

XML transformation is performed using XSL and SAX transformers. Transformers are registered once, and then can be used in combination with predefined transformers without the need to re-register them each time before a transformation. Transformation can be performed using previously registered transformers only. Registered transformers can also be used by other content developers using the XML iView user interface from the portal. Combining several transformers to produce one output is called pipe transformation. Pipe transformation enables you to develop lightweight transformers and connect them together to form one powerful transformer.

Each transformer has the following attributes gathered by ITransformerInformation:

• Name: The name of the transformer. The name must be unique for an application component.
• Component Name: The name of the portal component or portal service that registered the transformer.
• Version: The version of the transformer.
• Transformer Type: The registration type of the transformer as defined in TransformerType.
• From Scheme: XML input format.
• To Scheme: XML output format.
• Description: A general description of the transformer.

A transformer provider is a PAR file that contains the transformers. The PAR file -- via the registry section in the portalapp.xml -- is responsible for registering and removing the transformers from the list of transformers in the transformation service. All the transformers are registered in the service as persistent (TransformerType#PERSISTENT). The provider can contain several XSL and SAX transformers.

The provider's default implementation is the class: TransformersProvider. This class is used as the base for customization.

Since:

EP 6.0 SP7