com.foreach.across.modules.webcms.domain.domain.web

Interface WebCmsSiteConfiguration

All Superinterfaces:

WebCmsDomainUrlConfigurer

All Known Implementing Classes:

WebCmsSiteConfigurationImpl

public interface WebCmsSiteConfiguration
extends WebCmsDomainUrlConfigurer

This is the default domain metadata interface for a WebCmsDomain representing a website. This is a common case where the WebCmsModule is used for multi-site management.

Since:

0.0.3

Author:

Arne Vandamme

See Also:

WebCmsMultiDomainConfiguration, WebCmsSiteConfigurationImpl

Method Summary

Modifier and Type	Method and Description
String	getAttribute(String attributeName) Get the value of the attribute identified by attributeName.
<Y> Y	getAttribute(String attributeName, Class<Y> attributeType) Get the value of the attribute identified by attributeName.
<Y> Y	getAttribute(String attributeName, Class<Y> attributeType, Y defaultValue) Get the value of the attribute identified by attributeName.
<Y> Y	getAttribute(String attributeName, org.springframework.core.convert.TypeDescriptor attributeType, Y defaultValue) Get the value of the attribute identified by attributeName.
String	getCookieDomain()
Locale	getDefaultLocale()
WebCmsDomain	getDomain()
String	getDomainKey()
List<String>	getHostNames() List of the hostnames this domain matches.
Locale	getLocaleForHostName(String hostName) Get the configured locale for a particular configured host name.
Map<String,Locale>	getLocales()
String	getName()
int	getSortIndex()
boolean	hasAttribute(String attributeName)

Methods inherited from interface com.foreach.across.modules.webcms.domain.domain.web.WebCmsDomainUrlConfigurer

getUrlPrefix, isAlwaysPrefix

Method Detail

getDomain

WebCmsDomain getDomain()

Returns:

the domain this configuration is attached to

getDomainKey

String getDomainKey()

Returns:

unique key of the domain

getName

String getName()

Returns:

name of the domain

getHostNames

List<String> getHostNames()

List of the hostnames this domain matches. A hostname can contain wildcards (*) and optionally a port. If no port is specified, it will match regardless of port.

Returns:

map of hostnames this domain matches

getCookieDomain

String getCookieDomain()

Returns:

domain cookie should be attached to

getDefaultLocale

Locale getDefaultLocale()

Returns:

optional default locale (if none is specified on the dns)

getLocales

Map<String,Locale> getLocales()

Returns:

map containing default locale per dns matcher

getLocaleForHostName

Locale getLocaleForHostName(String hostName)

Get the configured locale for a particular configured host name. Can return null if no locale is configured and no default locale is set.

Parameters:

hostName - to get the locale for

Returns:

locale or null

getSortIndex

int getSortIndex()

Returns:

sort index of this domain

getAttribute

String getAttribute(String attributeName)

Get the value of the attribute identified by attributeName. Return null if the attribute doesn't exist.

Parameters:

attributeName - the unique attribute key

Returns:

the current value of the attribute, if any

getAttribute

<Y> Y getAttribute(String attributeName,
                   Class<Y> attributeType)

Get the value of the attribute identified by attributeName. The value will be converted to the attributeType specified. Return null if the attribute doesn't exist.

Parameters:

attributeName - the unique attribute key

attributeType - type the attribute should have

Returns:

the current value of the attribute, if any

getAttribute

<Y> Y getAttribute(String attributeName,
                   Class<Y> attributeType,
                   Y defaultValue)

Get the value of the attribute identified by attributeName. The value will be converted to the attributeType specified. Return null if the attribute doesn't exist.

Parameters:

attributeName - the unique attribute key

attributeType - type the attribute should have

defaultValue - if attribute not present

Returns:

the current value of the attribute, if any

getAttribute

<Y> Y getAttribute(String attributeName,
                   org.springframework.core.convert.TypeDescriptor attributeType,
                   Y defaultValue)

Get the value of the attribute identified by attributeName. The value will be converted to the attributeType specified. Return null if the attribute doesn't exist.

This variant uses the TypeDescriptor to define the attribute type, allowing for the use of parametrized types.

Parameters:

attributeName - the unique attribute key

attributeType - type the attribute should have

defaultValue - if attribute not present

Returns:

the current value of the attribute, if any

hasAttribute

boolean hasAttribute(String attributeName)

Parameters:

attributeName - to check for

Returns:

true if the domain has that attribute