Package org.ametys.cms.repository

Class DefaultIndexableTraversableAmetysObject<F extends DefaultIndexableTraversableAmetysObjectFactory>

java.lang.Object

org.ametys.plugins.repository.AbstractAmetysObject

org.ametys.plugins.repository.jcr.SimpleAmetysObject<F>

org.ametys.plugins.repository.jcr.SimpleModelAwareAmetysObject<F>

org.ametys.cms.repository.SimpleIndexableAmetysObject<F>

org.ametys.cms.repository.DefaultIndexableTraversableAmetysObject<F>

Type Parameters:

F - the actual type of factory.

All Implemented Interfaces:

IndexableAmetysObject, ModifiableIndexableAmetysObject, IndexableDataHolder, ModifiableIndexableDataHolder, IndexableJCRAmetysObject, ACLAmetysObject, AmetysObject, ModelAwareAmetysObject, ModifiableModelAwareAmetysObject, DataHolder, ModelAwareDataHolder, ModifiableDataHolder, ModifiableModelAwareDataHolder, JCRAmetysObject, JCRTraversableAmetysObject, ModelAwareJCRAmetysObject, MetadataAwareAmetysObject, ModifiableMetadataAwareAmetysObject, ModifiableACLAmetysObject, ModifiableAmetysObject, ModifiableTraversableAmetysObject, RemovableAmetysObject, TraversableAmetysObject

Direct Known Subclasses:

DefaultTrashElement, Form, FormQuestion, JCRCalendar, JCRCalendarEvent, JCRTasksList, Site

public class DefaultIndexableTraversableAmetysObject<F extends DefaultIndexableTraversableAmetysObjectFactory>
extends SimpleIndexableAmetysObject<F>
implements JCRTraversableAmetysObject, ModifiableACLAmetysObject

Default implementation of a TraversableAmetysObject, backed by a JCR node.
This implementation heavily relies on its DefaultIndexableTraversableAmetysObjectFactory counterpart.

Field Summary

Fields inherited from interface org.ametys.plugins.repository.data.holder.ModelAwareDataHolder

ALTERNATIVE_SUFFIX, STATUS_SUFFIX

Constructor Summary

Constructors

Constructor	Description
DefaultIndexableTraversableAmetysObject(javax.jcr.Node node, String parentPath, F factory)	Creates a DefaultModelAwareTraversableAmetysObject.

Method Summary

Modifier and Type	Method	Description
void	addAllowedGroups(Set<GroupIdentity> groups, String profileId)	Associates some groups with an allowed profile on this ametys object
void	addAllowedProfilesForAnonymous(Set<String> profileIds)	Adds allowed profiles an anonymous user has on this ametys object
void	addAllowedProfilesForAnyConnectedUser(Set<String> profileIds)	Adds allowed profiles any connected user has on this ametys object
void	addAllowedUsers(Set<UserIdentity> users, String profileId)	Associates some users with an allowed profile on this ametys object
void	addDeniedGroups(Set<GroupIdentity> groups, String profileId)	Associates some groups with an allowed profile on this ametys object
void	addDeniedProfilesForAnonymous(Set<String> profileIds)	Adds denied profiles an anonymous user has on this ametys object
void	addDeniedProfilesForAnyConnectedUser(Set<String> profileIds)	Adds denied profiles any connected user has on this ametys object
void	addDeniedUsers(Set<UserIdentity> users, String profileId)	Associates some users with a denied profile on this ametys object
<A extends AmetysObject> A	createChild(String name, String type)	Creates a child below current object.
void	disallowInheritance(boolean disallow)	Allow or disallow inheritance of permissions
<A extends AmetysObject> A	getChild(String path)	Retrieves a given child from its relative path.
<A extends AmetysObject> AmetysObjectIterable<A>	getChildren()	Retrieves children of the current object.
Map<ProfileAssignmentStorage.AnonymousOrAnyConnectedKeys,Set<String>>	getProfilesForAnonymousAndAnyConnectedUser()	Gets the allowed profiles any connected user has on the given object
Map<GroupIdentity,Map<ProfileAssignmentStorage.UserOrGroup,Set<String>>>	getProfilesForGroups(Set<GroupIdentity> groups)	Gets the groups that have allowed profiles assigned on the given object
Map<UserIdentity,Map<ProfileAssignmentStorage.UserOrGroup,Set<String>>>	getProfilesForUsers(UserIdentity user)	Gets the users that have allowed profiles assigned on the given object
boolean	hasChild(String name)	Tests if this Object has at least one child with the given name.
boolean	isInheritanceDisallowed()	Returns true if the inheritance is disallow for this ametys object
void	removeAllowedGroups(Set<GroupIdentity> groups)	Removes the association between some groups and all allowed profiles on this ametys object
void	removeAllowedGroups(Set<GroupIdentity> groups, String profileId)	Removes the association between some groups and an allowed profile on this ametys object
void	removeAllowedProfilesForAnonymous(Set<String> profileIds)	Removes allowed profiles an anonymous user has on this ametys object
void	removeAllowedProfilesForAnyConnectedUser(Set<String> profileIds)	Removes allowed profiles any connected user has on this ametys object
void	removeAllowedUsers(Set<UserIdentity> users)	Removes the association between some users and all allowed profiles on this ametys object
void	removeAllowedUsers(Set<UserIdentity> users, String profileId)	Removes the association between some users and an allowed profile on this ametys object
void	removeDeniedGroups(Set<GroupIdentity> groups)	Removes the association between some groups and all allowed profiles on this ametys object
void	removeDeniedGroups(Set<GroupIdentity> groups, String profileId)	Removes the association between some groups and an allowed profile on this ametys object
void	removeDeniedProfilesForAnonymous(Set<String> profileIds)	Removes denied profiles an anonymous user has on this ametys object
void	removeDeniedProfilesForAnyConnectedUser(Set<String> profileIds)	Removes denied profiles any connected user has on this ametys object
void	removeDeniedUsers(Set<UserIdentity> users)	Removes the association between some users and all denied profiles on this ametys object
void	removeDeniedUsers(Set<UserIdentity> users, String profileId)	Removes the association between some users and an denied profile on this ametys object

