com.tsgrp.opencontent.dctm.core.permission

Class DCTMPermissionImpl

java.lang.Object

com.tsgrp.opencontent.dctm.core.permission.DCTMPermissionImpl

All Implemented Interfaces:

IPermission

Direct Known Subclasses:

DCTMPermissionQueryImpl

public class DCTMPermissionImpl
extends java.lang.Object
implements IPermission

Field Summary

Fields

Modifier and Type	Field and Description
protected static OCLogger	logger

Constructor Summary

Constructors

Constructor and Description
DCTMPermissionImpl()

Method Summary

Modifier and Type	Method and Description
boolean	canDelete(java.lang.String ticket, java.lang.String objectId) If a user can DELETE in the CMIS sense.
boolean	canGroupRead(java.lang.String ticket, java.lang.String objectId, java.lang.String groupName, boolean flatPermissionChecksOnly) If a group has READ access on a particular object
boolean	canRead(java.lang.String ticket, java.lang.String objectId) If a user can Read in the CMIS sense.
boolean	canReadContent(java.lang.String ticket, java.lang.String objectId) If a user can read the content of an object
boolean	canReadProperties(java.lang.String ticket, java.lang.String objectId) If a user can read the properties of an object
boolean	canRelate(java.lang.String ticket, java.lang.String objectId) If a user can relate an object, as a child, to this document.
boolean	canVersion(java.lang.String ticket, java.lang.String objectId) If a user can VERSION a document (not to be confused with WRITE).
boolean	canWrite(java.lang.String ticket, java.lang.String objectId) If a user can Write in the CMIS sense.
boolean	canWriteContent(java.lang.String ticket, java.lang.String objectId) If a user can Write content to an object.
boolean	canWriteProperties(java.lang.String ticket, java.lang.String objectId) If a user can Write properties of an object.
protected boolean	checkPermissions(java.lang.String ticket, java.lang.String objectId, int permissionType) Helper method to simplify asking for a particular type of permission
void	clearPermissions(java.lang.String ticket, java.lang.String objectId) Clears all permissions on the given object.
java.util.List<OCUser>	getUsersWithPermission(java.lang.String ticket, java.lang.String objectId, java.lang.String permission) Returns a list of OCUsers that have write permission on a specific document, based on groups that have permission on that node
boolean	hasAllPermissions(java.lang.String ticket, java.lang.String objectId) If a user has all permissions in the CMIS sense.
void	inheritPermissions(java.lang.String ticket, java.lang.String objectId) Inherit permissions from the parent
void	setPermissions(java.lang.String ticket, java.lang.String objectId, java.lang.String authority, java.lang.String permission) Additive - Adds new permissions to the object..

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static OCLogger logger

Constructor Detail

DCTMPermissionImpl

public DCTMPermissionImpl()

Method Detail

canRead

public boolean canRead(java.lang.String ticket,
                       java.lang.String objectId)

Description copied from interface: IPermission

If a user can Read in the CMIS sense. Can a User read properties AND content

Specified by:

canRead in interface IPermission

objectId - - string used to identify the object in question

Returns:

boolean if the user has the requested permission level

canReadProperties

public boolean canReadProperties(java.lang.String ticket,
                                 java.lang.String objectId)

Description copied from interface: IPermission

If a user can read the properties of an object

Specified by:

canReadProperties in interface IPermission

objectId - - string used to identify the object in question

Returns:

boolean if the user has the requested permission level

canReadContent

public boolean canReadContent(java.lang.String ticket,
                              java.lang.String objectId)

Description copied from interface: IPermission

If a user can read the content of an object

Specified by:

canReadContent in interface IPermission

objectId - - string used to identify the object in question

Returns:

boolean if the user has the requested permission level

canGroupRead

public boolean canGroupRead(java.lang.String ticket,
                            java.lang.String objectId,
                            java.lang.String groupName,
                            boolean flatPermissionChecksOnly)

Description copied from interface: IPermission

If a group has READ access on a particular object

Specified by:

canGroupRead in interface IPermission

objectId - - string used to identify the object in question

groupName - - string used to identify the group in question

flatPermissionChecksOnly - - boolean used as a flag for doing flat permission checks only

Returns:

boolean if the group has READ access

See Also:

com.tsgrp.opencontent.core.permission.IPermission#canGroupRead(java.lang.String, java.lang.String, java.lang.Boolean)

canRelate

public boolean canRelate(java.lang.String ticket,
                         java.lang.String objectId)

Description copied from interface: IPermission

If a user can relate an object, as a child, to this document. NOTE: Some implementations may permit more operations on a document when a user possesses relate permissions upon it. In particular, Documentum's RELATE permission is more expansive.

Specified by:

canRelate in interface IPermission

objectId - - string used to identify the object in question

Returns:

boolean if the user has the requested permission level

canVersion

public boolean canVersion(java.lang.String ticket,
                          java.lang.String objectId)

Description copied from interface: IPermission

If a user can VERSION a document (not to be confused with WRITE). Some implementations may not have a concept of "VERSION", so in those cases, we would expect it to return the same thing as the WRITE permission

Specified by:

canVersion in interface IPermission

objectId - - string used to identify the object in question

Returns:

boolean if the user has the requested permission level

canWrite

public boolean canWrite(java.lang.String ticket,
                        java.lang.String objectId)

Description copied from interface: IPermission

If a user can Write in the CMIS sense. Can a User write properties AND content

Specified by:

canWrite in interface IPermission

objectId - - string used to identify the object in question

Returns:

boolean if the user has the requested permission level

canWriteProperties

public boolean canWriteProperties(java.lang.String ticket,
                                  java.lang.String objectId)

Description copied from interface: IPermission

If a user can Write properties of an object.

Specified by:

canWriteProperties in interface IPermission

objectId - - string used to identify the object in question

Returns:

boolean if the user has the requested permission level

canWriteContent

public boolean canWriteContent(java.lang.String ticket,
                               java.lang.String objectId)

Description copied from interface: IPermission

If a user can Write content to an object.

Specified by:

canWriteContent in interface IPermission

objectId - - string used to identify the object in question

Returns:

boolean if the user has the requested permission level

canDelete

public boolean canDelete(java.lang.String ticket,
                         java.lang.String objectId)

Description copied from interface: IPermission

If a user can DELETE in the CMIS sense.

Specified by:

canDelete in interface IPermission

objectId - - string used to identify the object in question

Returns:

boolean if the user has the requested permission level

hasAllPermissions

public boolean hasAllPermissions(java.lang.String ticket,
                                 java.lang.String objectId)

Description copied from interface: IPermission

If a user has all permissions in the CMIS sense. Typically true of super user or coordinator role.

Specified by:

hasAllPermissions in interface IPermission

objectId - - string used to identify the object in question

Returns:

boolean if the user has the requested permission level

checkPermissions

protected boolean checkPermissions(java.lang.String ticket,
                                   java.lang.String objectId,
                                   int permissionType)

Helper method to simplify asking for a particular type of permission

Parameters:

ticket -

objectId -

permissionType - the IDfACL constant that represents the permission level we are looking for

Returns:

getUsersWithPermission

public java.util.List<OCUser> getUsersWithPermission(java.lang.String ticket,
                                                     java.lang.String objectId,
                                                     java.lang.String permission)

Description copied from interface: IPermission

Returns a list of OCUsers that have write permission on a specific document, based on groups that have permission on that node

Specified by:

getUsersWithPermission in interface IPermission

objectId - - string used to identify the object in question

permission - - permission level to grant users ex. OCConstants.PERMISSION_READ_PROPERTIES

Returns:

List of users that have write

clearPermissions

public void clearPermissions(java.lang.String ticket,
                             java.lang.String objectId)

Description copied from interface: IPermission

Clears all permissions on the given object.

Specified by:

clearPermissions in interface IPermission

objectId - - string used to identify the object in question

setPermissions

public void setPermissions(java.lang.String ticket,
                           java.lang.String objectId,
                           java.lang.String authority,
                           java.lang.String permission)

Description copied from interface: IPermission

Additive - Adds new permissions to the object..

Specified by:

setPermissions in interface IPermission

objectId - - string used to identify the object in question

authority - - string used to identify authority group or user

permission - - string used to identify security level allowed

inheritPermissions

public void inheritPermissions(java.lang.String ticket,
                               java.lang.String objectId)

Description copied from interface: IPermission

Inherit permissions from the parent

Specified by:

inheritPermissions in interface IPermission

objectId - - string used to identify the object in question