org.dd4t.providers.impl

Class BrokerPageProvider

java.lang.Object

org.dd4t.providers.BaseBrokerProvider

org.dd4t.providers.impl.BrokerPageProvider

All Implemented Interfaces:

BaseProvider, PageProvider

public class BrokerPageProvider
extends BaseBrokerProvider
implements PageProvider

Provides access to Page content and metadata from Content Delivery database. Access to page content is not cached, so as such much be cached externally. Calls to Page meta are cached in the Tridion object cache.

Field Summary

Fields inherited from class org.dd4t.providers.BaseBrokerProvider

cacheProvider, contentIsBase64Encoded, contentIsCompressed

Constructor Summary

Constructors

Constructor and Description
BrokerPageProvider()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	checkPageExists(String url, int publicationId)
org.joda.time.DateTime	getLastPublishDate(String url, int publication)
PageProviderResultItem<String>	getPageById(int id, int publication)
PageProviderResultItem<String>	getPageByURL(String url, int publication)
String	getPageContentById(int id, int publication) Retrieves content of a Page by looking the page up by its item id and Publication id.
String	getPageContentById(String tcmUri)
String	getPageContentByURL(String url, int publication) Retrieves content of a Page by looking the page up by its URL.
TCMURI	getPageIdForUrl(String url, int publicationId)
String	getPageListByPublicationId(int publication) Retrieves a list of URLs for all published Tridion Pages in a Publication.
com.tridion.meta.PageMeta	getPageMetaById(int id, int publication) Retrieves metadata of a Page by looking the page up by its item id and Publication id.
com.tridion.meta.PageMeta	getPageMetaByURL(String url, int publication) Retrieves metadata of a Page by looking the page up by its URL.
protected static com.sdl.web.api.meta.WebPageMetaFactory	getWebPageMetaFactory(int publication)

Methods inherited from class org.dd4t.providers.BaseBrokerProvider

convertStreamToString, decodeAndDecompressContent, encodeUrl, getKey, isContentIsBase64Encoded, setCacheProvider, setContentIsBase64Encoded, setContentIsCompressed

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BrokerPageProvider

public BrokerPageProvider()

Method Detail

getPageById

public PageProviderResultItem<String> getPageById(int id,
                                         int publication)
                                           throws IOException,
                                                  org.dd4t.core.exceptions.ItemNotFoundException,
                                                  org.dd4t.core.exceptions.SerializationException

Specified by:

getPageById in interface PageProvider

Throws:

IOException

org.dd4t.core.exceptions.ItemNotFoundException

org.dd4t.core.exceptions.SerializationException

getPageByURL

public PageProviderResultItem<String> getPageByURL(String url,
                                          int publication)
                                            throws org.dd4t.core.exceptions.ItemNotFoundException,
                                                   org.dd4t.core.exceptions.SerializationException

Specified by:

getPageByURL in interface PageProvider

Throws:

org.dd4t.core.exceptions.ItemNotFoundException

org.dd4t.core.exceptions.SerializationException

getPageContentById

public String getPageContentById(int id,
                        int publication)
                          throws org.dd4t.core.exceptions.ItemNotFoundException,
                                 org.dd4t.core.exceptions.SerializationException

Retrieves content of a Page by looking the page up by its item id and Publication id.

Specified by:

getPageContentById in interface PageProvider

Parameters:

id - int representing the page item id

publication - int representing the Publication id of the page

Returns:

String representing the content of the Page

Throws:

org.dd4t.core.exceptions.ItemNotFoundException - if the requested page does not exist

org.dd4t.core.exceptions.SerializationException

getPageContentByURL

public String getPageContentByURL(String url,
                         int publication)
                           throws org.dd4t.core.exceptions.ItemNotFoundException,
                                  org.dd4t.core.exceptions.SerializationException

Retrieves content of a Page by looking the page up by its URL.

Specified by:

getPageContentByURL in interface PageProvider

Parameters:

url - String representing the path part of the page URL

publication - int representing the Publication id of the page

Returns:

String representing the content of the Page

Throws:

org.dd4t.core.exceptions.SerializationException - if something goes wrong deserializing

org.dd4t.core.exceptions.ItemNotFoundException - if the requested page does not exist

getPageContentById

public String getPageContentById(String tcmUri)
                          throws org.dd4t.core.exceptions.ItemNotFoundException,
                                 ParseException,
                                 org.dd4t.core.exceptions.SerializationException

Specified by:

getPageContentById in interface PageProvider

Throws:

org.dd4t.core.exceptions.ItemNotFoundException

ParseException

org.dd4t.core.exceptions.SerializationException

getPageListByPublicationId

public String getPageListByPublicationId(int publication)
                                  throws org.dd4t.core.exceptions.ItemNotFoundException

Retrieves a list of URLs for all published Tridion Pages in a Publication.

Specified by:

getPageListByPublicationId in interface PageProvider

Parameters:

publication - int representing the Publication id of the page

Returns:

String representing the list of URLs (one URL per line)

Throws:

org.dd4t.core.exceptions.ItemNotFoundException - if the requested page does not exist

getWebPageMetaFactory

protected static com.sdl.web.api.meta.WebPageMetaFactory getWebPageMetaFactory(int publication)

getPageMetaById

public com.tridion.meta.PageMeta getPageMetaById(int id,
                                        int publication)
                                          throws org.dd4t.core.exceptions.ItemNotFoundException

Retrieves metadata of a Page by looking the page up by its item id and Publication id.

Parameters:

id - int representing the page item id

publication - int representing the Publication id of the page

Returns:

PageMeta representing the metadata of the Page

Throws:

org.dd4t.core.exceptions.ItemNotFoundException - if the requested page does not exist

getPageMetaByURL

public com.tridion.meta.PageMeta getPageMetaByURL(String url,
                                         int publication)
                                           throws org.dd4t.core.exceptions.ItemNotFoundException

Retrieves metadata of a Page by looking the page up by its URL.

Parameters:

url - String representing the path part of the page URL

publication - int representing the Publication id of the page

Returns:

PageMeta representing the metadata of the Page

Throws:

org.dd4t.core.exceptions.ItemNotFoundException - if the requested page does not exist

checkPageExists

public boolean checkPageExists(String url,
                      int publicationId)
                        throws org.dd4t.core.exceptions.ItemNotFoundException,
                               org.dd4t.core.exceptions.SerializationException

Specified by:

checkPageExists in interface PageProvider

Throws:

org.dd4t.core.exceptions.ItemNotFoundException

org.dd4t.core.exceptions.SerializationException

getPageIdForUrl

public TCMURI getPageIdForUrl(String url,
                     int publicationId)
                       throws org.dd4t.core.exceptions.ItemNotFoundException,
                              org.dd4t.core.exceptions.SerializationException

Specified by:

getPageIdForUrl in interface PageProvider

Throws:

org.dd4t.core.exceptions.ItemNotFoundException

org.dd4t.core.exceptions.SerializationException

getLastPublishDate

public org.joda.time.DateTime getLastPublishDate(String url,
                                        int publication)
                                          throws org.dd4t.core.exceptions.ItemNotFoundException

Specified by:

getLastPublishDate in interface PageProvider

Throws:

org.dd4t.core.exceptions.ItemNotFoundException