Methods inherited from class org.ametys.cms.repository.SimpleIndexableAmetysObject

getComposite, getComposite, getDataHolder, getExternalComposite, getExternalComposite, getExternalRepeater, getExternalRepeater, getLocalComposite, getLocalComposite, getLocalRepeater, getLocalRepeater, getParentDataHolder, getRepeater, getRepeater, getRootDataHolder, indexData

Methods inherited from class org.ametys.plugins.repository.jcr.SimpleModelAwareAmetysObject

dataToJSON, dataToJSON, dataToJSONForEdition, dataToMap, dataToSAX, dataToSAX, dataToSAXForEdition, getDefinition, getDifferences, getDifferences, getDifferences, getDifferences, getExternalValue, getLocalValue, getModel, getModelItemTypeExtensionPoint, getRepositoryData, getStatus, getType, getValueOfType, getValueOfTypeOrDefault, getValueOrDefault, getValueWithMultiValuedPathSegments, hasDefinition, hasDifferences, hasDifferences, hasDifferences, hasDifferences, hasExternalValue, hasExternalValueOrEmpty, hasLocalValue, hasLocalValueOrEmpty, hasValue, hasValue, hasValueOrEmpty, isMultiple, isMultiple, removeExternalizableMetadataIfExists, removeExternalValue, removeLocalValue, removeValue, setExternalValue, setLocalValue, setStatus, setValue, setValue, synchronizeValues, synchronizeValues, synchronizeValues, synchronizeValues

Methods inherited from class org.ametys.plugins.repository.jcr.SimpleAmetysObject

_getFactory, _invalidateName, _invalidateParentPath, getId, getMetadataHolder, getName, getNode, getParent, getParentPath, getPath, needsSave, remove, rename, revertChanges, saveChanges

Methods inherited from class org.ametys.plugins.repository.AbstractAmetysObject

dataToJSON, dataToSAX, equals, getDataNames, getValue, getValueOrDefault, hashCode, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ametys.plugins.repository.AmetysObject

equals, getId, getName, getParent, getParentPath, getPath, hashCode

Methods inherited from interface org.ametys.plugins.repository.data.holder.DataHolder

copyTo, copyTo, dataToJSON, dataToJSON, dataToSAX, dataToSAX, getValue, getValueOrDefault, hasValue, hasValueOrEmpty

Methods inherited from interface org.ametys.cms.data.ametysobject.IndexableAmetysObject

getSystemPropertyExtensionPoint, indexData

Methods inherited from interface org.ametys.plugins.repository.jcr.JCRAmetysObject

getNode

Methods inherited from interface org.ametys.plugins.repository.data.ametysobject.ModelAwareAmetysObject

getModel

Methods inherited from interface org.ametys.plugins.repository.data.holder.ModelAwareDataHolder

