Package de.hybris.platform.jalo.security

Class PrincipalGroup

java.lang.Object

de.hybris.platform.util.BridgeAbstraction

de.hybris.platform.jalo.Item

de.hybris.platform.jalo.ExtensibleItem

de.hybris.platform.jalo.c2l.LocalizableItem

de.hybris.platform.jalo.GenericItem

de.hybris.platform.jalo.security.GeneratedPrincipal

de.hybris.platform.jalo.security.Principal

de.hybris.platform.jalo.security.GeneratedPrincipalGroup

de.hybris.platform.jalo.security.PrincipalGroup

All Implemented Interfaces:

Serializable, Comparable

Direct Known Subclasses:

GeneratedUserGroup

public abstract class PrincipalGroup
extends GeneratedPrincipalGroup

This class describes groups of principals.

Like principals such a group can have permissions assigned. Each member of a principal group automaticaly owns all group rights as well.
If you like to avoid this for one right and one member you have to assign this right to this member negatively !

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class de.hybris.platform.jalo.GenericItem

GenericItem.GenericItemImpl

Nested classes/interfaces inherited from class de.hybris.platform.jalo.c2l.LocalizableItem

LocalizableItem.LocalizableItemImpl

Nested classes/interfaces inherited from class de.hybris.platform.jalo.ExtensibleItem

ExtensibleItem.ExtensibleItemImpl

Nested classes/interfaces inherited from class de.hybris.platform.jalo.Item

Item.AttributeFilter, Item.AttributeMode, Item.CachedGetter, Item.CachedSetter, Item.ItemAttributeMap, Item.ItemConstraint, Item.ItemImpl, Item.JaloCachedComputationException

Field Summary

Fields inherited from class de.hybris.platform.jalo.security.GeneratedPrincipalGroup

DEFAULT_INITIAL_ATTRIBUTES, LOCNAME, MAXBRUTEFORCELOGINATTEMPTS, MEMBERS, PRINCIPALGROUPRELATION_MARKMODIFIED, PRINCIPALGROUPRELATION_SRC_ORDERED, PRINCIPALGROUPRELATION_TGT_ORDERED

Fields inherited from class de.hybris.platform.jalo.security.Principal

ALLGROUPS, ALLSEARCHRESTRICTIONS, DISPLAYNAME, PRINCIPAL_GROUP_RELATION_NAME

Fields inherited from class de.hybris.platform.jalo.security.GeneratedPrincipal

DESCRIPTION, GROUPS, NAME, SEARCHRESTRICTIONS, SEARCHRESTRICTIONSHANDLER, UID

Fields inherited from class de.hybris.platform.jalo.c2l.LocalizableItem

LANGUAGE_FALLBACK_ENABLED

Fields inherited from class de.hybris.platform.jalo.Item

_CREATION_TIME_INTERNAL, _MODIFIED_TIME_INTERNAL, accessorLog, CREATION_TIME, DISABLE_ATTRIBUTE_CHECK, DISABLE_ITEMCHECK_BEFORE_REMOVABLE, EVEN, FEATURE_ACCESSMAP_QUALIFIER, HJMPTS, INITIAL_CREATION_FLAG, isJaloOnly, MODIFIED_TIME, NEGATIVE, NOT_FOUND, OWNER, PK, POSITIVE, SAVE_FROM_SERVICE_LAYER, staticTransientObjects, TYPE

Fields inherited from class de.hybris.platform.util.BridgeAbstraction

impl, tenant

Constructor Summary

Constructors

Constructor	Description
PrincipalGroup()

Method Summary

