org.dd4t.core.factories

Interface PageFactory

All Superinterfaces:

Factory

public interface PageFactory
extends Factory

Method Summary

Methods

Modifier and Type	Method and Description
<T extends Page> T	deserialize(String source, Class<? extends T> clazz) Deserializes a JSON encoded String into an object of the given type, which must derive from the Page interface
void	executeProcessors(Item item, RunPhase runPhase, RequestContext context)
Page	findPageByUrl(String url, int publicationId) Find page by its URL.
<T extends Page> T	findPageByUrl(String url, int publicationId, Class<T> pageModel) Find page by its URL.
Page	findPageByUrl(String url, int publicationId, RequestContext context) Find page by its URL.
<T extends Page> T	findPageByUrl(String url, int publicationId, RequestContext context, Class<T> pageModel) Find page by its URL.
TCMURI	findPageIdByUrl(String url, int publicationId) Find the TCM Uri of a page by URL
String	findSourcePageByTcmId(String tcmId) Find the source of the Page by Tcm Id.
String	findSourcePageByUrl(String url, int publicationId) Find the source of the Page by Url.
Page	getPage(String uri) Get a page by its URI.
<T extends Page> T	getPage(String uri, Class<T> pageModel) Get a Page by its URI.
Page	getPage(String uri, RequestContext context) Get a page by its URI.
<T extends Page> T	getPage(String uri, RequestContext context, Class<T> pageModel) Get a Page by its URI.
Boolean	isPagePublished(String url, int publicationId) Method to check whether a page exists in the Tridion Broker.

Methods inherited from interface org.dd4t.core.factories.Factory

getProcessors, setCacheProvider, setProcessors

Method Detail

executeProcessors

void executeProcessors(Item item,
                     RunPhase runPhase,
                     RequestContext context)
                       throws FactoryException

Throws:

FactoryException

getPage

Page getPage(String uri)
             throws FactoryException

Get a page by its URI. No security available; the method will fail if a SecurityFilter is configured on the factory.

Parameters:

uri - of the page

Returns:

a Page Object

Throws:

FactoryException

getPage

Page getPage(String uri,
           RequestContext context)
             throws FactoryException

Get a page by its URI. No security available; the method will fail if a SecurityFilter is configured on the factory.

Parameters:

uri - of the page

context - describing the current request to be passed on to processors

Returns:

a Page Object

Throws:

FactoryException

getPage

<T extends Page> T getPage(String uri,
                         Class<T> pageModel)
                       throws FactoryException

Get a Page by its URI. Deserialize into any object implementing the Page interface.

Type Parameters:

T - the Type to return

Parameters:

uri - the page Uri

pageModel - the Class to deserialize into

Returns:

a deserialied object

Throws:

FactoryException

getPage

<T extends Page> T getPage(String uri,
                         RequestContext context,
                         Class<T> pageModel)
                       throws FactoryException

Get a Page by its URI. Deserialize into any object implementing the Page interface.

Type Parameters:

T - the Type to return

Parameters:

uri - the page Uri

pageModel - the Class to deserialize into

Returns:

a deserialied object

Throws:

FactoryException

findPageByUrl

Page findPageByUrl(String url,
                 int publicationId)
                   throws FactoryException

Find page by its URL. The url and publication id are specified. No security available; the method will fail if a SecurityFilter is configured on the factory.

Parameters:

url - of the page

publicationId - of the publication

Returns:

a Page Object

Throws:

FactoryException

findPageByUrl

Page findPageByUrl(String url,
                 int publicationId,
                 RequestContext context)
                   throws FactoryException

Find page by its URL. The url and publication id are specified. No security available; the method will fail if a SecurityFilter is configured on the factory.

Parameters:

url - of the page

publicationId - of the publication

context - describing the current request to be passed on to processors

Returns:

a Page Object

Throws:

FactoryException

findPageByUrl

<T extends Page> T findPageByUrl(String url,
                               int publicationId,
                               Class<T> pageModel)
                             throws FactoryException

Find page by its URL. The url and publication id are specified. Deserialize into any object implementing the Page interface.

Returns:

a Page Object

Throws:

FactoryException

findPageByUrl

<T extends Page> T findPageByUrl(String url,
                               int publicationId,
                               RequestContext context,
                               Class<T> pageModel)
                             throws FactoryException

Find page by its URL. The url and publication id are specified. Deserialize into any object implementing the Page interface.

Returns:

a Page Object

Throws:

FactoryException

findSourcePageByUrl

String findSourcePageByUrl(String url,
                         int publicationId)
                           throws FactoryException

Find the source of the Page by Url. The url and publication id are specified.

Returns:

The page source as string

Throws:

FactoryException

findSourcePageByTcmId

String findSourcePageByTcmId(String tcmId)
                             throws FactoryException

Find the source of the Page by Tcm Id.

Parameters:

tcmId - the Tcm Id of the page

Returns:

The page source as String

Throws:

FactoryException

findPageIdByUrl

TCMURI findPageIdByUrl(String url,
                     int publicationId)
                       throws FactoryException

Find the TCM Uri of a page by URL

Parameters:

url - the URL

publicationId - the Publication Id

Returns:

a TCMURI if found.

Throws:

FactoryException

deserialize

<T extends Page> T deserialize(String source,
                             Class<? extends T> clazz)
                           throws FactoryException

Deserializes a JSON encoded String into an object of the given type, which must derive from the Page interface

Parameters:

source - String representing the JSON encoded object

clazz - Class representing the implementation type to deserialize into

Returns:

the deserialized object

Throws:

FactoryException

isPagePublished

Boolean isPagePublished(String url,
                      int publicationId)

Method to check whether a page exists in the Tridion Broker.

Parameters:

url - the URL to check

publicationId - the publication Id for the url

Returns:

true if the page url exists in the broker