dataToJSON, dataToJSON, dataToJSON, dataToJSON, dataToJSONForEdition, dataToMap, dataToMap, dataToMap, dataToMap, dataToSAX, dataToSAX, dataToSAX, dataToSAX, dataToSAXForEdition, getDataNames, getDefinition, getDifferences, getDifferences, getDifferences, getDifferences, getExternalValue, getLocalValue, getModelItemTypeExtensionPoint, getStatus, getType, getValueOfType, getValueOfTypeOrDefault, getValueOrDefault, getValueWithMultiValuedPathSegments, hasDefinition, hasDifferences, hasDifferences, hasDifferences, hasDifferences, hasExternalValue, hasExternalValueOrEmpty, hasLocalValue, hasLocalValueOrEmpty, hasValue, isMultiple, isMultiple

Methods inherited from interface org.ametys.plugins.repository.ModifiableAmetysObject

needsSave, rename, revertChanges, saveChanges

Methods inherited from interface org.ametys.plugins.repository.data.holder.ModifiableDataHolder

getRepositoryData, removeValue, synchronizeValues

Methods inherited from interface org.ametys.plugins.repository.metadata.ModifiableMetadataAwareAmetysObject

getMetadataHolder

Methods inherited from interface org.ametys.plugins.repository.data.holder.ModifiableModelAwareDataHolder

removeExternalizableMetadataIfExists, removeExternalValue, removeLocalValue, setExternalValue, setLocalValue, setStatus, setValue, setValue, synchronizeValues, synchronizeValues, synchronizeValues

Methods inherited from interface org.ametys.plugins.repository.RemovableAmetysObject

remove

Methods inherited from interface org.ametys.plugins.repository.TraversableAmetysObject

getChildAt, getChildPosition

Constructor Details

DefaultIndexableTraversableAmetysObject

public DefaultIndexableTraversableAmetysObject(javax.jcr.Node node,
 String parentPath,
 F factory)

Creates a DefaultModelAwareTraversableAmetysObject.

Parameters:

node - the node backing this AmetysObject.

parentPath - the parent path in the Ametys hierarchy.

factory - the DefaultIndexableTraversableAmetysObjectFactory which creates the AmetysObject.

Method Details

hasChild

public boolean hasChild(String name)
                 throws AmetysRepositoryException

Description copied from interface: TraversableAmetysObject

Tests if this Object has at least one child with the given name.

Specified by:

hasChild in interface TraversableAmetysObject

Parameters:

name - the name to test. Cannot be null nor empty nor begin with a '/' and it cannot contain '/'.

Returns:

true if the named child exists, false otherwise.

Throws:

AmetysRepositoryException - if an error occurs.

createChild

public <A extends AmetysObject> A createChild(String name,
 String type)
                                       throws AmetysRepositoryException,
RepositoryIntegrityViolationException

Description copied from interface: ModifiableTraversableAmetysObject

Creates a child below current object.

Specified by:

createChild in interface ModifiableTraversableAmetysObject

Type Parameters:

A - the actual type of AmetysObject.

Parameters:

name - the name of the child, position ([n]) are not supported for same name sibling, the child will be added at the end of the children list.

type - the type of the object.

Returns:

the new object created.

Throws:

AmetysRepositoryException - if an error occurs.

RepositoryIntegrityViolationException - if an object with the same name already exists and same name siblings is not allowed.

getChild

public <A extends AmetysObject> A getChild(String path)
                                    throws AmetysRepositoryException,
UnknownAmetysObjectException

Description copied from interface: TraversableAmetysObject

Retrieves a given child from its relative path. The path cannot be null, empty nor begin with a '/'.

Specified by:

getChild in interface TraversableAmetysObject

Type Parameters:

A - the actual type of AmetysObject.

Parameters:

path - the path of the child which can contains a position with. [n] if same name sibling is allowed.

Returns:

the child found.

Throws:

AmetysRepositoryException - if an error occurs.

UnknownAmetysObjectException - if the object does not exist.

getChildren

public <A extends AmetysObject>
AmetysObjectIterable<A> getChildren()
                             throws AmetysRepositoryException

Description copied from interface: TraversableAmetysObject

Retrieves children of the current object.

Specified by:

getChildren in interface TraversableAmetysObject

Type Parameters:

A - the actual type of AmetysObjects.

Returns:

the children or an empty AmetysObjectIterable.

Throws:

AmetysRepositoryException - if an error occurs.

getProfilesForAnonymousAndAnyConnectedUser

public Map<ProfileAssignmentStorage.AnonymousOrAnyConnectedKeys,Set<String>> getProfilesForAnonymousAndAnyConnectedUser()

