org.dd4t.providers

Interface PageProvider

All Superinterfaces:

BaseProvider

public interface PageProvider
extends BaseProvider

Page Provider.Reads Pages by their URL or id.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	checkPageExists(String url, int publicationId) Checks whether a page exists (published from Tridion) by querying its URL
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)
String	getPageContentById(String tcmUri) Retrieves a Page by its TCMURI.
String	getPageContentByURL(String url, int publication) Retrieves a Page by its Publication and URL.
TCMURI	getPageIdForUrl(String url, int publicationId)
String	getPageListByPublicationId(int publication) Retrieves a list of published page URLs as one String.

Method Detail

getPageById

PageProviderResultItem<String> getPageById(int id,
                                         int publication)
                                           throws IOException,
                                                  ItemNotFoundException,
                                                  SerializationException

Throws:

IOException

ItemNotFoundException

SerializationException

getPageByURL

PageProviderResultItem<String> getPageByURL(String url,
                                          int publication)
                                            throws ItemNotFoundException,
                                                   SerializationException

Throws:

ItemNotFoundException

SerializationException

getPageContentById

String getPageContentById(int id,
                        int publication)
                          throws IOException,
                                 ItemNotFoundException,
                                 SerializationException

Throws:

IOException

ItemNotFoundException

SerializationException

getPageContentByURL

String getPageContentByURL(String url,
                         int publication)
                           throws ItemNotFoundException,
                                  SerializationException

Retrieves a Page by its Publication and URL. It returns JSON representing a Page model object.

Parameters:

url - String representing the path part of the page URL

publication - int representing the context Publication id to read the Page from

Returns:

String representing the JSON encoded Page model object

Throws:

ItemNotFoundException - if said page cannot be found

SerializationException - if response from service does not represent a serialized Page

getPageContentById

String getPageContentById(String tcmUri)
                          throws ItemNotFoundException,
                                 ParseException,
                                 SerializationException

Retrieves a Page by its TCMURI. It returns JSON representing a Page model object.

Parameters:

tcmUri - String representing the Tridion Page URI

Returns:

String representing the JSON encoded Page model object

Throws:

ItemNotFoundException - if said page cannot be found

ParseException - if given parameter does not represent a TCMURI

SerializationException - if response from service does not represent a serialized Page

getPageListByPublicationId

String getPageListByPublicationId(int publication)
                                  throws ItemNotFoundException,
                                         SerializationException

Retrieves a list of published page URLs as one String.

Parameters:

publication - the Publication Id

Returns:

A String containing all publication URLs

Throws:

ItemNotFoundException

SerializationException

checkPageExists

boolean checkPageExists(String url,
                      int publicationId)
                        throws ItemNotFoundException,
                               SerializationException

Checks whether a page exists (published from Tridion) by querying its URL

Parameters:

url - String representing the path part of the page URL

publicationId - int representing the context Publication id to read the Page from

Returns:

Boolean True if the page is published and exists

Throws:

ItemNotFoundException - if said page cannot be found

SerializationException - if there was an error communicating with the service

getPageIdForUrl

TCMURI getPageIdForUrl(String url,
                     int publicationId)
                       throws ItemNotFoundException,
                              SerializationException

Throws:

ItemNotFoundException

SerializationException

getLastPublishDate

org.joda.time.DateTime getLastPublishDate(String url,
                                        int publication)
                                          throws ItemNotFoundException

Throws:

ItemNotFoundException