com.tridion.linking

Class Linking

java.lang.Object

com.tridion.services.BaseService

com.tridion.services.ConfigurableBaseService

com.tridion.linking.Linking

All Implemented Interfaces:

com.sdl.web.licensing.events.LicenseEventHandler, BinaryLinkListener, ComponentLinkListener, LinkListener, PageLinkListener, Observer

public class Linking
extends com.tridion.services.ConfigurableBaseService
implements ComponentLinkListener, BinaryLinkListener, PageLinkListener, Observer

This is the main class that is used to start and run the Unified Delivery Platform Linking Service.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	PRODUCT_NAME

Fields inherited from class com.tridion.services.BaseService

CONFIG_LICENSE, DEFAULT_LICENSE_FILE, VERSION_RELEASE, VERSION_RELEASE_BUILD

Method Summary

Modifier and Type	Method and Description
void	binaryLinkNotification(int publicationId, int componentId, String anchor, String text, String attributes, boolean textOnFail, String type, boolean isComponent, Link link) Implement this method to process the parameters passed.
void	componentLinkNotification(int publicationId, int pageId, int componentId, int componentTemplateId, String linkAttr, String linkText, boolean textOnFail, boolean anchor, Link returnLink) Implement this method to process the parameters passed.
void	configure(com.sdl.delivery.configuration.Configuration configuration) Configures the Linking class with a Configuration object.
void	dynamicComponentLinkNotification(int publicationId, int pageId, int componentId, int componentTemplateId, String attributes, String text, boolean textOnFail, String parameters, Link link) Implement this method to process the parameters passed.
protected void	flushInstance() Calls the static synchronized method to set instance to null.
protected String	getConfigFileName() Gets the name of the configuration file.
protected String	getConfigSchemaName() Gets the name of the configuration schema file.
static Linking	getInstance() Standard singleton method to return an instance.
String	getLicenseProductName() Returns the official name of the child Controller class.
protected Map<Integer,Boolean>	getLinkInfoEnabled()
protected org.slf4j.Logger	getLogger() Returns the implementation's logger.
URL	getManifestURL() Returns the location of this Linking's manifest file as a URL.
protected Map<Integer,String>	getPresentationURLs()
String	getProductName() Returns the official Linking product name.
String	getPublicationURL(int publicationId) Returns the fully qualified URL for a particular publication, as configured in the configuration file, or null if the Domain attribute has not been entered.
boolean	isComponentLinkInfoEnabled(int publicationId)
protected com.sdl.delivery.configuration.Configuration	loadConfiguration() Loads the configuration from the configuration file and validates it against the appropriate schema.
void	pageLinkNotification(int publicationId, int pageId, String anchor, String attributes, String text, boolean textOnFail, String parameters, Link link) Implement this method to process the parameters passed.
void	update(Observable observable, Object updatedArg)

Methods inherited from class com.tridion.services.ConfigurableBaseService

getConfigurationLicenseFileName, getServiceConfiguration, setServiceConfiguration

Methods inherited from class com.tridion.services.BaseService

getExpiryDate, getLicenseFileTracker, getLicenseTimeTracker, getVersion, isProductEnabled, logInfo, processLicensing, setExpiryDate, setLicenseFileTracker, setLicenseManager, setLicenseTimeTracker, updateLicenseFile, updateLicenseTime

Methods inherited from class java.lang.Object

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

Field Detail

PRODUCT_NAME

protected static final String PRODUCT_NAME

See Also:

Constant Field Values

Method Detail

getInstance

public static Linking getInstance()

Standard singleton method to return an instance.

Returns:

The one and only instance of this class.

flushInstance

protected void flushInstance()

Calls the static synchronized method to set instance to null.

Specified by:

flushInstance in class com.tridion.services.BaseService

loadConfiguration

protected com.sdl.delivery.configuration.Configuration loadConfiguration()
                                                                  throws com.sdl.delivery.configuration.ConfigurationException

Description copied from class: com.tridion.services.ConfigurableBaseService

Loads the configuration from the configuration file and validates it against the appropriate schema.

Overrides:

loadConfiguration in class com.tridion.services.ConfigurableBaseService

Returns:

The loaded Configuration.

Throws:

com.sdl.delivery.configuration.ConfigurationException - If the configuration could not be loaded. This may be because the configuration file could not be found or the file is not well-formed XML.

getProductName

public String getProductName()

Returns the official Linking product name.

Specified by:

getProductName in class com.tridion.services.BaseService

Returns:

The product name.

getLicenseProductName

public String getLicenseProductName()

Description copied from class: com.tridion.services.BaseService

Returns the official name of the child Controller class. This is used for licensing as well as displaying when logging information about this Controller.

Specified by:

getLicenseProductName in class com.tridion.services.BaseService

Returns:

The product name.

configure

public void configure(com.sdl.delivery.configuration.Configuration configuration)
               throws com.sdl.delivery.configuration.ConfigurationException

Configures the Linking class with a Configuration object.

Specified by:

configure in interface LinkListener

Overrides:

configure in class com.tridion.services.ConfigurableBaseService

Parameters:

configuration - The configuration object that holds configuration information.

Throws:

com.sdl.delivery.configuration.ConfigurationException - If the supplied configuration is invalid or an error occurred during configuration.

getConfigFileName

protected String getConfigFileName()

Gets the name of the configuration file.

Specified by:

getConfigFileName in class com.tridion.services.BaseService

Returns:

The configuration file name.

getConfigSchemaName

protected String getConfigSchemaName()

Gets the name of the configuration schema file.

Specified by:

getConfigSchemaName in class com.tridion.services.BaseService

Returns:

The configuration schema file name.

isComponentLinkInfoEnabled

