Package org.opencms.site

Class CmsAlternativeSiteRootMapping

java.lang.Object

org.opencms.site.CmsAlternativeSiteRootMapping

All Implemented Interfaces:

Serializable

public class CmsAlternativeSiteRootMapping
extends Object
implements Serializable

Describes a mapping rule that selects a different site root based on whether the requested path matches a set of prefixes or not.

The path prefixes must be non-trivial, they can't just be the empty string or '/' - these values will be ignored.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	A_TITLE_SUFFIX	Suffix to append to the title of the site.
static final String	N_ALTERNATIVE_SITE_ROOT_MAPPING	Node name for the alternative site root mapping.
static final String	N_PATH	Node name for mapped paths.

Constructor Summary

Constructors

Constructor	Description
CmsAlternativeSiteRootMapping(String siteRoot, List<String> prefixes, String titleSuffix)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
void	appendXml(org.dom4j.Element parent)	Appends configuration data to the given parent element.
boolean	equals(Object obj)
List<CmsPath>	getPrefixes()	Gets the path prefixes.
CmsPath	getSiteRoot()	Gets the site root as a CmsPath.
String	getTitleSuffix()	Gets the suffix to append to the site title.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

N_ALTERNATIVE_SITE_ROOT_MAPPING

public static final String N_ALTERNATIVE_SITE_ROOT_MAPPING

Node name for the alternative site root mapping.

See Also:

• Constant Field Values

N_PATH

public static final String N_PATH

Node name for mapped paths.

See Also:

• Constant Field Values

A_TITLE_SUFFIX

public static final String A_TITLE_SUFFIX

Suffix to append to the title of the site.

See Also:

• Constant Field Values

Constructor Details

CmsAlternativeSiteRootMapping

public CmsAlternativeSiteRootMapping(String siteRoot,
 List<String> prefixes,
 String titleSuffix)

Creates a new instance.

Parameters:

siteRoot - the site root

prefixes - the prefixes

titleSuffix - the title suffix

Method Details

appendXml

public void appendXml(org.dom4j.Element parent)

Appends configuration data to the given parent element.

Parameters:

parent - the parent element

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

See Also:

• Object.equals(java.lang.Object)

getPrefixes

public List<CmsPath> getPrefixes()

Gets the path prefixes.

Returns:

the path prefixes

getSiteRoot

public CmsPath getSiteRoot()

Gets the site root as a CmsPath.

Returns:

the site root as a CmsPath

getTitleSuffix

public String getTitleSuffix()

Gets the suffix to append to the site title.

Returns:

the suffix to append to the site title

hashCode

public int hashCode()

Overrides:

hashCode in class Object

See Also:

• Object.hashCode()

toString

public String toString()

Overrides:

toString in class Object

See Also:

• Object.toString()