org.ametys.plugins.repository.collection

Class AmetysObjectCollection<F extends AmetysObjectCollectionFactory,A extends AmetysObject>

java.lang.Object

org.ametys.plugins.repository.AbstractAmetysObject

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

org.ametys.plugins.repository.collection.AmetysObjectCollection<F,A>

Type Parameters:

F - the type of the actual factory.

A - the type of the composite AmetysObject.

All Implemented Interfaces:

Iterable<A>, ACLAmetysObject, AmetysObject, JCRAmetysObject, MetadataAwareAmetysObject, ModifiableMetadataAwareAmetysObject, ModifiableACLAmetysObject, ModifiableAmetysObject, ModifiableTraversableAmetysObject, RemovableAmetysObject, TraversableAmetysObject

public class AmetysObjectCollection<F extends AmetysObjectCollectionFactory,A extends AmetysObject>
extends SimpleAmetysObject<F>
implements ModifiableTraversableAmetysObject, Iterable<A>, ModifiableACLAmetysObject

An AmetysObject representing a collection of other AmetysObjects.
The collection stored its contents in the JCR Repository in a hash tree for optimizing performances.
Please note that this implementation does not keep the insertion order of elements.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) AmetysObjectCollectionFactory	_factory

Constructor Summary

Constructors

Constructor and Description
AmetysObjectCollection(Node node, String parentPath, F factory) Creates an AmetysObjectCollection.

Method Summary

Modifier and Type	Method and Description
private String	_getPath(String childName)
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	createChild(String name, String type) Creates a child below current object.
Set<GroupIdentity>	getAllowedGroups(String profileId) Gets the groups that have the given allowed profile on this ametys object
Set<String>	getAllowedProfilesForAnonymous() Gets the allowed profiles an anonymous user has on this ametys object
Set<String>	getAllowedProfilesForAnyConnectedUser() Gets the allowed profiles any connected user has on this ametys object
Map<GroupIdentity,Set<String>>	getAllowedProfilesForGroups() Gets the groups that have allowed profiles assigned on this ametys object
Set<String>	getAllowedProfilesForUser(UserIdentity user) Gets the allowed profiles assigned on this ametys object for this user
Map<UserIdentity,Set<String>>	getAllowedProfilesForUsers() Gets the users that have allowed profiles assigned on this ametys object
Set<UserIdentity>	getAllowedUsers(String profileId) Gets the users that have the given allowed profile on this ametys object
A	getChild(String path) Retrieves a given child from its relative path.
AmetysObjectIterable<A>	getChildren() Retrieves children of the current object.
Set<GroupIdentity>	getDeniedGroups(String profileId) Gets the groups that have the given allowed profile on this ametys object
Set<String>	getDeniedProfilesForAnonymous() Gets the denied profiles an anonymous user has on this ametys object
Set<String>	getDeniedProfilesForAnyConnectedUser() Gets the denied profiles any connected user has on this ametys object
Map<GroupIdentity,Set<String>>	getDeniedProfilesForGroups() Gets the groups that have allowed profiles assigned on this ametys object
Set<String>	getDeniedProfilesForUser(UserIdentity user) Gets the denied profiles assigned on this ametys object for this user
Map<UserIdentity,Set<String>>	getDeniedProfilesForUsers() Gets the users that have denied profiles assigned on this ametys object
Set<UserIdentity>	getDeniedUsers(String profileId) Gets the users that have the given denied profile on this ametys object
AmetysObject	getParent() Returns the parent object in the Ametys hierarchy.
boolean	hasChild(String name) Tests if this Object has at least one child with the given name.
Iterator<A>	iterator()
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.plugins.repository.jcr.SimpleAmetysObject

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

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

equals, 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.TraversableAmetysObject

getChildAt, getChildPosition

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

needsSave, rename, revertChanges, saveChanges

Methods inherited from interface java.lang.Iterable

forEach, spliterator

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

equals, getId, getName, getParentPath, getPath, hashCode

Field Detail

_factory

AmetysObjectCollectionFactory _factory

Constructor Detail

AmetysObjectCollection

public AmetysObjectCollection(Node node,
                              String parentPath,
                              F factory)

Creates an AmetysObjectCollection.

Parameters:

node - the node backing this AmetysObject.

parentPath - the parentPath in the Ametys hierarchy.

factory - the AmetysObjectCollectionFactory which created the AmetysObject.

Method Detail

getChildren

public AmetysObjectIterable<A> getChildren()
                                    throws AmetysRepositoryException

Description copied from interface: TraversableAmetysObject

Retrieves children of the current object.

Specified by:

getChildren in interface TraversableAmetysObject

Returns:

the children or an empty AmetysObjectIterable.

Throws:

AmetysRepositoryException - if an error occurs.

iterator

public Iterator<A> iterator()

Specified by:

iterator in interface Iterable<A extends AmetysObject>

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.

getChild

public 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

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.

createChild

public 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

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.

getParent

public AmetysObject getParent()
                       throws AmetysRepositoryException

Description copied from interface: AmetysObject

Returns the parent object in the Ametys hierarchy.

Specified by:

getParent in interface AmetysObject

Overrides:

getParent in class SimpleAmetysObject<F extends AmetysObjectCollectionFactory>

