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

Interface WebCmsMultiDomainService

All Superinterfaces:

WebCmsDomainService

public interface WebCmsMultiDomainService
extends WebCmsDomainService

Central API for working with a multi-domain context.

Since:

0.0.3

Author:

Arne Vandamme

See Also:

WebCmsMultiDomainConfiguration

Method Summary

Modifier and Type	Method and Description
CloseableWebCmsDomainContext	attachDomainContext(WebCmsDomain domain) Create a new WebCmsDomainContext for the given domain, and attach it to the WebCmsDomainContextHolder.
WebCmsDomain	getCurrentDomain() Always returns the current domain, bound to the WebCmsDomainContextHolder.
WebCmsDomain	getCurrentDomainForEntity(Object entity) Returns the current domain for a particular entity.
WebCmsDomain	getCurrentDomainForType(Class<?> entityType) Returns the current domain for a particular entity type.
<U> U	getCurrentDomainMetadata(Class<U> metadataType) Return the metadata for the current domain.
<U> U	getMetadataForDomain(WebCmsDomain domain, Class<U> metadataType) Retrieve the metadata for a specific domain.
boolean	isCurrentDomain(WebCmsDomain domain) Test if a specific domain is the current domain bound tot the thread.
boolean	isDomainBound(Class<?> entityType) Check if a particular entity type is domain-bound according to the current WebCmsMultiDomainConfiguration.
boolean	isDomainBound(Object entity) Check if a particular entity is domain-bound according to the current WebCmsMultiDomainConfiguration.
boolean	isNoDomainAllowed(Class<?> entityType) Check if a particular entity type does not require a specific domain.
boolean	isNoDomainAllowed(Object entity) Check if a particular entity does not require a specific domain.

Methods inherited from interface com.foreach.across.modules.webcms.domain.domain.WebCmsDomainService

getDomain, getDomainByKey

Method Detail

getCurrentDomain

WebCmsDomain getCurrentDomain()

Always returns the current domain, bound to the WebCmsDomainContextHolder. This method will return a single domain only or none.

Returns:

domain or null

getCurrentDomainMetadata

<U> U getCurrentDomainMetadata(Class<U> metadataType)

Return the metadata for the current domain. Can be null if not metadata is available. A ClassCastException will be thrown if the metadata is not of the right type.

Type Parameters:

U - metadata type reference

Parameters:

metadataType - the metadata should have

Returns:

metadata or null if none available

getCurrentDomainForEntity

WebCmsDomain getCurrentDomainForEntity(Object entity)

Returns the current domain for a particular entity. This is basically the same as getCurrentDomain() if the call of isDomainBound(Object) returns true.

If the entity type is not domain-bound, this will always return null.

Parameters:

entity - for which to retrieve the current domain

Returns:

domain or null

getCurrentDomainForType

WebCmsDomain getCurrentDomainForType(Class<?> entityType)

Returns the current domain for a particular entity type. This is basically the same as getCurrentDomain() if the call of isDomainBound(Class) returns true.

If the entity type is not domain-bound, this will always return null.

Parameters:

entityType - for which to retrieve the current domain

Returns:

domain or null

getMetadataForDomain

<U> U getMetadataForDomain(WebCmsDomain domain,
                           Class<U> metadataType)

Retrieve the metadata for a specific domain. Coerce it to the given type. A ClassCastException will be thrown if the metadata is not of the right type.

Specified by:

getMetadataForDomain in interface WebCmsDomainService

Parameters:

domain - or null for the no-domain

metadataType - type the metadata should have

Returns:

metadata or null if none available

isDomainBound

boolean isDomainBound(Object entity)

Check if a particular entity is domain-bound according to the current WebCmsMultiDomainConfiguration.

Parameters:

entity - to check

Returns:

true if domain-bound

isDomainBound

boolean isDomainBound(Class<?> entityType)

Check if a particular entity type is domain-bound according to the current WebCmsMultiDomainConfiguration.

Parameters:

entityType - to check

Returns:

true if domain-bound

isNoDomainAllowed

boolean isNoDomainAllowed(Object entity)

Check if a particular entity does not require a specific domain. This will be true for either non-domain bound entities, of for domain-bound entities that also allow no-domain.

Parameters:

entity - to check

Returns:

true if no-domain is allowed

isNoDomainAllowed

boolean isNoDomainAllowed(Class<?> entityType)

Check if a particular entity type does not require a specific domain. This will be true for either non-domain bound entities, of for domain-bound entities that also allow no-domain.

Parameters:

entityType - to check

Returns:

true if no-domain is allowed

attachDomainContext

CloseableWebCmsDomainContext attachDomainContext(WebCmsDomain domain)

Create a new WebCmsDomainContext for the given domain, and attach it to the WebCmsDomainContextHolder. This will load the metadata, create the context and effectively change the value of getCurrentDomain().

This method returns an AutoCloseable referring the previous domain context. When calling the CloseableWebCmsDomainContext.close(), the previous domain context will be reset.

Parameters:

domain - to set

Returns:

closeable

isCurrentDomain

boolean isCurrentDomain(WebCmsDomain domain)

Test if a specific domain is the current domain bound tot the thread.

Parameters:

domain - to test

Returns:

true if the domain is indeed the current domain