org.apache.chemistry.opencmis.client.runtime

Class AbstractCmisObject

java.lang.Object

org.apache.chemistry.opencmis.client.runtime.AbstractCmisObject

All Implemented Interfaces:

Serializable, CmisObject, CmisObjectProperties, ObjectId

Direct Known Subclasses:

AbstractFilableCmisObject, RelationshipImpl

public abstract class AbstractCmisObject
extends Object
implements CmisObject, Serializable

Base class for all persistent session object impl classes.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractCmisObject()

Method Summary

Methods

Modifier and Type	Method and Description
Acl	addAcl(List<Ace> addAces, AclPropagation aclPropagation) Adds ACEs to the object and refreshes this object afterwards.
Acl	applyAcl(List<Ace> addAces, List<Ace> removeAces, AclPropagation aclPropagation) Adds and removes ACEs to the object and refreshes this object afterwards.
void	applyPolicy(ObjectId... policyIds) Applies the provided policies and refreshes this object afterwards.
void	delete() Deletes this object.
void	delete(boolean allVersions) Deletes this object.
List<ObjectType>	findObjectType(String id) Returns a list of primary and secondary object types that define the given property.
Acl	getAcl() Returns the ACL if it has been fetched for this object.
Acl	getAcl(boolean onlyBasicPermissions)
<T> T	getAdapter(Class<T> adapterInterface) Returns an adapter based on the given interface.
AllowableActions	getAllowableActions() Returns the allowable actions if they have been fetched for this object.
ObjectType	getBaseType() Returns the base type of this CMIS object (object type identified by cmis:baseTypeId).
BaseTypeId	getBaseTypeId() Returns the id of the base type of this CMIS object (CMIS property cmis:baseTypeId).
protected CmisBinding	getBinding() Returns the binding object.
String	getChangeToken() Returns the change token (CMIS property cmis:changeToken).
String	getCreatedBy() Returns the user who created this CMIS object (CMIS property cmis:createdBy).
protected OperationContext	getCreationContext() Returns the OperationContext that was used to create this object.
GregorianCalendar	getCreationDate() Returns the timestamp when this CMIS object has been created (CMIS property cmis:creationDate).
String	getDescription() Returns the description of this CMIS object (CMIS property cmis:description).
List<CmisExtensionElement>	getExtensions(ExtensionLevel level) Returns the extensions for the given level.
String	getId() Returns the object ID.
GregorianCalendar	getLastModificationDate() Returns the timestamp when this CMIS object has been modified (CMIS property cmis:lastModificationDate).
String	getLastModifiedBy() Returns the user who modified this CMIS object (CMIS property cmis:lastModifiedBy).
String	getName() Returns the name of this CMIS object (CMIS property cmis:name).
protected ObjectFactory	getObjectFactory() Returns the object factory.
protected String	getObjectId() Returns the id of this object or throws an exception if the id is unknown.
protected ObjectType	getObjectType() Returns the object type.
Set<String>	getPermissionsForPrincipal(String principalId) Returns all permissions for the given principal from the ACL.
Set<String>	getPermissonsForPrincipal(String principalId)
List<Policy>	getPolicies() Returns the applied policies if they have been fetched for this object.
List<Property<?>>	getProperties() Returns a list of all available CMIS properties.
<T> Property<T>	getProperty(String id) Returns a property.
protected String	getPropertyQueryName(String propertyId) Returns the query name of a property.
<T> T	getPropertyValue(String id) Returns the value of a property.
long	getRefreshTimestamp() Returns the timestamp of the last refresh.
List<Relationship>	getRelationships() Returns the relationships if they have been fetched for this object.
List<Rendition>	getRenditions() Returns the renditions if they have been fetched for this object.
protected String	getRepositoryId() Returns the repository id.
List<SecondaryType>	getSecondaryTypes() Returns the secondary types of this CMIS object (object types identified by cmis:secondaryObjectTypeIds).
protected SessionImpl	getSession() Returns the session object.
ObjectType	getType() Returns the type of this CMIS object (object type identified by cmis:objectTypeId).
boolean	hasAllowableAction(Action action) Returns if a given action in the Allowable Actions.
protected void	initialize(SessionImpl session, ObjectType objectType, ObjectData objectData, OperationContext context) Initializes the object.
protected void	readLock() Acquires a read lock.
protected void	readUnlock() Releases a read lock.
void	refresh() Reloads this object from the repository.
void	refreshIfOld(long durationInMillis) Reloads the data from the repository if the last refresh did not occur within durationInMillis.
Acl	removeAcl(List<Ace> removeAces, AclPropagation aclPropagation) Removes ACEs to the object and refreshes this object afterwards.
void	removePolicy(ObjectId... policyIds) Removes the provided policies and refreshes this object afterwards.
CmisObject	rename(String newName) Renames this object (changes the value of cmis:name).
ObjectId	rename(String newName, boolean refresh) Renames this object (changes the value of cmis:name).
Acl	setAcl(List<Ace> aces) Removes the direct ACE of this object, sets the provided ACEs to the object and refreshes this object afterwards.
String	toString()
CmisObject	updateProperties(Map<String,?> properties) Updates the provided properties and refreshes this object afterwards.
ObjectId	updateProperties(Map<String,?> properties, boolean refresh) Updates the provided properties.
protected void	writeLock() Acquires a write lock.
protected void	writeUnlock() Releases a write lock.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractCmisObject

public AbstractCmisObject()

Method Detail

initialize

protected void initialize(SessionImpl session,
              ObjectType objectType,
              ObjectData objectData,
              OperationContext context)

Initializes the object.

writeLock

protected void writeLock()

Acquires a write lock.

writeUnlock

protected void writeUnlock()

Releases a write lock.

readLock

protected void readLock()

Acquires a read lock.

readUnlock

protected void readUnlock()

Releases a read lock.

getSession

protected SessionImpl getSession()

Returns the session object.

getRepositoryId

protected String getRepositoryId()

Returns the repository id.

getObjectType

protected ObjectType getObjectType()

Returns the object type.

getBinding

protected CmisBinding getBinding()

Returns the binding object.

getObjectFactory

protected ObjectFactory getObjectFactory()

Returns the object factory.

getObjectId

protected String getObjectId()

Returns the id of this object or throws an exception if the id is unknown.

getCreationContext

protected OperationContext getCreationContext()

Returns the OperationContext that was used to create this object.

getPropertyQueryName

protected String getPropertyQueryName(String propertyId)

Returns the query name of a property.

delete

public void delete()

Description copied from interface: CmisObject

Deletes this object. If this object is a document, the whole version series is deleted.

Specified by:

delete in interface CmisObject

delete

public void delete(boolean allVersions)

Description copied from interface: CmisObject

Deletes this object.

Specified by:

delete in interface CmisObject

Parameters:

allVersions - if this object is a document this parameter defines whether only this version (false) or all versions (true ) should be deleted, the parameter is ignored for all other object types

updateProperties

public CmisObject updateProperties(Map<String,?> properties)

Description copied from interface: CmisObject

Updates the provided properties and refreshes this object afterwards. If the repository created a new object, for example a new version, this new object is returned. Otherwise the current object is returned.

Specified by:

updateProperties in interface CmisObject

Parameters:

properties - the properties to update

Returns:

the updated object

updateProperties

public ObjectId updateProperties(Map<String,?> properties,
                        boolean refresh)

Description copied from interface: CmisObject

Updates the provided properties. If the repository created a new object, for example a new version, the object ID of the new object is returned. Otherwise the object ID of the current object is returned.

Specified by:

updateProperties in interface CmisObject

Parameters:

properties - the properties to update

refresh - true if this object should be refreshed after the update, false if not

Returns:

the object ID of the updated object

rename

public CmisObject rename(String newName)

Description copied from interface: CmisObject

Renames this object (changes the value of cmis:name). If the repository created a new object, for example a new version, this new object is returned. Otherwise the current object is returned.

Specified by:

rename in interface CmisObject

Parameters:

newName - the new name, not null or empty

Returns:

the updated object

rename

public ObjectId rename(String newName,
              boolean refresh)

Description copied from interface: CmisObject

Renames this object (changes the value of cmis:name). If the repository created a new object, for example a new version, the object id of the new object is returned. Otherwise the object id of the current object is returned.

Specified by:

rename in interface CmisObject

Parameters:

newName - the new name, not null or empty

refresh - true if this object should be refreshed after the update, false if not

Returns:

the object ID of the updated object

getBaseType

public ObjectType getBaseType()

Description copied from interface: CmisObjectProperties

Returns the base type of this CMIS object (object type identified by cmis:baseTypeId).

Specified by:

getBaseType in interface CmisObjectProperties

Returns:

the base type of the object or null if the property cmis:baseTypeId hasn't been requested or hasn't been provided by the repository

getBaseTypeId

public BaseTypeId getBaseTypeId()

Description copied from interface: CmisObjectProperties

Returns the id of the base type of this CMIS object (CMIS property cmis:baseTypeId).

Specified by:

getBaseTypeId in interface CmisObjectProperties

Returns:

the base type id of the object or null if the property hasn't been requested or hasn't been provided by the repository

getChangeToken

public String getChangeToken()

Description copied from interface: CmisObjectProperties

Returns the change token (CMIS property cmis:changeToken).

Specified by:

getChangeToken in interface CmisObjectProperties

Returns:

the change token of the object or null if the property hasn't been requested or hasn't been provided or isn't supported by the repository

getCreatedBy

public String getCreatedBy()

Description copied from interface: CmisObjectProperties

Returns the user who created this CMIS object (CMIS property cmis:createdBy).

Specified by:

getCreatedBy in interface CmisObjectProperties

Returns:

the creator of the object or null if the property hasn't been requested or hasn't been provided by the repository

getCreationDate

public GregorianCalendar getCreationDate()

Description copied from interface: CmisObjectProperties

Returns the timestamp when this CMIS object has been created (CMIS property cmis:creationDate).

Specified by:

getCreationDate in interface CmisObjectProperties

Returns:

the creation time of the object or null if the property hasn't been requested or hasn't been provided by the repository

getId

public String getId()

Description copied from interface: ObjectId

Returns the object ID.

Specified by:

getId in interface ObjectId

Returns:

the object ID

getLastModificationDate

public GregorianCalendar getLastModificationDate()

Description copied from interface: CmisObjectProperties

Returns the timestamp when this CMIS object has been modified (CMIS property cmis:lastModificationDate).

Specified by:

getLastModificationDate in interface CmisObjectProperties

Returns:

the last modification date of the object or null if the property hasn't been requested or hasn't been provided by the repository

getLastModifiedBy

public String getLastModifiedBy()

Description copied from interface: CmisObjectProperties

Returns the user who modified this CMIS object (CMIS property cmis:lastModifiedBy).

Specified by:

getLastModifiedBy in interface CmisObjectProperties

Returns:

the last modifier of the object or null if the property hasn't been requested or hasn't been provided by the repository

getName

public String getName()

Description copied from interface: CmisObjectProperties

Returns the name of this CMIS object (CMIS property cmis:name).

Specified by:

getName in interface CmisObjectProperties

Returns:

the name of the object or null if the property hasn't been requested or hasn't been provided by the repository

getDescription

public String getDescription()

Description copied from interface: CmisObjectProperties

Returns the description of this CMIS object (CMIS property cmis:description).

Specified by:

getDescription in interface CmisObjectProperties

Returns:

the description of the object or null if the property hasn't been requested, hasn't been provided by the repository, or the property value isn't set

getProperties

public List<Property<?>> getProperties()

Description copied from interface: CmisObjectProperties

Returns a list of all available CMIS properties.

Specified by:

getProperties in interface CmisObjectProperties

Returns:

all available CMIS properties

getProperty

public <T> Property<T> getProperty(String id)

Description copied from interface: CmisObjectProperties

Returns a property.

Specified by:

getProperty in interface CmisObjectProperties

Parameters:

id - the ID of the property

Returns:

the property or null if the property hasn't been requested or hasn't been provided by the repository

getPropertyValue

public <T> T getPropertyValue(String id)

Description copied from interface: CmisObjectProperties

Returns the value of a property.

Specified by:

getPropertyValue in interface CmisObjectProperties

Parameters:

id - the ID of the property

Returns:

the property value or null if the property hasn't been requested, hasn't been provided by the repository, or the property value isn't set

getType

public ObjectType getType()

Description copied from interface: CmisObjectProperties

Returns the type of this CMIS object (object type identified by cmis:objectTypeId).

Specified by:

getType in interface CmisObjectProperties

Returns:

the type of the object or null if the property cmis:objectTypeId hasn't been requested or hasn't been provided by the repository

getSecondaryTypes

public List<SecondaryType> getSecondaryTypes()

Description copied from interface: CmisObjectProperties

Returns the secondary types of this CMIS object (object types identified by cmis:secondaryObjectTypeIds).

Specified by:

getSecondaryTypes in interface CmisObjectProperties

Returns:

the secondary types of the object or null if the property cmis:secondaryObjectTypeIds hasn't been requested or hasn't been provided by the repository

findObjectType

public List<ObjectType> findObjectType(String id)

Description copied from interface: CmisObjectProperties

Returns a list of primary and secondary object types that define the given property.

Specified by:

findObjectType in interface CmisObjectProperties

Parameters:

id - the ID of the property

Returns:

a list of object types that define the given property or null if the property couldn't be found in the object types that are attached to this object

getAllowableActions

public AllowableActions getAllowableActions()

Description copied from interface: CmisObject

Returns the allowable actions if they have been fetched for this object.

Specified by:

getAllowableActions in interface CmisObject

hasAllowableAction

public boolean hasAllowableAction(Action action)

Description copied from interface: CmisObject

Returns if a given action in the Allowable Actions.

Specified by:

hasAllowableAction in interface CmisObject

Parameters:

action - the action to test, must not be null

Returns:

true if the action was found in the Allowable Actions, false if the action was not found in the Allowable Actions

getRenditions

public List<Rendition> getRenditions()

Description copied from interface: CmisObject

Returns the renditions if they have been fetched for this object.

Specified by:

getRenditions in interface CmisObject

getAcl

public Acl getAcl(boolean onlyBasicPermissions)

applyAcl

public Acl applyAcl(List<Ace> addAces,
           List<Ace> removeAces,
           AclPropagation aclPropagation)

Description copied from interface: CmisObject

Adds and removes ACEs to the object and refreshes this object afterwards.

Specified by:

applyAcl in interface CmisObject

Returns:

the new ACL of this object

addAcl

public Acl addAcl(List<Ace> addAces,
         AclPropagation aclPropagation)

Description copied from interface: CmisObject

Adds ACEs to the object and refreshes this object afterwards.

Specified by:

addAcl in interface CmisObject

Returns:

the new ACL of this object

removeAcl

public Acl removeAcl(List<Ace> removeAces,
            AclPropagation aclPropagation)

Description copied from interface: CmisObject

Removes ACEs to the object and refreshes this object afterwards.

Specified by:

removeAcl in interface CmisObject

Returns:

the new ACL of this object

setAcl

public Acl setAcl(List<Ace> aces)

Description copied from interface: CmisObject

Removes the direct ACE of this object, sets the provided ACEs to the object and refreshes this object afterwards.

Specified by:

setAcl in interface CmisObject

Returns:

the new ACL of this object

getAcl

public Acl getAcl()

Description copied from interface: CmisObject

Returns the ACL if it has been fetched for this object.

Specified by:

getAcl in interface CmisObject

getPermissionsForPrincipal

public Set<String> getPermissionsForPrincipal(String principalId)

Description copied from interface: CmisObject

Returns all permissions for the given principal from the ACL.

Specified by:

getPermissionsForPrincipal in interface CmisObject

Parameters:

principalId - the principal ID, must not be null

Returns:

the set of permissions for this user, or an empty set if principal is not in the ACL

getPermissonsForPrincipal

public Set<String> getPermissonsForPrincipal(String principalId)

Specified by:

getPermissonsForPrincipal in interface CmisObject

applyPolicy

public void applyPolicy(ObjectId... policyIds)

Description copied from interface: CmisObject

Applies the provided policies and refreshes this object afterwards.

Specified by:

applyPolicy in interface CmisObject

Parameters:

policyIds - the IDs of the policies to be applied

removePolicy

public void removePolicy(ObjectId... policyIds)

Description copied from interface: CmisObject

Removes the provided policies and refreshes this object afterwards.

Specified by:

removePolicy in interface CmisObject

Parameters:

policyIds - the IDs of the policies to be removed

getPolicies

public List<Policy> getPolicies()

Description copied from interface: CmisObject

Returns the applied policies if they have been fetched for this object.

Specified by:

getPolicies in interface CmisObject

getRelationships

public List<Relationship> getRelationships()

Description copied from interface: CmisObject

Returns the relationships if they have been fetched for this object.

Specified by:

getRelationships in interface CmisObject

getExtensions

public List<CmisExtensionElement> getExtensions(ExtensionLevel level)

Description copied from interface: CmisObject

Returns the extensions for the given level.

Specified by:

getExtensions in interface CmisObject

Parameters:

level - the level

Returns:

the extensions at that level or null if there no extensions

getAdapter

public <T> T getAdapter(Class<T> adapterInterface)

Description copied from interface: CmisObject

Returns an adapter based on the given interface.

Specified by:

getAdapter in interface CmisObject

Returns:

an adapter object or null if no adapter object could be created

getRefreshTimestamp

public long getRefreshTimestamp()

Description copied from interface: CmisObject

Returns the timestamp of the last refresh.

Specified by:

getRefreshTimestamp in interface CmisObject

Returns:

the difference, measured in milliseconds, between the last refresh time and midnight, January 1, 1970 UTC.

refresh

public void refresh()

Description copied from interface: CmisObject

Reloads this object from the repository.

Specified by:

refresh in interface CmisObject

refreshIfOld

public void refreshIfOld(long durationInMillis)

Description copied from interface: CmisObject

Reloads the data from the repository if the last refresh did not occur within durationInMillis.

Specified by:

refreshIfOld in interface CmisObject

toString

public String toString()

Overrides:

toString in class Object