Modifier and Type	Method	Description
boolean	addMember(Principal p)	Deprecated. since ages - useGeneratedPrincipalGroup.addToMembers(Principal) instead
boolean	addMember(SessionContext ctx, Principal p)	Deprecated. since ages - useGeneratedPrincipalGroup.addToMembers(SessionContext, Principal) instead
boolean	addToGroup(PrincipalGroup group)	Deprecated. since ages - useaddToGroups(SessionContext, PrincipalGroup) instead
void	addToGroups(SessionContext ctx, PrincipalGroup group)	Generated method - Adds value to groups.
boolean	containsMember(Principal p)	Deprecated. since ages - useUserService.isMemberOfGroup(UserModel, UserGroupModel, boolean)
boolean	containsMember(SessionContext ctx, Principal p)	Deprecated. since ages - useUserService.isMemberOfGroup(UserModel, UserGroupModel, boolean)
Map<Language,String>	getAllDisplayName(SessionContext ctx)	Deprecated. since ages
Map	getAllLocNames(SessionContext ctx)	Deprecated. since ages - usegetAllLocNames(SessionContext) instead
String	getDisplayName(SessionContext ctx)	Deprecated. since ages
Set<Principal>	getMembers(SessionContext ctx)	The group members.
boolean	removeMember(Principal p)	Deprecated. since ages - useGeneratedPrincipalGroup.removeFromMembers(Principal) instead
boolean	removeMember(SessionContext ctx, Principal p)	Deprecated. since ages - useGeneratedPrincipalGroup.removeFromMembers(SessionContext, Principal) instead
void	setAllLocNames(SessionContext ctx, Map names)	Deprecated. since ages - usesetAllLocNames(SessionContext, Map) instead
void	setGroups(SessionContext ctx, Set groups)	Changes the group memberships of this group.
protected void	setMembers(SessionContext ctx, Collection newMembers)	Deprecated. since ages - usesetMembers(SessionContext, Set) instead

Methods inherited from class de.hybris.platform.jalo.security.GeneratedPrincipalGroup

addToMembers, addToMembers, getAllLocName, getAllLocName, getDefaultAttributeModes, getLocName, getLocName, getMaxBruteForceLoginAttempts, getMaxBruteForceLoginAttempts, getMaxBruteForceLoginAttemptsAsPrimitive, getMaxBruteForceLoginAttemptsAsPrimitive, getMembers, getMembersCount, getMembersCount, isMarkModifiedDisabled, removeFromMembers, removeFromMembers, setAllLocName, setAllLocName, setLocName, setLocName, setMaxBruteForceLoginAttempts, setMaxBruteForceLoginAttempts, setMaxBruteForceLoginAttempts, setMaxBruteForceLoginAttempts, setMembers, setMembers

Methods inherited from class de.hybris.platform.jalo.security.Principal

addGlobalNegativePermission, addGlobalPermission, addGlobalPermissions, addGlobalPositivePermission, checkConsistencyUid, checkGlobalPermission, checkOwnGlobalPermission, checkSystemPrincipal, clearGlobalPermission, clearGlobalPermissions, getAllDisplayName, getAllGlobalNegativePermissions, getAllGlobalPositivePermissions, getAllGroups, getAllGroups, getAllSearchRestrictions, getAllSearchRestrictions, getDisplayName, getGlobalNegativePermissions, getGlobalPermissions, getGlobalPositivePermissions, getGroups, getItemPermissionsMap, getUid, getUID, isAdmin, isMemberOf, isMemberOf, remove, removeFromGroup, setItemPermissionsByMap, setUID, toString

Methods inherited from class de.hybris.platform.jalo.security.GeneratedPrincipal

addToGroups, getDescription, getDescription, getGroups, getGroupsCount, getGroupsCount, getName, getName, getSearchRestrictions, getSearchRestrictions, getUid, removeFromGroups, removeFromGroups, setDescription, setDescription, setGroups, setName, setName, setUid, setUid

Methods inherited from class de.hybris.platform.jalo.GenericItem

createItem, getImplementation, getInitialProperties, getNonInitialAttributes, getRelatedItems, getRelatedItems, setRelatedItems

Methods inherited from class de.hybris.platform.jalo.c2l.LocalizableItem

