Package org.opencms.ade.detailpage

Class CmsPermissiveDetailPageHandler

java.lang.Object

org.opencms.ade.detailpage.CmsPermissiveDetailPageHandler

All Implemented Interfaces:

I_CmsDetailPageHandler, I_CmsConfigurationParameterHandler

public class CmsPermissiveDetailPageHandler
extends Object
implements I_CmsDetailPageHandler

Original detail page handler implementing the detail page logic from OpenCms versions up to 11.0.

Disregards the 'exclude external detail contents' option, allows all combinations of detail page / detail content on the same site.

Field Summary

Fields inherited from interface org.opencms.configuration.I_CmsConfigurationParameterHandler

ADD_PARAMETER_METHOD, INIT_CONFIGURATION_METHOD

Constructor Summary

Constructors

Constructor	Description
CmsPermissiveDetailPageHandler()

Method Summary

Modifier and Type	Method	Description
void	addConfigurationParameter(String paramName, String paramValue)	Adds a configuration parameter to this parameter configurable class instance.
Collection<String>	getAllDetailPages(CmsObject cms, int resType)	Finds all detail pages for a given resource.
CmsParameterConfiguration	getConfiguration()	Returns the parameters of this configurable class instance, or null if the class does not need any parameters.
static String	getDetailPage(CmsADEManager manager, CmsObject cms, String pageRootPath, String originPath, String targetDetailPage)	Gets the detail page for a content element.
String	getDetailPage(CmsObject cms, String rootPath, String linkSource, String targetDetailPage)	Returns the detail page link for the given resource, or null if there is no detail page for the resource.
void	initConfiguration()	Initializes a configuration after all parameters have been added.
void	initialize(CmsObject offlineCms, CmsObject onlineCms)	Initializes the detail page handler.
boolean	isValidDetailPage(CmsObject cms, CmsResource page, CmsResource detailRes)	Checks whether the given detail page is valid for the given resource.

Methods inherited from class java.lang.Object

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

Constructor Details

CmsPermissiveDetailPageHandler

public CmsPermissiveDetailPageHandler()

Method Details

getDetailPage

public static String getDetailPage(CmsADEManager manager,
 CmsObject cms,
 String pageRootPath,
 String originPath,
 String targetDetailPage)

Gets the detail page for a content element.

Parameters:

manager - the ADE manager instance.

cms - the CMS context

pageRootPath - the element's root path

originPath - the path in which the the detail page is being requested

targetDetailPage - the target detail page to use

Returns:

the detail page for the content element

addConfigurationParameter

public void addConfigurationParameter(String paramName,
 String paramValue)

Description copied from interface: I_CmsConfigurationParameterHandler

Adds a configuration parameter to this parameter configurable class instance.

Specified by:

addConfigurationParameter in interface I_CmsConfigurationParameterHandler

Parameters:

paramName - the name of the parameter

paramValue - the value for the parameter

See Also:

• I_CmsConfigurationParameterHandler.addConfigurationParameter(java.lang.String, java.lang.String)

getAllDetailPages

public Collection<String> getAllDetailPages(CmsObject cms,
 int resType)
                                     throws CmsException

Description copied from interface: I_CmsDetailPageHandler

Finds all detail pages for a given resource.

Specified by:

getAllDetailPages in interface I_CmsDetailPageHandler

Parameters:

cms - the current CMS context

resType - the resource type for which the detail pages should be found

Returns:

the list of detail page

Throws:

CmsException - in case reading the resource type fails

See Also:

• I_CmsDetailPageHandler.getAllDetailPages(org.opencms.file.CmsObject, int)

getConfiguration

public CmsParameterConfiguration getConfiguration()

Description copied from interface: I_CmsConfigurationParameterHandler

Returns the parameters of this configurable class instance, or null if the class does not need any parameters.

Specified by:

getConfiguration in interface I_CmsConfigurationParameterHandler

Returns:

the parameters of this configurable class instance, or null if the class does not need any parameters

See Also:

• I_CmsConfigurationParameterHandler.getConfiguration()

getDetailPage

public String getDetailPage(CmsObject cms,
 String rootPath,
 String linkSource,
 String targetDetailPage)

Description copied from interface: I_CmsDetailPageHandler

Returns the detail page link for the given resource, or null if there is no detail page for the resource.

Specified by:

getDetailPage in interface I_CmsDetailPageHandler

Parameters:

cms - the CMS context

rootPath - the root path of the resource for which the detail page should be looked up

linkSource - the uri in the context of which the detail page link is being generated (relative to the site)

targetDetailPage - the target detail page to use

Returns:

the detail page link, or null

See Also:

• I_CmsDetailPageHandler.getDetailPage(org.opencms.file.CmsObject, java.lang.String, java.lang.String, java.lang.String)

initConfiguration

public void initConfiguration()

Description copied from interface: I_CmsConfigurationParameterHandler

Initializes a configuration after all parameters have been added.

Specified by:

initConfiguration in interface I_CmsConfigurationParameterHandler

See Also:

• I_CmsConfigurationParameterHandler.initConfiguration()

initialize

public void initialize(CmsObject offlineCms,
 CmsObject onlineCms)

Description copied from interface: I_CmsDetailPageHandler

Initializes the detail page handler.

Specified by:

initialize in interface I_CmsDetailPageHandler

Parameters:

offlineCms - offline CMS context

onlineCms - online CMS context

See Also:

• I_CmsDetailPageHandler.initialize(org.opencms.file.CmsObject, org.opencms.file.CmsObject)

isValidDetailPage

public boolean isValidDetailPage(CmsObject cms,
 CmsResource page,
 CmsResource detailRes)

Checks whether the given detail page is valid for the given resource.

Specified by:

isValidDetailPage in interface I_CmsDetailPageHandler

Parameters:

cms - the CMS context

page - the detail page

detailRes - the detail resource

Returns:

true if the given detail page is valid