SAP NetWeaver '04

com.sapportals.wcm.service.pipeline.producer
Interface IProducer

[contained in: com.sap.netweaver.bc.rf.service.par - bc.rf.global.service.pipeline_api.jar]
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;
     java.util.Date getLastModified()
              Get the last modified date of the resource if possible, otherwise it returns null
     java.lang.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 java.lang.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 java.util.Date getLastModified()
    Get the last modified date of the resource if possible, otherwise it returns null
    Returns:
    date or null

    SAP NetWeaver '04

    Copyright © 2004 by SAP AG. All Rights Reserved.
    SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary.

    These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.