com.sapportals.wcm.service.pipeline.producer

Interface IProducer

All Known Implementing Classes:

AbstractProducer, ProducerFromUrl

public interface IProducer

A producer prepares input data for further processing. The following producers are available:

ProducerFromResource : Gets the data from a resource

ProducerFromStream : Gets data from stream

ProducerFromString : Gets data from string or from DOM

ProducerFromURL : Gets data from URL

It is recommended to use ProducerFromResource whenever possible. Each WCM Pipeline Producer must implement this Interface.

Copyright 2004 SAP AG

Method Summary

RequestData	getData() This method is responsible to provide a Content object which contains the XML DOM and/or a stream to non XML data;
Date	getLastModified() Get the last modified date of the resource if possible, otherwise it returns null
String	getPath() Returns the path where the resource is found, or an empty string if no path can be applied to the resource.

Method Detail

getData

public RequestData getData()
                    throws WcmException

This method is responsible to provide a Content object which contains the XML DOM and/or a stream to non XML data;

Returns:

content object

Throws:

WcmException - Exception raised in failure situation

getPath

public String getPath()

Returns the path where the resource is found, or an empty string if no path can be applied to the resource.

Returns:

resource path or empty string

getLastModified

public Date getLastModified()

Get the last modified date of the resource if possible, otherwise it returns null

Returns:

date or null