Package com.hybris.backoffice.user

Class DefaultBackofficeRoleService

java.lang.Object

com.hybris.backoffice.user.DefaultBackofficeRoleService

All Implemented Interfaces:

BackofficeRoleService

public class DefaultBackofficeRoleService
extends Object
implements BackofficeRoleService

Default implementation of BackofficeRoleService.

Constructor Summary

Constructors

Constructor	Description
DefaultBackofficeRoleService()

Method Summary

Modifier and Type	Method	Description
Collection<PrincipalGroupModel>	filterOutRolePrincipals(Collection<PrincipalGroupModel> principals)	Filters out the roles from the given collection of principal groups.
Optional<String>	getActiveRole()	Returns an optional id of the active backoffice role or an empty optional if no role is active.
Optional<BackofficeRoleModel>	getActiveRoleModel()	Returns an optional of the active backoffice role or an empty optional if no role is active.
Collection<PrincipalGroupModel>	getActiveRolePrincipalsHierarchy()	Returns user groups hierarchy of the active backoffice role (including the role) or an empty collection if there is no active role.
Collection<PrincipalModel>	getNonRolePrincipalsHierarchy(PrincipalModel principal)	Returns principal's user groups hierarchy with the exclusion of backoffice roles and their hierarchies.
protected SessionService	getSessionService()
protected UserService	getUserService()
boolean	isActiveRole(String roleId)	Tells whether the role with a given id is the current active role.
void	setActiveRole(String roleId)	Sets the active backoffice role in the session.
void	setSessionService(SessionService sessionService)
void	setUserService(UserService userService)
boolean	shouldTreatRolesAsGroups()	Tells whether backoffice roles should be treated like normal user groups (legacy mode).

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultBackofficeRoleService

public DefaultBackofficeRoleService()

Method Details

shouldTreatRolesAsGroups

public boolean shouldTreatRolesAsGroups()

Description copied from interface: BackofficeRoleService

Tells whether backoffice roles should be treated like normal user groups (legacy mode).

Specified by:

shouldTreatRolesAsGroups in interface BackofficeRoleService

Returns:

true if legacy mode should be used and roles should be treated equal to groups

getActiveRoleModel

public Optional<BackofficeRoleModel> getActiveRoleModel()

Description copied from interface: BackofficeRoleService

Returns an optional of the active backoffice role or an empty optional if no role is active.

Specified by:

getActiveRoleModel in interface BackofficeRoleService

Returns:

model of active role

getActiveRole

public Optional<String> getActiveRole()

Description copied from interface: BackofficeRoleService

Returns an optional id of the active backoffice role or an empty optional if no role is active.

Specified by:

getActiveRole in interface BackofficeRoleService

Returns:

GeneratedPrincipal.UID of active role

setActiveRole

public void setActiveRole(String roleId)

Description copied from interface: BackofficeRoleService

Sets the active backoffice role in the session. Passing a null or an empty value will remove the attribute from the session.

Specified by:

setActiveRole in interface BackofficeRoleService

Parameters:

roleId - {@link BackofficeRole@UID} of new active role

isActiveRole

public boolean isActiveRole(String roleId)

Description copied from interface: BackofficeRoleService

Tells whether the role with a given id is the current active role.

Specified by:

isActiveRole in interface BackofficeRoleService

Parameters:

roleId - the role id to check

Returns:

true if the id belongs to the current active role, false otherwise

getActiveRolePrincipalsHierarchy

public Collection<PrincipalGroupModel> getActiveRolePrincipalsHierarchy()

Description copied from interface: BackofficeRoleService

Returns user groups hierarchy of the active backoffice role (including the role) or an empty collection if there is no active role.

Specified by:

getActiveRolePrincipalsHierarchy in interface BackofficeRoleService

Returns:

a collection of all subgroups of active role including this role or empty collection if no active role

getNonRolePrincipalsHierarchy

public Collection<PrincipalModel> getNonRolePrincipalsHierarchy(PrincipalModel principal)

Description copied from interface: BackofficeRoleService

Returns principal's user groups hierarchy with the exclusion of backoffice roles and their hierarchies. The returned collection is never empty, as it contains at least the principal itself.

Specified by:

getNonRolePrincipalsHierarchy in interface BackofficeRoleService

Parameters:

principal - principal from which the hierarchy is taken

Returns:

a collection of active all subgroups that principal belongs to without those that are backoffice roles or comes from them and this principal

filterOutRolePrincipals

public Collection<PrincipalGroupModel> filterOutRolePrincipals(Collection<PrincipalGroupModel> principals)

Description copied from interface: BackofficeRoleService

Filters out the roles from the given collection of principal groups.

Specified by:

filterOutRolePrincipals in interface BackofficeRoleService

Parameters:

principals - the collection to filter

Returns:

a new collection, without the roles

getSessionService

protected SessionService getSessionService()

setSessionService

public void setSessionService(SessionService sessionService)

getUserService

protected UserService getUserService()

setUserService

public void setUserService(UserService userService)