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

Class WebCmsSiteConfigurationImpl

java.lang.Object

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

All Implemented Interfaces:

WebCmsDomainUrlConfigurer, WebCmsSiteConfiguration, WebCmsDomainAware

@Exposed
 @Component
 @Scope(value="prototype")
public class WebCmsSiteConfigurationImpl
extends Object
implements WebCmsSiteConfiguration, WebCmsDomainAware

Default implementation of WebCmsSiteConfiguration. This class is deliberately left open for extension and (partial) modification.

Since:

0.0.3

Author:

Arne Vandamme

Constructor Summary

Constructors

Constructor and Description
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()
String	getUrlPrefix()
boolean	hasAttribute(String attributeName)
boolean	isAlwaysPrefix()
void	setWebCmsDomain(WebCmsDomain domain) Set the domain this metadata belongs to.

Methods inherited from class java.lang.Object

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

Constructor Detail

WebCmsSiteConfigurationImpl

public WebCmsSiteConfigurationImpl()

Method Detail

setWebCmsDomain

public void setWebCmsDomain(WebCmsDomain domain)

Description copied from interface: WebCmsDomainAware

Set the domain this metadata belongs to.

Specified by:

setWebCmsDomain in interface WebCmsDomainAware

Parameters:

domain - instance

getDomain

public WebCmsDomain getDomain()

Specified by:

getDomain in interface WebCmsSiteConfiguration

Returns:

the domain this configuration is attached to

getDomainKey

public String getDomainKey()

Specified by:

getDomainKey in interface WebCmsSiteConfiguration

Returns:

unique key of the domain

getName

public String getName()

Specified by:

getName in interface WebCmsSiteConfiguration

Returns:

name of the domain

getHostNames

public List<String> getHostNames()

Description copied from interface: WebCmsSiteConfiguration

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.

Specified by:

getHostNames in interface WebCmsSiteConfiguration

Returns:

map of hostnames this domain matches

getCookieDomain

public String getCookieDomain()

Specified by:

getCookieDomain in interface WebCmsSiteConfiguration

Returns:

domain cookie should be attached to

getDefaultLocale

public Locale getDefaultLocale()

Specified by:

getDefaultLocale in interface WebCmsSiteConfiguration

Returns:

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

getLocales

public Map<String,Locale> getLocales()

Specified by:

getLocales in interface WebCmsSiteConfiguration

Returns:

map containing default locale per dns matcher

getLocaleForHostName

public Locale getLocaleForHostName(String hostName)

Description copied from interface: WebCmsSiteConfiguration

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

Specified by:

getLocaleForHostName in interface WebCmsSiteConfiguration

Parameters:

hostName - to get the locale for

Returns:

locale or null

getSortIndex

public int getSortIndex()

Specified by:

getSortIndex in interface WebCmsSiteConfiguration

Returns:

sort index of this domain

getAttribute

public final String getAttribute(String attributeName)

Description copied from interface: WebCmsSiteConfiguration

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

Specified by:

getAttribute in interface WebCmsSiteConfiguration

Parameters:

attributeName - the unique attribute key

Returns:

the current value of the attribute, if any

getAttribute

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

Description copied from interface: WebCmsSiteConfiguration

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.

Specified by:

getAttribute in interface WebCmsSiteConfiguration

Parameters:

attributeName - the unique attribute key

attributeType - type the attribute should have

Returns:

the current value of the attribute, if any

getAttribute

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

Description copied from interface: WebCmsSiteConfiguration

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.

Specified by:

getAttribute in interface WebCmsSiteConfiguration

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

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

Description copied from interface: WebCmsSiteConfiguration

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.

Specified by:

getAttribute in interface WebCmsSiteConfiguration

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

public final boolean hasAttribute(String attributeName)

Specified by:

hasAttribute in interface WebCmsSiteConfiguration

Parameters:

attributeName - to check for

Returns:

true if the domain has that attribute

getUrlPrefix

public String getUrlPrefix()

Specified by:

getUrlPrefix in interface WebCmsDomainUrlConfigurer

Returns:

the URI prefix to identify the domain

isAlwaysPrefix

public boolean isAlwaysPrefix()

Specified by:

isAlwaysPrefix in interface WebCmsDomainUrlConfigurer

Returns:

whether or not the url should always be prefixed by the WebCmsDomainUrlConfigurer.getUrlPrefix()