getAllLocalizedProperties, getAllLocalizedProperties, getAllLocalizedProperties, getAllLocalizedProperties, getAllValuesSessionContext, getLocalizedProperty, getLocalizedProperty, getLocalizedPropertyInternal, getLocalizedPropertyNames, getLocalizedPropertyNames, hasLanguage, isEmptyValue, isFallbackEnabled, removeLocalizedProperty, removeLocalizedProperty, setAllLocalizedProperties, setAllLocalizedProperties, setLocalizedProperty, setLocalizedProperty

Methods inherited from class de.hybris.platform.jalo.ExtensibleItem

createNonClassAccessor, getAllProperties, getAllProperties, getProperty, getProperty, getPropertyNames, getPropertyNames, removeProperty, removeProperty, setAllProperties, setAllProperties, setProperty, setProperty

Methods inherited from class de.hybris.platform.jalo.Item

addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addNegativePermission, addPermission, addPositivePermission, assureExtensionsLoaded, changeTypeAfterCreation, checkConstraint, checkItemPermission, checkMandatoryAttribute, checkMandatoryAttribute, checkPermission, checkPermission, checkRemovable, clearPermission, compareTo, ctx, doAfterRemove, doBeforeRemove, equals, getAccessorFor, getAllAttributes, getAllAttributes, getAllAttributes, getAllAttributes, getAllAttributesInternal, getAllLinkedItems, getAndCheckCacheBoundItem, getAttribute, getAttribute, getCacheBoundItem, getComposedType, getComposedTypePK, getCreationTime, getCurrentlyRemovingCount, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItemsCount, getLinkedItemsCount, getLinkedItemsCount, getModificationTime, getNegativePermissions, getOwner, getPartOfRemovedSessionMarker, getPermissionMap, getPermissions, getPersistenceVersion, getPK, getPositivePermissions, getRestrictedPrincipals, getSession, getSyncObject, getTenant, getTransientObject, getTransientObjectMap, hashCode, hasRegisteredClassAccessorFor, internal_registerClassAccessorFor, internal_registerNonClassAccessorFor, invalidateLocalCaches, isAlive, isCacheBound, isCurrentlyRemoving, isCurrentlyRemoving, isEmptyRelationValue, isInCreate, isInstanceOf, isItemCheckBeforeRemoveableDisabled, isRelationLocalizationFallbackEnabled, newInstance, notifyExtensionsAfterItemCreation, notifyExtensionsBeforeItemCreation, notifyItemRemoval, notifyManagerAboutItemRemoval, readResolve, registerAccessFor, registerAccessFor, registerJaloInvalidationListeners, remove, removeItemCollection, removeItemCollection, removeLinkedItems, removeLinkedItems, removeLinkedItems, removeLinkedItems, removeLinks, removePartOfItems, removePartOfItems, setAllAttributes, setAllAttributes, setAllAttributesInternal, setAllLinkedItems, setAllLinkedItems, setAllLinkedItems, setAllLinkedItems, setAttribute, setAttribute, setAttributeFromString, setAttributeFromString, setCacheBound, setComposedType, setCreationTime, setImplementation, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setModificationTime, setNonInitialAttributes, setOwner, setPermissionsByMap, setTransientObject, setUseTA, suppressRelation, useTA, writeReplace

Methods inherited from class de.hybris.platform.util.BridgeAbstraction

setTenant

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

PrincipalGroup

public PrincipalGroup()

Method Details

setMembers

@Deprecated(since="ages",
            forRemoval=false)
protected void setMembers(SessionContext ctx,
 Collection newMembers)
                   throws ConsistencyCheckException

Deprecated.

since ages - usesetMembers(SessionContext, Set) instead

Throws:

ConsistencyCheckException

getMembers

public Set<Principal> getMembers(SessionContext ctx)

The group members.

Overrides:

getMembers in class GeneratedPrincipalGroup

Parameters:

ctx - can be used for cached access of this set

Returns:

the members

addMember

@Deprecated(since="ages",
            forRemoval=false)
public boolean addMember(Principal p)

Deprecated.

since ages - useGeneratedPrincipalGroup.addToMembers(Principal) instead

Adds a new member.

Parameters:

p -

Returns:

true if this principal was not present before

addMember

@Deprecated(since="ages",
            forRemoval=false)
