ContentFactory (Oracle Fusion Middleware Site Studio for External Applications Java API Reference)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Oracle® Fusion Middleware Site Studio for External Applications Java API Reference
11g Release 1 (11.1.1)
E17273-02

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

oracle.stellent.wcm.server.content
Class ContentFactory

java.lang.Object oracle.stellent.wcm.server.content.ContentFactory

public class ContentFactory

extends java.lang.Object

Interface used for handling locating files used to during WCM method evaluation.

Field Summary
`static java.lang.String`	`CONTENT_CACHE`

Constructor Summary
`ContentFactory(Provider provider, CacheManager cacheManager, RequestProcessor requestProcessor)`

Method Summary
`CacheManager`	`getCacheManager()`
`ContentCache`	`getContentCache(SiteRequest siteRequest)` Retrieve the Content Cache associated with the given site request
`ContentCache`	`getGlobalContentCache()` Retrieve the shared Content Cache
`Provider`	`getProvider()`
`ProviderContent`	`getStagedFile(ContentID contentID, SiteRequest siteRequest)` Retrieve the path to the file in the JSP context
`ProviderContent`	`getStagedFile(ContentID contentID, SiteRequest siteRequest, java.lang.String cacheKey)` Retrieve the path to the file in the JSP context.
`boolean`	`isCacheEnabled(SiteRequest siteRequest)` Determine if the cache is enabled for this request.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

CONTENT_CACHE

public static final java.lang.String CONTENT_CACHE

See Also:: Constant Field Values

Constructor Detail

ContentFactory

public ContentFactory(Provider provider,
                      CacheManager cacheManager,
                      RequestProcessor requestProcessor)

Method Detail

getProvider

public Provider getProvider()

Returns:: the provider

getCacheManager

public CacheManager getCacheManager()

Returns:: the cache manager

getContentCache

public ContentCache getContentCache(SiteRequest siteRequest)

Retrieve the Content Cache associated with the given site request

Parameters:: siteRequest - the current request
Returns:: the cache

getGlobalContentCache

public ContentCache getGlobalContentCache()

Retrieve the shared Content Cache

Returns:: the global content cache

getStagedFile

public ProviderContent getStagedFile(ContentID contentID,
                                     SiteRequest siteRequest)
                              throws java.io.IOException,
                                     oracle.stellent.ridc.IdcClientException

Retrieve the path to the file in the JSP context

Parameters:: contentID - the content ID or relative web path that uses the contentID for the file name; siteRequest - the site request
Returns:: a reference to the file
Throws:: ServerException; java.io.IOException; oracle.stellent.ridc.IdcClientException

isCacheEnabled

public boolean isCacheEnabled(SiteRequest siteRequest)

Determine if the cache is enabled for this request. This validates the cache has been created and the current request is not in contribution mode.

Parameters:: siteRequest - the site request
Returns:: true if the cache is enabled

getStagedFile

public ProviderContent getStagedFile(ContentID contentID,
                                     SiteRequest siteRequest,
                                     java.lang.String cacheKey)
                              throws java.io.IOException,
                                     oracle.stellent.ridc.IdcClientException

Retrieve the path to the file in the JSP context.

Parameters:: contentID - the content ID; siteRequest - the site request; cacheKey - the cache key to use when looking up the item
Returns:: a reference to the file
Throws:: ServerException; java.io.IOException; oracle.stellent.ridc.IdcClientException