Skip navigation links

oracle.stellent.wcm.server.content.spi
Interface ContentAdapter

All Known Implementing Classes:

FSContentAdapter, FSLocalModifiedContentAdapter

public interface ContentAdapter

Content adapter; handles all requests for content and its associated metadata.

Nested Class Summary

static class	ContentAdapter.DataFileParams Data file parameters
static class	ContentAdapter.RenditionParams Rendition parameters

Method Summary

void	flushAllContent() Flush all stored content
void	flushContent(ContentID contentID) Flush any local cache or content related to the given content ID
void	flushResourceContent(java.util.Set<java.lang.String> modifiedResources) Flush static resource content
ContentURI	getContentUri(ContentID contentID, oracle.stellent.ridc.model.DataBinder metaBinder) Retrieve the ContentURI for this content object, based on the given metadata.
ContentURI	getDataFileUri(ContentID contentID, oracle.stellent.ridc.model.DataBinder metaBinder, ContentAdapter.DataFileParams params) Retrieve the ContentURI for this data file content object, based on the given metadata and params.
ContentURI	getRenditionUri(ContentID contentID, oracle.stellent.ridc.model.DataBinder metaBinder, ContentAdapter.RenditionParams params) Retrieve the ContentURI for a given rendition.
ContentStream	loadContent(ContentURI uri) Load content from the provider via the ContentURI obtained from the call to getContentUri(oracle.stellent.wcm.server.content.spi.ContentID, oracle.stellent.ridc.model.DataBinder).
oracle.stellent.ridc.model.DataBinder	loadMetadata(ContentID contentID) Load metadata from the provider for the given content ID.
ContentURI	parseWebPath(java.lang.String webPath) Create a ContentURI from a web path.

Method Detail

loadContent

ContentStream loadContent(ContentURI uri)
                          throws oracle.stellent.ridc.IdcClientException,
                                 java.io.IOException

Load content from the provider via the ContentURI obtained from the call to getContentUri(oracle.stellent.wcm.server.content.spi.ContentID, oracle.stellent.ridc.model.DataBinder).

Parameters:

uri - the ContentURI

Returns:

the content stream

Throws:

oracle.stellent.ridc.IdcClientException

java.io.IOException

loadMetadata

oracle.stellent.ridc.model.DataBinder loadMetadata(ContentID contentID)
                                                   throws oracle.stellent.ridc.IdcClientException,
                                                          java.io.IOException

Load metadata from the provider for the given content ID.

Parameters:

contentID - the content ID

Returns:

the metadata for the content item

Throws:

oracle.stellent.ridc.IdcClientException

java.io.IOException

parseWebPath

ContentURI parseWebPath(java.lang.String webPath)
                        throws oracle.stellent.ridc.IdcClientException,
                               java.io.IOException

Create a ContentURI from a web path. A web path could be one of followings:

1, Unmanaged content;

2, Managed regular content;

3, Dynamic conversion eligible content;

4, Rendition content.

Parameters:

webPath - a web path

Returns:

a ContentURI

Throws:

oracle.stellent.ridc.IdcClientException - if an error occurs while talking to Content Server

java.io.IOException - if an IO error occurs

getContentUri

ContentURI getContentUri(ContentID contentID,
                         oracle.stellent.ridc.model.DataBinder metaBinder)
                         throws oracle.stellent.ridc.IdcClientException

Retrieve the ContentURI for this content object, based on the given metadata.

Parameters:

contentID - the content ID used to retrieve the metadata

metaBinder - the metadata retrieved for this object

Returns:

the ContentURI for this content

Throws:

oracle.stellent.ridc.IdcClientException

getDataFileUri

ContentURI getDataFileUri(ContentID contentID,
                          oracle.stellent.ridc.model.DataBinder metaBinder,
                          ContentAdapter.DataFileParams params)
                          throws oracle.stellent.ridc.IdcClientException

Retrieve the ContentURI for this data file content object, based on the given metadata and params.

Parameters:

contentID - the content ID used to retrieve the metadata

metaBinder - the metadata retrieved for this object

params - arguments for data file retrieval

Returns:

the ContentURI for this content

Throws:

oracle.stellent.ridc.IdcClientException

getRenditionUri

ContentURI getRenditionUri(ContentID contentID,
                           oracle.stellent.ridc.model.DataBinder metaBinder,
                           ContentAdapter.RenditionParams params)
                           throws oracle.stellent.ridc.IdcClientException

Retrieve the ContentURI for a given rendition.

Parameters:

contentID - the content ID

metaBinder - the metadata retrieved for this object

params - the rendition parameters

Returns:

the ContentURI for this content rendition

Throws:

oracle.stellent.ridc.IdcClientException

flushAllContent

void flushAllContent()
                     throws java.io.IOException

Flush all stored content

Throws:

java.io.IOException

flushResourceContent

void flushResourceContent(java.util.Set<java.lang.String> modifiedResources)
                          throws java.io.IOException

Flush static resource content

Parameters:

modifiedResources - a set of resources that have been modified and therefor need to be flushed.

Throws:

java.io.IOException

flushContent

void flushContent(ContentID contentID)
                  throws java.io.IOException

Flush any local cache or content related to the given content ID

Parameters:

contentID - the content ID

Throws:

java.io.IOException

Skip navigation links