public boolean addMember(SessionContext ctx,
 Principal p)

Deprecated.

since ages - useGeneratedPrincipalGroup.addToMembers(SessionContext, Principal) instead

Adds a new member.

Parameters:

ctx - can be used for cached access of the member set

p -

Returns:

true if this principal was not present before

addToGroups

public void addToGroups(SessionContext ctx,
 PrincipalGroup group)

Description copied from class: GeneratedPrincipal

Generated method - Adds value to groups.

Overrides:

addToGroups in class GeneratedPrincipal

group - the item to add to groups

addToGroup

@Deprecated(since="ages",
            forRemoval=false)
public boolean addToGroup(PrincipalGroup group)

Deprecated.

since ages - useaddToGroups(SessionContext, PrincipalGroup) instead

Adds this group to a super group. This method checks cyclic dependencies to avoid self containing groups.

Overrides:

addToGroup in class Principal

Returns:

true if the principal is not already member of the group

Throws:

JaloInvalidParameterException - in case the given super group is the same or a subgroup of this group

See Also:

• Principal.addToGroup(de.hybris.platform.jalo.security.PrincipalGroup)

setGroups

public void setGroups(SessionContext ctx,
 Set groups)

Changes the group memberships of this group. This method checks cyclic dependencies to avoid self containing groups.

Overrides:

setGroups in class Principal

groups - - the groups the user should be member in

See Also:

• Principal.setGroups(de.hybris.platform.jalo.SessionContext, java.util.Set)

removeMember

@Deprecated(since="ages",
            forRemoval=false)
public boolean removeMember(Principal p)
                     throws ConsistencyCheckException

Deprecated.

since ages - useGeneratedPrincipalGroup.removeFromMembers(Principal) instead

Removes a member.

Parameters:

p -

Returns:

truie if this principal was in this group before

Throws:

ConsistencyCheckException

removeMember

@Deprecated(since="ages",
            forRemoval=false)
public boolean removeMember(SessionContext ctx,
 Principal p)
                     throws ConsistencyCheckException

Deprecated.

since ages - useGeneratedPrincipalGroup.removeFromMembers(SessionContext, Principal) instead

Removes a member.

Parameters:

ctx - can be used for cached access of the member set

p -

Returns:

true if this principal was in this group before

Throws:

ConsistencyCheckException

containsMember

@Deprecated(since="ages",
            forRemoval=false)
public boolean containsMember(Principal p)

Deprecated.

since ages - useUserService.isMemberOfGroup(UserModel, UserGroupModel, boolean)

Parameters:

p -

Returns:

true if the given principal is member of this group.

containsMember

@Deprecated(since="ages",
            forRemoval=false)
public boolean containsMember(SessionContext ctx,
 Principal p)

Deprecated.

since ages - useUserService.isMemberOfGroup(UserModel, UserGroupModel, boolean)

Parameters:

ctx - can be used for cached access of the member set

p -

Returns:

true if the given principal is member of this group.

getDisplayName

@Deprecated(since="ages",
            forRemoval=false)
public String getDisplayName(SessionContext ctx)

Deprecated.

since ages

Specified by:

getDisplayName in class Principal

Returns:

the displayName

getAllDisplayName

@Deprecated(since="ages",
            forRemoval=false)
public Map<Language,String> getAllDisplayName(SessionContext ctx)

Deprecated.

since ages

Description copied from class: Principal

Old jalo generated method from GeneratedPrincipal - Getter of the Principal.displayName jalo localized attribute.

Specified by:

getAllDisplayName in class Principal

Returns:

the localized displayName

getAllLocNames

@Deprecated(since="ages",
            forRemoval=false)
public Map getAllLocNames(SessionContext ctx)

Deprecated.

since ages - usegetAllLocNames(SessionContext) instead

setAllLocNames

@Deprecated(since="ages",
            forRemoval=false)
public void setAllLocNames(SessionContext ctx,
 Map names)

Deprecated.

since ages - usesetAllLocNames(SessionContext, Map) instead