org.dd4t.providers.impl

Class BrokerComponentPresentationProvider

java.lang.Object

org.dd4t.providers.BaseBrokerProvider

org.dd4t.providers.AbstractComponentPresentationProvider

org.dd4t.providers.impl.BrokerComponentPresentationProvider

All Implemented Interfaces:

ComponentPresentationProvider

public class BrokerComponentPresentationProvider
extends AbstractComponentPresentationProvider
implements ComponentPresentationProvider

Provides access to Dynamic Component Presentations stored in the Content Delivery database. It uses CD API to retrieve raw DCP content from the database. Access to these objects is not cached, and as such must be cached externally.

Field Summary

Fields inherited from class org.dd4t.providers.AbstractComponentPresentationProvider

ERROR_MESSAGE

Fields inherited from class org.dd4t.providers.BaseBrokerProvider

cacheProvider, contentIsBase64Encoded, contentIsCompressed

Constructor Summary

Constructors

Constructor and Description
BrokerComponentPresentationProvider()

Method Summary

Methods

Modifier and Type	Method and Description
protected com.tridion.dcp.ComponentPresentation	getComponentPresentation(int componentId, int templateId, int publicationId)
String	getDynamicComponentPresentation(int componentId, int publicationId) Retrieves content of a Dynamic Component Presentation by looking up its componentId and publicationId.
String	getDynamicComponentPresentation(int componentId, int templateId, int publicationId) Retrieves content of a Dynamic Component Presentation by looking up its componentId, templateId and publicationId.
ComponentPresentationResultItem<String>	getDynamicComponentPresentationItem(int componentId, int publicationId)
ComponentPresentationResultItem<String>	getDynamicComponentPresentationItem(int componentId, int templateId, int publicationId)

Methods inherited from class org.dd4t.providers.AbstractComponentPresentationProvider

assertQueryResultNotNull, getDynamicComponentPresentations

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

Methods inherited from interface org.dd4t.providers.ComponentPresentationProvider

getDynamicComponentPresentations

Constructor Detail

BrokerComponentPresentationProvider

public BrokerComponentPresentationProvider()

Method Detail

getDynamicComponentPresentation

public String getDynamicComponentPresentation(int componentId,
                                     int publicationId)
                                       throws org.dd4t.core.exceptions.ItemNotFoundException,
                                              org.dd4t.core.exceptions.SerializationException

Retrieves content of a Dynamic Component Presentation by looking up its componentId and publicationId. A templateId is not provided, so the DCP with the highest linking priority is retrieved.

Note: This method performs significantly slower than getDynamicComponentPresentation(int, int, int)! Do provide a templateId!

Specified by:

getDynamicComponentPresentation in interface ComponentPresentationProvider

Parameters:

componentId - int representing the Component item id

publicationId - int representing the Publication id of the DCP

Returns:

String representing the content of the DCP

Throws:

org.dd4t.core.exceptions.ItemNotFoundException - if the requested DCP cannot be found

org.dd4t.core.exceptions.SerializationException

getDynamicComponentPresentation

public String getDynamicComponentPresentation(int componentId,
                                     int templateId,
                                     int publicationId)
                                       throws org.dd4t.core.exceptions.ItemNotFoundException,
                                              org.dd4t.core.exceptions.SerializationException

Retrieves content of a Dynamic Component Presentation by looking up its componentId, templateId and publicationId.

Specified by:

getDynamicComponentPresentation in interface ComponentPresentationProvider

Specified by:

getDynamicComponentPresentation in class AbstractComponentPresentationProvider

Parameters:

componentId - int representing the Component item id

templateId - int representing the Component Template item id

publicationId - int representing the Publication id of the DCP

Returns:

String representing the content of the DCP

Throws:

org.dd4t.core.exceptions.ItemNotFoundException - if the requested DCP cannot be found

org.dd4t.core.exceptions.SerializationException

getDynamicComponentPresentationItem

public ComponentPresentationResultItem<String> getDynamicComponentPresentationItem(int componentId,
                                                                          int publicationId)
                                                                            throws org.dd4t.core.exceptions.ItemNotFoundException,
                                                                                   org.dd4t.core.exceptions.SerializationException

Specified by:

getDynamicComponentPresentationItem in interface ComponentPresentationProvider

Throws:

org.dd4t.core.exceptions.ItemNotFoundException

org.dd4t.core.exceptions.SerializationException

getDynamicComponentPresentationItem

public ComponentPresentationResultItem<String> getDynamicComponentPresentationItem(int componentId,
                                                                          int templateId,
                                                                          int publicationId)
                                                                            throws org.dd4t.core.exceptions.ItemNotFoundException,
                                                                                   org.dd4t.core.exceptions.SerializationException

Specified by:

getDynamicComponentPresentationItem in interface ComponentPresentationProvider

Throws:

org.dd4t.core.exceptions.ItemNotFoundException

org.dd4t.core.exceptions.SerializationException

getComponentPresentation

protected com.tridion.dcp.ComponentPresentation getComponentPresentation(int componentId,
                                                             int templateId,
                                                             int publicationId)
                                                                  throws org.dd4t.core.exceptions.ItemNotFoundException

Throws:

org.dd4t.core.exceptions.ItemNotFoundException