Package com.sapportals.wcm.service.pipeline.producer

Contains interfaces to prepare content for a transformation to a different layout or format.

See:
Description

Interface Summary

IProducer

A producer prepares input data for further processing.

Class Summary

AbstractProducer	Abstract base class for WCM Prodcuer.
ProducerFromResource	Provides access to a resource.
ProducerFromStream	Provides access to a stream.
ProducerFromString	Provides access to a XML-Strings or XML-DOM (Document ).
ProducerFromUrl	Provides access via URL.

Package com.sapportals.wcm.service.pipeline.producer Description

Contains interfaces to prepare content for a transformation to a different layout or format.

Package Specification

Purpose
Detailed Concept
Interfaces and Classes
Related Documentation

Purpose

The producer is one of the parts of the publishing pipeline. It prepares content for the processing steps that are carried out by the publishing pipeline to change the layout or format of resources.

Detailed Concept

When a request to process content with the publishing pipeline is issued, the pipeline controller first starts the producer. The producer prepares the content for the actual transformation process that is carried out by the pipeline. It determines the content type. Then, depending on whether the content is XML or non-XML, it performs different actions:

• XML
  The producer converts the XML into an XML DOM with the help of an XML parser. The DOM is then passed on to the appropriate pipeline processor.

• Non-XML
  The producer creates an input stream from the content. It also creates an empty XML DOM that serves as a container for the instructions that are required by the pipeline controller that supervises the pipeline processing. Both the input stream and the empty XML DOM are passed on to the appropriate pipeline processor. In some cases the producer already receives the resource as an input stream and therefore does not have to create the stream.

Interfaces and Classes

The producer package contains the IProducer interface and a number of classes that implement the interface. The classes represent different types of producers that handle different sources of content:

• ProducerFromResource prepares content originating from a resource
• ProducerFromStream prepares content form a stream
• ProducerFromString prepares content from a string
• ProducerFromURL prepares content from a URL

In the KM environment, the content is normally fetched from a resource. For this reason the ProducerFromResource is most commonly used. The central method of the IProducer interface is getData(). It accesses the content and converts an XML to an XML DOM or a non-XML to a stream.

Related Documentation

For an overview of the publishing pipeline and the role of the producer within the pipeline see:
com.sapportals.wcm.service.pipeline