Description copied from interface: ACLAmetysObject

Gets the allowed profiles any connected user has on the given object

Specified by:

getProfilesForAnonymousAndAnyConnectedUser in interface ACLAmetysObject

Returns:

a map containing allowed/denied profiles that anonymous and any connected user has on the given object

getProfilesForGroups

public Map<GroupIdentity,Map<ProfileAssignmentStorage.UserOrGroup,Set<String>>> getProfilesForGroups(Set<GroupIdentity> groups)

Description copied from interface: ACLAmetysObject

Gets the groups that have allowed profiles assigned on the given object

Specified by:

getProfilesForGroups in interface ACLAmetysObject

Parameters:

groups - The group to get profiles for. Can be null to get profiles for all groups that have rights

Returns:

The map of allowed/denied groups with their assigned profiles

getProfilesForUsers

public Map<UserIdentity,Map<ProfileAssignmentStorage.UserOrGroup,Set<String>>> getProfilesForUsers(UserIdentity user)

Description copied from interface: ACLAmetysObject

Gets the users that have allowed profiles assigned on the given object

Specified by:

getProfilesForUsers in interface ACLAmetysObject

Parameters:

user - The user to get profiles for. Can be null to get profiles for all users that have rights

Returns:

The map of allowed users with their assigned allowed/denied profiles

addAllowedProfilesForAnyConnectedUser

public void addAllowedProfilesForAnyConnectedUser(Set<String> profileIds)

Description copied from interface: ModifiableACLAmetysObject

Adds allowed profiles any connected user has on this ametys object

Specified by:

addAllowedProfilesForAnyConnectedUser in interface ModifiableACLAmetysObject

Parameters:

profileIds - The profiles to add

removeAllowedProfilesForAnyConnectedUser

public void removeAllowedProfilesForAnyConnectedUser(Set<String> profileIds)

Description copied from interface: ModifiableACLAmetysObject

Removes allowed profiles any connected user has on this ametys object

Specified by:

removeAllowedProfilesForAnyConnectedUser in interface ModifiableACLAmetysObject

Parameters:

profileIds - The profiles to remove

addDeniedProfilesForAnyConnectedUser

public void addDeniedProfilesForAnyConnectedUser(Set<String> profileIds)

Description copied from interface: ModifiableACLAmetysObject

Adds denied profiles any connected user has on this ametys object

Specified by:

addDeniedProfilesForAnyConnectedUser in interface ModifiableACLAmetysObject

Parameters:

profileIds - The profiles to add

removeDeniedProfilesForAnyConnectedUser

public void removeDeniedProfilesForAnyConnectedUser(Set<String> profileIds)

Description copied from interface: ModifiableACLAmetysObject

Removes denied profiles any connected user has on this ametys object

Specified by:

removeDeniedProfilesForAnyConnectedUser in interface ModifiableACLAmetysObject

Parameters:

profileIds - The profiles to remove

addAllowedProfilesForAnonymous

public void addAllowedProfilesForAnonymous(Set<String> profileIds)

Description copied from interface: ModifiableACLAmetysObject

Adds allowed profiles an anonymous user has on this ametys object

Specified by:

addAllowedProfilesForAnonymous in interface ModifiableACLAmetysObject

Parameters:

profileIds - The profiles to add

removeAllowedProfilesForAnonymous

public void removeAllowedProfilesForAnonymous(Set<String> profileIds)

Description copied from interface: ModifiableACLAmetysObject

Removes allowed profiles an anonymous user has on this ametys object

Specified by:

removeAllowedProfilesForAnonymous in interface ModifiableACLAmetysObject

Parameters:

profileIds - The profiles to remove

addDeniedProfilesForAnonymous

public void addDeniedProfilesForAnonymous(Set<String> profileIds)

Description copied from interface: ModifiableACLAmetysObject

Adds denied profiles an anonymous user has on this ametys object

Specified by:

addDeniedProfilesForAnonymous in interface ModifiableACLAmetysObject

Parameters:

profileIds - The profiles to add

removeDeniedProfilesForAnonymous

public void removeDeniedProfilesForAnonymous(Set<String> profileIds)

Description copied from interface: ModifiableACLAmetysObject

Removes denied profiles an anonymous user has on this ametys object

Specified by:

removeDeniedProfilesForAnonymous in interface ModifiableACLAmetysObject

Parameters:

profileIds - The profiles to remove

addAllowedUsers

public void addAllowedUsers(Set<UserIdentity> users,
 String profileId)

Description copied from interface: ModifiableACLAmetysObject

Associates some users with an allowed profile on this ametys object

