com.endeca.infront.content.source

Interface ContentSource

All Known Implementing Classes:

AbstractContentSource, AuthoringContentSource, LiveContentSource, WorkbenchContentSource

public interface ContentSource

Defines a source to retrieve content for the application.

Method Summary

Methods

Modifier and Type	Method and Description
void	destroy() Performs any actions needed to clean up after the content source.
List<ContentItem>	getContent(List<String> pContentPath) This method fetches a list of content items given the paths to those items.
ContentLocator	resolveContent(javax.servlet.http.HttpServletRequest pRequest) Similar to resolveContent(String), but attempts to infer the content URI from the path info of the given servlet request.
ContentLocator	resolveContent(String pContentUri) Returns a ContentLocator which can be used to provide information about the location of the content represented by the given URI or retrieve the actual content.

Method Detail

resolveContent

ContentLocator resolveContent(String pContentUri)
                              throws ContentException

Returns a ContentLocator which can be used to provide information about the location of the content represented by the given URI or retrieve the actual content.

Parameters:

pContentUri - The URI to access for content. The string should be properly URL-encoded.

Returns:

a ContentLocator with the location of the content.

Throws:

ContentException - Thrown when there is an error accessing or forming content.

resolveContent

ContentLocator resolveContent(javax.servlet.http.HttpServletRequest pRequest)
                              throws ContentException

Similar to resolveContent(String), but attempts to infer the content URI from the path info of the given servlet request.

Parameters:

pRequest - The HttpServletRequest containing the content URI.

Returns:

a ContentLocator with the information that was inferred from the HttpServletRequest.

Throws:

ContentException - Thrown when there is an error accessing or forming content.

getContent

List<ContentItem> getContent(List<String> pContentPath)
                             throws ContentException

This method fetches a list of content items given the paths to those items. The content source that implements this method will be responsible for interpreting these paths to arrive at the content items.

Parameters:

pContentPath - The list of paths to the node store that point to content items.

Returns:

The list of ContentItem objects associated with the supplied content paths.

Throws:

ContentException - Thrown when there is an error accessing or forming content.

destroy

void destroy()

Performs any actions needed to clean up after the content source.