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

Class WebCmsMultiDomainConfiguration

java.lang.Object

com.foreach.across.modules.webcms.domain.domain.config.WebCmsMultiDomainConfiguration

public class WebCmsMultiDomainConfiguration
extends Object

Configuration bean for easy set-up of multi-domain configurations. An application has single multi-domain configuration.

The WebCmsMultiDomainConfiguration strongly determines the behaviour of the WebCmsModule regarding its objects. It will automatically configure the administration UI as well as apply the multi-domain rules during saving of objects (including during imports).

A configuration can only be created using the WebCmsMultiDomainConfiguration.WebCmsMultiDomainConfigurationBuilder and not be modified afterwards. See the factory methods for default configurations:

• disabled()
• managementPerDomain()
• managementPerEntity()

Since:

0.0.3

Author:

Arne Vandamme

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WebCmsMultiDomainConfiguration.WebCmsMultiDomainConfigurationBuilder

Constructor Summary

Constructors

Constructor and Description
WebCmsMultiDomainConfiguration()

Method Summary

Modifier and Type	Method and Description
static WebCmsMultiDomainConfiguration.WebCmsMultiDomainConfigurationBuilder	disabled()
Class<? extends AbstractWebCmsDomainContextFilter>	getDomainContextFilterClass()
boolean	isDomainBound(@NonNull Class<?> entityType) Check if a type is domain bound.
boolean	isNoDomainAllowed(@NonNull Class<?> entityType) Check if a domain bound type has the actual domain demarcated as optional.
static WebCmsMultiDomainConfiguration.WebCmsMultiDomainConfigurationBuilder	managementPerDomain() Create a multi-domain configuration where any WebCmsDomainBound object is domain bound by default, with the exception of any WebCmsTypeSpecifier.
static WebCmsMultiDomainConfiguration.WebCmsMultiDomainConfigurationBuilder	managementPerEntity() Create a multi-domain configuration where any WebCmsDomainBound object is domain bound by default, with the exception of any WebCmsTypeSpecifier.

Methods inherited from class java.lang.Object

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

Constructor Detail

WebCmsMultiDomainConfiguration

public WebCmsMultiDomainConfiguration()

Method Detail

disabled

public static WebCmsMultiDomainConfiguration.WebCmsMultiDomainConfigurationBuilder disabled()

Returns:

a configuration for domain-less management (default)

managementPerDomain

public static WebCmsMultiDomainConfiguration.WebCmsMultiDomainConfigurationBuilder managementPerDomain()

Create a multi-domain configuration where any WebCmsDomainBound object is domain bound by default, with the exception of any WebCmsTypeSpecifier.

Domain is determined on a global level, entities are managed within the context of a single domain.

Returns:

multi-domain configuration

managementPerEntity

public static WebCmsMultiDomainConfiguration.WebCmsMultiDomainConfigurationBuilder managementPerEntity()

Create a multi-domain configuration where any WebCmsDomainBound object is domain bound by default, with the exception of any WebCmsTypeSpecifier.

Domain is determined on the individual entity level.

Returns:

multi-domain configuration

getDomainContextFilterClass

public Class<? extends AbstractWebCmsDomainContextFilter> getDomainContextFilterClass()

Returns:

the domain context filter class that should be instantiated

isDomainBound

public boolean isDomainBound(@NonNull
                             @NonNull Class<?> entityType)

Check if a type is domain bound. This requires multi-domain to be activated for that type or one of its parent types, and the class not to have been added to the domain ignored list using domainIgnoredTypes.

If multi-domain configuration is disabled, this will return false for any type.

Parameters:

entityType - to check if domain bound

Returns:

true if domain bound

isNoDomainAllowed

public boolean isNoDomainAllowed(@NonNull
                                 @NonNull Class<?> entityType)

Check if a domain bound type has the actual domain demarcated as optional. This allows a "no-domain" to be attached to the type.

This call will always return true if multi-domain configuration is disabled, or if a non-domain bound object is checked.

Parameters:

entityType - to check for no-domain allowed

Returns:

true is domain bound and no domain is allowed