public boolean isComponentLinkInfoEnabled(int publicationId)

getPublicationURL

public String getPublicationURL(int publicationId)

Returns the fully qualified URL for a particular publication, as configured in the configuration file, or null if the Domain attribute has not been entered.

Parameters:

publicationId - The Id of the publication which the page the link is trying to resolve to is in.

Returns:

The Publication URL, or null if none has been configured.

getManifestURL

public URL getManifestURL()

Returns the location of this Linking's manifest file as a URL.

Specified by:

getManifestURL in class com.tridion.services.BaseService

Returns:

The location of the manifest file.

componentLinkNotification

public void componentLinkNotification(int publicationId,
                                      int pageId,
                                      int componentId,
                                      int componentTemplateId,
                                      String linkAttr,
                                      String linkText,
                                      boolean textOnFail,
                                      boolean anchor,
                                      Link returnLink)

Description copied from interface: ComponentLinkListener

Implement this method to process the parameters passed. Then configure the ComponentLinkListener section in the Linking configuration file to enable the implemented class. The com.tridion.linking.Linking class will pass all ComponentLinks which the system tries to resolve to the configured class, which will then be processed in the configured class.

Specified by:

componentLinkNotification in interface ComponentLinkListener

Parameters:

publicationId - The Id of the publication which the Component the link is trying to resolve to is in.

pageId - The Id of the page that you are linking from.

componentId - The Id of the Component you wish to try to resolve a link to.

componentTemplateId - The Id of the Component Template which will be excluded from link resolution, and which will be used to exclude other templates based on priority.

linkAttr - Attributes to include in the link.

linkText - The text to be displayed for the link.

textOnFail - Indicates if the linkText needs to be returned if no link can be resolved.

anchor - The anchor on the page where the link has to be pointing to.

returnLink - The Link resolved by the ComponentLink class.

dynamicComponentLinkNotification

public void dynamicComponentLinkNotification(int publicationId,
                                             int pageId,
                                             int componentId,
                                             int componentTemplateId,
                                             String attributes,
                                             String text,
                                             boolean textOnFail,
                                             String parameters,
                                             Link link)

Implement this method to process the parameters passed. Then configure the ComponentLinkListener section in the Linking configuration file to enable the implemented class. The com.tridion.linking.Linking class will pass all DynamicComponentLinks which the system tries to resolve to the configured class, which will then be processed in the configured class.

Specified by:

dynamicComponentLinkNotification in interface ComponentLinkListener

Parameters:

publicationId - The Id of the publication which the page the link is trying to resolve to is in.

pageId - The Id of the page the link is trying to resolve to.

componentId - The Id of the Component you wish to try to resolve a link to.

componentTemplateId - The Id of the Component Template to be used for DCP assembly.

attributes - Attributes to include in the link.

text - The text to be displayed for the link.

textOnFail - Indicates if the linkText needs to be returned if no link can be resolved.

parameters - HTTP parameters to be appended to the URL.

link - The Link resolved by the DynamicComponentLink class.

binaryLinkNotification

public void binaryLinkNotification(int publicationId,
                                   int componentId,
                                   String anchor,
                                   String text,
                                   String attributes,
                                   boolean textOnFail,
                                   String type,
                                   boolean isComponent,
                                   Link link)

Description copied from interface: BinaryLinkListener

Implement this method to process the parameters passed. Then configure the BinaryLinkListener section in the Linking configuration file to enable the implemented class. The com.tridion.linking.Linking class will pass all BinaryLinks which the system tries to resolve to the configured class, which will then be processed in the configured class.

Specified by:

binaryLinkNotification in interface BinaryLinkListener

Parameters:

publicationId - The Id of the publication which the Binary the link is trying to resolve to is in.

componentId - The Id of the Binary Component to link to.

anchor - The anchor on the page where the link has to be pointing to. Use an empty String or null for this in normal situations.

text - The text to be displayed for the link.

attributes - Optional query that should be placed in the anchor.

textOnFail - Indicates if the linkText needs to be returned if no link can be resolved.

type - The MIME type of the Binary.

isComponent - Whether this component is a MultiMedia component in the Management System.

link - The Link resolved by the BinaryLink class.

pageLinkNotification

public void pageLinkNotification(int publicationId,
                                 int pageId,
                                 String anchor,
                                 String attributes,
                                 String text,
                                 boolean textOnFail,
                                 String parameters,
                                 Link link)

Description copied from interface: PageLinkListener

Implement this method to process the parameters passed. Then configure the PageLinkListener section in the Linking configuration file to enable the implemented class. The com.tridion.linking.Linking class will pass all PageLinks which the system tries to resolve to the configured class, which will then be processed in the configured class.

Specified by:

pageLinkNotification in interface PageLinkListener

Parameters:

publicationId - The Id of the publication which the page the link is trying to resolve to is in.

pageId - The Id of the page the link is trying to resolve to.

anchor - The anchor on the page where the link has to be pointing to.

attributes - Attributes to include in the link.

text - The text to be displayed for the link.

textOnFail - Indicates if the linkText needs to be returned if no link can be resolved.

parameters - HTTP parameters to be appended to the URL.

link - The Link resolved by the PageLink class.

getPresentationURLs

protected Map<Integer,String> getPresentationURLs()

getLinkInfoEnabled

protected Map<Integer,Boolean> getLinkInfoEnabled()

getLogger

protected org.slf4j.Logger getLogger()

Description copied from class: com.tridion.services.BaseService

Returns the implementation's logger.

Specified by:

getLogger in class com.tridion.services.BaseService

Returns:

the implementation's logger.

update

public void update(Observable observable,
                   Object updatedArg)

Specified by:

update in interface Observer