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

Class WebCmsMultiDomainAdminUiService

java.lang.Object

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

@Service
public class WebCmsMultiDomainAdminUiService
extends Object

Helper service that retrieves the domains for the current user, taking into account the currently bound context.

Since:

0.0.3

Author:

Arne Vandamme

Constructor Summary

Constructors

Constructor and Description
WebCmsMultiDomainAdminUiService()

Method Summary

Modifier and Type	Method and Description
com.querydsl.core.types.Predicate	applyVisibleDomainsPredicate(com.querydsl.core.types.Predicate predicate, QWebCmsDomain domain) Automatically append the domain binding predicate to an existing QueryDSL predicate.
Collection<WebCmsDomain>	getAccessibleDomains(com.foreach.across.modules.spring.security.actions.AllowableAction... actions) Returns all domains that the current principal can select.
WebCmsDomain	getSelectedDomain() Always returns the current domain, bound to the WebCmsDomainContextHolder.
Collection<WebCmsDomain>	getVisibleDomains() Returns the domains from which entities are currently selectable (visible domains).
com.querydsl.core.types.Predicate	visibleDomainsPredicate(QWebCmsDomain domain) Create a domain binding predicate for a QueryDSL path of a WebCmsDomain property.

Methods inherited from class java.lang.Object

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

Constructor Detail

WebCmsMultiDomainAdminUiService

public WebCmsMultiDomainAdminUiService()

Method Detail

getSelectedDomain

public WebCmsDomain getSelectedDomain()

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

Returns:

domain or null

getVisibleDomains

public Collection<WebCmsDomain> getVisibleDomains()

Returns the domains from which entities are currently selectable (visible domains). Usually this is the current domain, however if the current multi-domain configuration allows no-domain this collection will also contain null.

Returns:

collection of domains - possibly including a null value

getAccessibleDomains

public Collection<WebCmsDomain> getAccessibleDomains(com.foreach.across.modules.spring.security.actions.AllowableAction... actions)

Returns all domains that the current principal can select. Optionally takes one or more AllowableAction parameters that the principal should have for that domain. Note that in case of multiple parameters, it is an OR construct: as soon as the user has any of those actions allowed the domain will be included.

If no AllowableAction is specified, it will default to AllowableAction.READ.

If no-domain is allowed, will check if the user has the permissions to manage the WebCmsDomain type itself.

visibleDomainsPredicate

public com.querydsl.core.types.Predicate visibleDomainsPredicate(QWebCmsDomain domain)

Create a domain binding predicate for a QueryDSL path of a WebCmsDomain property. This will check the multi-domain configuration and create a domain predicate if necessary. This method can return a null value but should be safe to use with QueryDSL expression utils.

Parameters:

domain - expression (property linked to the WebCmsDomain)

Returns:

predicate or null

applyVisibleDomainsPredicate

public com.querydsl.core.types.Predicate applyVisibleDomainsPredicate(com.querydsl.core.types.Predicate predicate,
                                                                      QWebCmsDomain domain)

Automatically append the domain binding predicate to an existing QueryDSL predicate.

Parameters:

predicate - to append the domain predicate to

domain - representing the domain property for the expression object

Returns:

original or appended predicate