com.sapportals.wcm.util.content

Interface IContent

All Known Subinterfaces:

IContentFilter, IContentFilter2, IReadOnlyContentFilter, IURLContent

All Known Implementing Classes:

Content, URLContent, VaryingContent

public interface IContent

A resource implements this interface to provide content access.

This class provides access both to the actual content and the meta data related to it. This set of information MUST be consistent.

The following usage patterns need to be considered:

Accessing just the meta data: This is the typical call pattern when the client only needs the meta data, but won't actually read the content (for instance when displaying information about the members of a collection). In this case, getInputStream() will not be called. Note that implementations should avoid to internally open an input stream if the caller doesn't access it.

Accessing both content and meta data: This requires that the meta data returned accurately reflects the input stream that is returned and is the typical use case for an HTTP GET operation on the content (content length when known MUST be accurate). In this scenario, a client SHOULD call getInputStream() first, this allows the implementation to get a consistent set of meta data related to the input stream. If the client does not follow this recommended calling sequence, an implementation may have to signal a ContentException when it detects that meta data returned earlier does not match the actual data of the input stream opened. If the resource was deleted after the content object was created, the implementation SHOULD report a ResourceNotFoundException when trying to retrieve the input stream.

Copyright (c) SAP AG 2001-2003

Method Summary

void	close() Stop using this content object.
long	getContentLength() Returns the length of the resource content
String	getContentType() Returns the content type of the resource data
String	getEncoding() Returns the name of the character encoding of textual content
InputStream	getInputStream() Returns the input stream of the resource content.

Method Detail

getInputStream

InputStream getInputStream()
                           throws ContentException

Returns the input stream of the resource content.

Returns:

The resource content as byte stream.

Throws:

ContentException

getContentLength

long getContentLength()
                      throws ContentException

Returns the length of the resource content

Returns:

the length in bytes (when unknown: -1)

Throws:

ContentException

getContentType

String getContentType()
                      throws ContentException

Returns the content type of the resource data

Returns:

The media subtype

Throws:

ContentException

getEncoding

String getEncoding()
                   throws ContentException

Returns the name of the character encoding of textual content

Returns:

The name of the encoding (when unknown: null )

Throws:

ContentException - Exception raised in failure situation

close

void close()

Stop using this content object.

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-CM	[sap.com] tc/km/frwk	api	EP-KM-CM
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM