Package org.ametys.plugins.repository.jcr

Class DefaultAmetysObject<F extends DefaultAmetysObjectFactory>

java.lang.Object

org.ametys.plugins.repository.AbstractAmetysObject

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

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

Type Parameters:

F - the actual type of factory.

All Implemented Interfaces:

ACLAmetysObject, AmetysObject, JCRAmetysObject, MetadataAwareAmetysObject, ModifiableMetadataAwareAmetysObject, ModifiableACLAmetysObject, ModifiableAmetysObject, RemovableAmetysObject, DataAndVersionAwareAmetysObject, ModifiableDataAwareVersionableAmetysObject, VersionableAmetysObject, VersionAwareAmetysObject

Direct Known Subclasses:

Cart, DefaultContent, DefaultLockableAmetysObject, JCRCalendarResource, JCRPost, JCRProjectMember, JCRResource, JCRTask, Query

public class DefaultAmetysObject<F extends DefaultAmetysObjectFactory>
extends SimpleAmetysObject<F>
implements ModifiableDataAwareVersionableAmetysObject, ModifiableACLAmetysObject

Default implementation of a JCRAmetysObject, which is also a VersionableAmetysObject.

Field Summary

Fields

Modifier and Type	Field	Description
protected static List<String>	PROTECTED_PROPERTIES	Properties that are auto-created or protected, which mustn't be copied when copying a node.

Constructor Summary

Constructors

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

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
void	addLabel(String label, boolean moveIfPresent)	Add a label on this object.
void	checkpoint()	Persists the current version of this AmetysObject
protected void	copyNode(Node parentDest, Node src)	Copy the source node in parent node
void	disallowInheritance(boolean disallow)	Allow or disallow inheritance of permissions
String[]	getAllLabels()	List all labels that exist on this object, whatever the revision.
String[]	getAllRevisions()	List all revisions of this object.
Node	getBaseNode()	Returns the JCR node backing this AmetysObject in the default JCR workspace
protected Version	getBaseVersion()	Returns the JCR base version of the node.
String[]	getLabels()	Get the labels for this object, in the current revision (a single revision can hold several labels).
String[]	getLabels(String revision)	Get the labels for this object fot the given revision (a single revision can hold several labels).
Node	getNode()	Gives access to the underlying JCR node.
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
String	getRevision()	Get the revision of this object, if any.
Date	getRevisionTimestamp()	Get the creation time of the current revision, if any.
Date	getRevisionTimestamp(String revision)	Get the creation time of the given revision.
ModifiableModelLessDataHolder	getUnversionedDataHolder()	Returns an unversioned ModifiableModelLessDataHolder.
protected VersionHistory	getVersionHistory()	Returns the JCR VersionHistory of the base node.
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
void	removeLabel(String label)	Remove a label from this object. If the label doesn't exist, it is silently ignored.
void	restoreFromLabel(String label)	Restore data from the specified label.
protected void	restoreFromNode(Node node)	Restore from a node
void	restoreFromRevision(String revision)	Restore data from the specified revision.
void	switchToLabel(String label)	Switch to the revision corresponding to the specified label. All subsequent method calls on this AmetysObject will concern that version.
void	switchToRevision(String revision)	Switch to the revision corresponding to the specified revision. All subsequent method calls on this AmetysObject will concern that version.

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

_getFactory, _invalidateName, _invalidateParentPath, getId, getMetadataHolder, getName, getParent, 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.AmetysObject

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

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

needsSave, rename, revertChanges, saveChanges

Field Detail

PROTECTED_PROPERTIES

protected static final List<String> PROTECTED_PROPERTIES

Properties that are auto-created or protected, which mustn't be copied when copying a node.

Constructor Detail

DefaultAmetysObject

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

Creates an DefaultAmetysObject.

Parameters:

node - the node backing this AmetysObject

parentPath - the parentPath in the Ametys hierarchy

factory - the DefaultAmetysObjectFactory which created the AmetysObject

Method Detail

getNode

public Node getNode()

Description copied from interface: JCRAmetysObject

Gives access to the underlying JCR node.

Specified by:

getNode in interface JCRAmetysObject

Overrides:

getNode in class SimpleAmetysObject<F extends DefaultAmetysObjectFactory>

Returns:

the JCR node backing this AmetysObject.

getBaseNode

public Node getBaseNode()

Returns the JCR node backing this AmetysObject in the default JCR workspace

Returns:

the JCR node backing this AmetysObject in the default JCR workspace

getVersionHistory

protected VersionHistory getVersionHistory()
                                    throws RepositoryException

Returns the JCR VersionHistory of the base node.

Returns:

the JCR VersionHistory of the base node.

Throws:

RepositoryException - if something wrong occurs retrieving the VersionHistory.

getBaseVersion

protected Version getBaseVersion()
                          throws RepositoryException

Returns the JCR base version of the node.

Returns:

the JCR base version of the node.

Throws:

RepositoryException - if something wrong occurs retrieving the base version.

checkpoint

public void checkpoint()
                throws AmetysRepositoryException

Description copied from interface: VersionableAmetysObject

Persists the current version of this AmetysObject

Specified by:

checkpoint in interface VersionableAmetysObject

Throws:

AmetysRepositoryException - if a problem occurs

switchToLabel

public void switchToLabel(String label)
                   throws UnknownAmetysObjectException,
                          AmetysRepositoryException

Description copied from interface: VersionAwareAmetysObject

Switch to the revision corresponding to the specified label.
All subsequent method calls on this AmetysObject will concern that version.

Specified by:

switchToLabel in interface VersionAwareAmetysObject

Parameters:

label - the label to switch to, or null to specify the current version

Throws:

UnknownAmetysObjectException - if the label does not correspond to any revision

AmetysRepositoryException - if a problem occurs

switchToRevision

public void switchToRevision(String revision)
                      throws UnknownAmetysObjectException,
                             AmetysRepositoryException

Description copied from interface: VersionAwareAmetysObject

Switch to the revision corresponding to the specified revision.
All subsequent method calls on this AmetysObject will concern that version.

Specified by:

switchToRevision in interface VersionAwareAmetysObject

Parameters:

revision - the revision, or null to specify the current version

Throws:

UnknownAmetysObjectException - if the revision does not exist

AmetysRepositoryException - if a problem occurs

restoreFromLabel

public void restoreFromLabel(String label)
                      throws UnknownAmetysObjectException,
                             AmetysRepositoryException

Description copied from interface: VersionableAmetysObject

Restore data from the specified label.

Specified by:

restoreFromLabel in interface VersionableAmetysObject

Parameters:

label - the label

Throws:

UnknownAmetysObjectException - if the label does not correspond to any revision

AmetysRepositoryException - if a problem occurs

restoreFromRevision

public void restoreFromRevision(String revision)
                         throws UnknownAmetysObjectException,
                                AmetysRepositoryException

Description copied from interface: VersionableAmetysObject

Restore data from the specified revision.

Specified by:

restoreFromRevision in interface VersionableAmetysObject

Parameters:

revision - the revision

Throws:

UnknownAmetysObjectException - if the revision does not exist

AmetysRepositoryException - if a problem occurs

restoreFromNode

protected void restoreFromNode(Node node)
                        throws RepositoryException

Restore from a node

Parameters:

node - The node to restore

Throws:

RepositoryException - If error occurs

copyNode

protected void copyNode(Node parentDest,
                        Node src)
                 throws RepositoryException

Copy the source node in parent node

Parameters:

parentDest - The dest node

src - The source node to copy

Throws:

RepositoryException - If error occurs

addLabel

public void addLabel(String label,
                     boolean moveIfPresent)
              throws AmetysRepositoryException

Description copied from interface: VersionableAmetysObject

Add a label on this object.

Specified by:

addLabel in interface VersionableAmetysObject

Parameters:

label - the label to add.