Specified by:

addAllowedUsers in interface ModifiableACLAmetysObject

Parameters:

users - The users to add

profileId - The id of the profile

removeAllowedUsers

public void removeAllowedUsers(Set<UserIdentity> users,
 String profileId)

Description copied from interface: ModifiableACLAmetysObject

Removes the association between some users and an allowed profile on this ametys object

Specified by:

removeAllowedUsers in interface ModifiableACLAmetysObject

Parameters:

users - The users to remove

profileId - The id of the profile

removeAllowedUsers

public void removeAllowedUsers(Set<UserIdentity> users)

Description copied from interface: ModifiableACLAmetysObject

Removes the association between some users and all allowed profiles on this ametys object

Specified by:

removeAllowedUsers in interface ModifiableACLAmetysObject

Parameters:

users - The users to remove

addAllowedGroups

public void addAllowedGroups(Set<GroupIdentity> groups,
 String profileId)

Description copied from interface: ModifiableACLAmetysObject

Associates some groups with an allowed profile on this ametys object

Specified by:

addAllowedGroups in interface ModifiableACLAmetysObject

Parameters:

groups - The groups to add

profileId - The id of the profile

removeAllowedGroups

public void removeAllowedGroups(Set<GroupIdentity> groups,
 String profileId)

Description copied from interface: ModifiableACLAmetysObject

Removes the association between some groups and an allowed profile on this ametys object

Specified by:

removeAllowedGroups in interface ModifiableACLAmetysObject

Parameters:

groups - The groups to remove

profileId - The id of the profile

removeAllowedGroups

public void removeAllowedGroups(Set<GroupIdentity> groups)

Description copied from interface: ModifiableACLAmetysObject

Removes the association between some groups and all allowed profiles on this ametys object

Specified by:

removeAllowedGroups in interface ModifiableACLAmetysObject

Parameters:

groups - The groups to remove

addDeniedUsers

public void addDeniedUsers(Set<UserIdentity> users,
 String profileId)

Description copied from interface: ModifiableACLAmetysObject

Associates some users with a denied profile on this ametys object

Specified by:

addDeniedUsers in interface ModifiableACLAmetysObject

Parameters:

users - The users to add

profileId - The id of the profile

removeDeniedUsers

public void removeDeniedUsers(Set<UserIdentity> users,
 String profileId)

Description copied from interface: ModifiableACLAmetysObject

Removes the association between some users and an denied profile on this ametys object

Specified by:

removeDeniedUsers in interface ModifiableACLAmetysObject

Parameters:

users - The users to remove

profileId - The id of the profile

removeDeniedUsers

public void removeDeniedUsers(Set<UserIdentity> users)

Description copied from interface: ModifiableACLAmetysObject

Removes the association between some users and all denied profiles on this ametys object

Specified by:

removeDeniedUsers in interface ModifiableACLAmetysObject

Parameters:

users - The users to remove

addDeniedGroups

public void addDeniedGroups(Set<GroupIdentity> groups,
 String profileId)

Description copied from interface: ModifiableACLAmetysObject

Associates some groups with an allowed profile on this ametys object

Specified by:

addDeniedGroups in interface ModifiableACLAmetysObject

Parameters:

groups - The groups to add

profileId - The id of the profile

removeDeniedGroups

public void removeDeniedGroups(Set<GroupIdentity> groups,
 String profileId)

Description copied from interface: ModifiableACLAmetysObject

Removes the association between some groups and an allowed profile on this ametys object

Specified by:

removeDeniedGroups in interface ModifiableACLAmetysObject

Parameters:

groups - The groups to remove

profileId - The id of the profile

removeDeniedGroups

public void removeDeniedGroups(Set<GroupIdentity> groups)

Description copied from interface: ModifiableACLAmetysObject

Removes the association between some groups and all allowed profiles on this ametys object

Specified by:

removeDeniedGroups in interface ModifiableACLAmetysObject

Parameters:

groups - The groups to remove

isInheritanceDisallowed

public boolean isInheritanceDisallowed()

Description copied from interface: ACLAmetysObject

Returns true if the inheritance is disallow for this ametys object

Specified by:

isInheritanceDisallowed in interface ACLAmetysObject

Returns:

true if the inheritance is disallow for this ametys object

disallowInheritance

public void disallowInheritance(boolean disallow)

Description copied from interface: ModifiableACLAmetysObject

Allow or disallow inheritance of permissions

Specified by:

disallowInheritance in interface ModifiableACLAmetysObject

Parameters:

disallow - true to disallow inheritance