com.tsgrp.opencontent.core.permission

Interface IPermission

All Known Implementing Classes:

AlfrescoEmbPermissionImpl, DCTMPermissionImpl, DCTMPermissionQueryImpl, DynamoPermissionImpl, ElasticsearchPermissionImpl, HBasePermissionImpl, S3PermissionImpl, SolrPermissionImpl

public interface IPermission

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.
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..

Method Detail

canRead

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

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

Parameters:

ticket -

objectId - - string used to identify the object in question

Returns:

boolean if the user has the requested permission level

canReadProperties

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

If a user can read the properties of an object

Parameters:

ticket -

objectId - - string used to identify the object in question

Returns:

boolean if the user has the requested permission level

canReadContent

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

If a user can read the content of an object

Parameters:

ticket -

objectId - - string used to identify the object in question

Returns:

boolean if the user has the requested permission level

canGroupRead

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

Parameters:

ticket -

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

canVersion

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

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

Parameters:

ticket -

objectId - - string used to identify the object in question

Returns:

boolean if the user has the requested permission level

canRelate

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

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.

Parameters:

ticket -

objectId - - string used to identify the object in question

Returns:

boolean if the user has the requested permission level

canWrite

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

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

Parameters:

ticket -

objectId - - string used to identify the object in question

Returns:

boolean if the user has the requested permission level

canDelete

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

If a user can DELETE in the CMIS sense.

Parameters:

ticket -

objectId - - string used to identify the object in question

Returns:

boolean if the user has the requested permission level

canWriteProperties

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

If a user can Write properties of an object.

Parameters:

ticket -

objectId - - string used to identify the object in question

Returns:

boolean if the user has the requested permission level

canWriteContent

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

If a user can Write content to an object.

Parameters:

ticket -

objectId - - string used to identify the object in question

Returns:

boolean if the user has the requested permission level

hasAllPermissions

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

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

Parameters:

ticket -

objectId - - string used to identify the object in question

Returns:

boolean if the user has the requested permission level

getUsersWithPermission

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

Parameters:

ticket -

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

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

Clears all permissions on the given object.

Parameters:

ticket -

objectId - - string used to identify the object in question

setPermissions

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..

Parameters:

ticket -

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

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

Inherit permissions from the parent

Parameters:

ticket -

objectId - - string used to identify the object in question