org.apache.cocoon.environment
Interface Source

All Superinterfaces:
Poolable, Recyclable, XMLizable
All Known Subinterfaces:
ModifiableSource, WriteableSource
All Known Implementing Classes:
AbstractSAXSource, AbstractStreamSource, AbstractStreamWriteableSource, AvalonToCocoonSource, DelayedRefreshSourceWrapper, FileSource, SitemapSource, URLSource

Deprecated. Use the Source interface instead

public interface Source
extends Recyclable, XMLizable

Description of a source. This interface provides a simple interface for accessing a source of data. The source of data is assumed to not change during the lifetime of the Source object. If you have a data source that can change its content and you want it to reflect in Cocoon, use a ModifiableSource object instead.

Version:
CVS $Id: Source.html 1304258 2012-03-23 10:09:27Z ilgrosso $
Author:
Carsten Ziegeler, Ovidiu Predescu

Method Summary
 long getContentLength()
          Deprecated. Get the content length of the source or -1 if it is not possible to determine the length.
 InputSource getInputSource()
          Deprecated. Return an InputSource object to read the XML content.
 InputStream getInputStream()
          Deprecated. Return an InputStream object to read from the source.
 long getLastModified()
          Deprecated. Get the last modification date of the source or 0 if it is not possible to determine the date.
 String getSystemId()
          Deprecated. Return the unique identifer for this source
 
Methods inherited from interface org.apache.avalon.excalibur.pool.Recyclable
recycle
 
Methods inherited from interface org.apache.excalibur.xml.sax.XMLizable
toSAX
 

Method Detail

getLastModified

long getLastModified()
Deprecated. 
Get the last modification date of the source or 0 if it is not possible to determine the date.


getContentLength

long getContentLength()
Deprecated. 
Get the content length of the source or -1 if it is not possible to determine the length.


getInputStream

InputStream getInputStream()
                           throws ProcessingException,
                                  IOException
Deprecated. 
Return an InputStream object to read from the source.

Throws:
ProcessingException
IOException

getInputSource

InputSource getInputSource()
                           throws ProcessingException,
                                  IOException
Deprecated. 
Return an InputSource object to read the XML content.

Returns:
an InputSource value
Throws:
ProcessingException - if an error occurs
IOException - if an error occurs

getSystemId

String getSystemId()
Deprecated. 
Return the unique identifer for this source



Copyright © 1999-2010 The Apache Software Foundation. All Rights Reserved.