moveIfPresent - what to do if the content already has this label : move it to the current revision if true, keep it unchanged if false.

Throws:

AmetysRepositoryException - if some problem arises.

removeLabel

public void removeLabel(String label)
                 throws AmetysRepositoryException

Description copied from interface: VersionableAmetysObject

Remove a label from this object.
If the label doesn't exist, it is silently ignored.

Specified by:

removeLabel in interface VersionableAmetysObject

Parameters:

label - the label to remove

Throws:

AmetysRepositoryException - if some problem arises.

getAllLabels

public String[] getAllLabels()
                      throws AmetysRepositoryException

Description copied from interface: VersionAwareAmetysObject

List all labels that exist on this object, whatever the revision.

Specified by:

getAllLabels in interface VersionAwareAmetysObject

Returns:

the list of all labels (can be empty, but not null).

Throws:

AmetysRepositoryException - if the labels cannot be known.

getLabels

public String[] getLabels()
                   throws AmetysRepositoryException

Description copied from interface: VersionAwareAmetysObject

Get the labels for this object, in the current revision (a single revision can hold several labels).

Specified by:

getLabels in interface VersionAwareAmetysObject

Returns:

the list of labels for this revision (can be empty, but not null).

Throws:

AmetysRepositoryException - if the labels cannot be known.

getLabels

public String[] getLabels(String revision)
                   throws UnknownAmetysObjectException,
                          AmetysRepositoryException

Description copied from interface: VersionAwareAmetysObject

Get the labels for this object fot the given revision (a single revision can hold several labels).

Specified by:

getLabels in interface VersionAwareAmetysObject

Parameters:

revision - the revision

Returns:

the list of labels for this revision (can be empty, but not null).

Throws:

UnknownAmetysObjectException - if the given revision does not exist for this object.

AmetysRepositoryException - if the labels cannot be known.

getRevision

public String getRevision()
                   throws AmetysRepositoryException

Description copied from interface: VersionAwareAmetysObject

Get the revision of this object, if any.

Specified by:

getRevision in interface VersionAwareAmetysObject

Returns:

the revision or null if this is the latest.

Throws:

AmetysRepositoryException - if the revision cannot be known.

getRevisionTimestamp

public Date getRevisionTimestamp()
                          throws AmetysRepositoryException

Description copied from interface: VersionAwareAmetysObject

Get the creation time of the current revision, if any.

Specified by:

getRevisionTimestamp in interface VersionAwareAmetysObject

Returns:

the revision creation time, or null if there's no current revision.

Throws:

AmetysRepositoryException - if an error occurs

getRevisionTimestamp

public Date getRevisionTimestamp(String revision)
                          throws UnknownAmetysObjectException,
                                 AmetysRepositoryException

Description copied from interface: VersionAwareAmetysObject

Get the creation time of the given revision.

Specified by:

getRevisionTimestamp in interface VersionAwareAmetysObject

Parameters:

revision - the revision.

Returns:

the revision creation date.

Throws:

UnknownAmetysObjectException - if the given revision does not exist for this object.

AmetysRepositoryException - if an error occurs

getAllRevisions

public String[] getAllRevisions()
                         throws AmetysRepositoryException

Description copied from interface: VersionAwareAmetysObject

List all revisions of this object. Revisions are ordered in chronological order.

Specified by:

getAllRevisions in interface VersionAwareAmetysObject

Returns:

the list of revisions (can be empty, but not null)

Throws:

AmetysRepositoryException - if the revisions cannot be known.

getUnversionedDataHolder

public ModifiableModelLessDataHolder getUnversionedDataHolder()

Description copied from interface: ModifiableDataAwareVersionableAmetysObject

Returns an unversioned ModifiableModelLessDataHolder.

Specified by:

getUnversionedDataHolder in interface DataAndVersionAwareAmetysObject

Specified by:

getUnversionedDataHolder in interface ModifiableDataAwareVersionableAmetysObject

Returns:

an unversioned ModifiableModelLessDataHolder.

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