Returns:

the parent object or null if current object is the root.

Throws:

AmetysRepositoryException - if an error occurs.

_getPath

private String _getPath(String childName)

getAllowedProfilesForAnyConnectedUser

public Set<String> getAllowedProfilesForAnyConnectedUser()

Description copied from interface: ACLAmetysObject

Gets the allowed profiles any connected user has on this ametys object

Specified by:

getAllowedProfilesForAnyConnectedUser in interface ACLAmetysObject

Returns:

the allowed profiles any connected user has on this ametys object

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

getDeniedProfilesForAnyConnectedUser

public Set<String> getDeniedProfilesForAnyConnectedUser()

Description copied from interface: ACLAmetysObject

Gets the denied profiles any connected user has on this ametys object

Specified by:

getDeniedProfilesForAnyConnectedUser in interface ACLAmetysObject

Returns:

the denied profiles any connected user has on this ametys object

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

getAllowedProfilesForAnonymous

public Set<String> getAllowedProfilesForAnonymous()

Description copied from interface: ACLAmetysObject

Gets the allowed profiles an anonymous user has on this ametys object

Specified by:

getAllowedProfilesForAnonymous in interface ACLAmetysObject

Returns:

the allowed profiles an anonymous user has on this ametys object

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

getDeniedProfilesForAnonymous

public Set<String> getDeniedProfilesForAnonymous()

Description copied from interface: ACLAmetysObject

Gets the denied profiles an anonymous user has on this ametys object

Specified by:

getDeniedProfilesForAnonymous in interface ACLAmetysObject

Returns:

the denied profiles an anonymous user has on this ametys object

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

getAllowedProfilesForUser

public Set<String> getAllowedProfilesForUser(UserIdentity user)

Description copied from interface: ACLAmetysObject

Gets the allowed profiles assigned on this ametys object for this user

Specified by:

getAllowedProfilesForUser in interface ACLAmetysObject

Parameters:

user - The user identity

Returns:

The allowed profiles

getAllowedProfilesForUsers

public Map<UserIdentity,Set<String>> getAllowedProfilesForUsers()

Description copied from interface: ACLAmetysObject

Gets the users that have allowed profiles assigned on this ametys object

Specified by:

getAllowedProfilesForUsers in interface ACLAmetysObject

Returns:

The map of allowed users (keys) with their assigned profiles (values)

getAllowedUsers

public Set<UserIdentity> getAllowedUsers(String profileId)

Description copied from interface: ACLAmetysObject

Gets the users that have the given allowed profile on this ametys object

Specified by:

getAllowedUsers in interface ACLAmetysObject

Parameters:

profileId - The id of the profile

Returns:

The allowed users with that profile on this ametys object

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

getAllowedProfilesForGroups

public Map<GroupIdentity,Set<String>> getAllowedProfilesForGroups()

Description copied from interface: ACLAmetysObject

Gets the groups that have allowed profiles assigned on this ametys object

Specified by:

getAllowedProfilesForGroups in interface ACLAmetysObject

Returns:

The map of allowed groups (keys) with their assigned profiles (values)

getAllowedGroups

public Set<GroupIdentity> getAllowedGroups(String profileId)

Description copied from interface: ACLAmetysObject

Gets the groups that have the given allowed profile on this ametys object

Specified by:

getAllowedGroups in interface ACLAmetysObject

Parameters:

profileId - The id of the profile

Returns:

The allowed groups with that profile on that object

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

getDeniedProfilesForUser

public Set<String> getDeniedProfilesForUser(UserIdentity user)

Description copied from interface: ACLAmetysObject

Gets the denied profiles assigned on this ametys object for this user

Specified by:

getDeniedProfilesForUser in interface ACLAmetysObject

Parameters:

user - The user identity

Returns:

The denied profiles

getDeniedProfilesForUsers

public Map<UserIdentity,Set<String>> getDeniedProfilesForUsers()

Description copied from interface: ACLAmetysObject

Gets the users that have denied profiles assigned on this ametys object

Specified by:

getDeniedProfilesForUsers in interface ACLAmetysObject

Returns:

The map of denied users (keys) with their assigned profiles (values)

getDeniedUsers

public Set<UserIdentity> getDeniedUsers(String profileId)

Description copied from interface: ACLAmetysObject

Gets the users that have the given denied profile on this ametys object

Specified by:

getDeniedUsers in interface ACLAmetysObject

Parameters:

profileId - The id of the profile

Returns:

The denied users with that profile on this ametys object

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

getDeniedProfilesForGroups

public Map<GroupIdentity,Set<String>> getDeniedProfilesForGroups()

Description copied from interface: ACLAmetysObject

Gets the groups that have allowed profiles assigned on this ametys object

Specified by:

getDeniedProfilesForGroups in interface ACLAmetysObject

Returns:

The map of denied groups (keys) with their assigned profiles (values)

getDeniedGroups

public Set<GroupIdentity> getDeniedGroups(String profileId)

Description copied from interface: ACLAmetysObject

Gets the groups that have the given allowed profile on this ametys object

Specified by:

getDeniedGroups in interface ACLAmetysObject

Parameters:

profileId - The id of the profile

Returns:

The denied groups with that profile on this ametys object

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