org.dd4t.providers.impl

Class BrokerLinkProvider

java.lang.Object

org.dd4t.providers.BaseBrokerProvider

org.dd4t.providers.impl.BrokerLinkProvider

All Implemented Interfaces:

LinkProvider

public class BrokerLinkProvider
extends BaseBrokerProvider
implements LinkProvider

Provider implementation to wrap around the ComponentLinker. TODO: Dynamic Component Links! Nice! TODO: Build link caching

Author:

rooudsho, Mihai Cadariu, rai

Field Summary

Fields inherited from class org.dd4t.providers.BaseBrokerProvider

cacheProvider, contentIsBase64Encoded, contentIsCompressed

Constructor Summary

Constructors

Constructor and Description
BrokerLinkProvider()

Method Summary

Methods

Modifier and Type	Method and Description
String	resolveComponent(String targetComponentURI) Returns a link URL to the given Component TcmUri, if exists.
String	resolveComponent(String targetComponentUri, String excludeComponentTemplateUri)
String	resolveComponentFromPage(String targetComponentURI, String sourcePageURI) Returns a link URL to the given Component TcmUri, when also specifying the source Page TcmUri.

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

BrokerLinkProvider

public BrokerLinkProvider()

Method Detail

resolveComponent

public String resolveComponent(String targetComponentURI)

Returns a link URL to the given Component TcmUri, if exists. Otherwise, returns null.

Specified by:

resolveComponent in interface LinkProvider

Parameters:

targetComponentURI - String representing the TcmUri of the Component to resolve a link to

Returns:

String representing the URL of the link; or null, if the Component is not linked to

resolveComponentFromPage

public String resolveComponentFromPage(String targetComponentURI,
                              String sourcePageURI)

Returns a link URL to the given Component TcmUri, when also specifying the source Page TcmUri.

Specified by:

resolveComponentFromPage in interface LinkProvider

Parameters:

targetComponentURI - String representing the TcmUri of the Component to resolve a link to

sourcePageURI - String representing the TcmUri of the source Page (the current page)

Returns:

String representing the URL of the link; or null, if the Component is not linked to

resolveComponent

public String resolveComponent(String targetComponentUri,
                      String excludeComponentTemplateUri)
                        throws org.dd4t.core.exceptions.ItemNotFoundException,
                               org.dd4t.core.exceptions.SerializationException

Specified by:

resolveComponent in interface LinkProvider

Parameters:

targetComponentUri - String representing the TcmUri of the Component to resolve a link to

excludeComponentTemplateUri - The Component Presentation to exclude

Returns:

String representing the URL of the link; or null, if the Component is not linked to

Throws:

org.dd4t.core.exceptions.ItemNotFoundException

org.dd4t.core.exceptions.SerializationException