public interface IDfACL extends IDfPersistentObject
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ACCESSOR_NAME |
static java.lang.String |
ACCESSOR_PERMIT |
static java.lang.String |
ACCESSOR_XPERMIT |
static java.lang.String |
ACL_CLASS |
static java.lang.String |
ALIAS_SET_ID |
static java.lang.String |
APPLICATION_PERMIT |
static java.lang.String |
DESCRIPTION |
static int |
DF_PERMIT_BROWSE
Represents the Browse permission.
|
static java.lang.String |
DF_PERMIT_BROWSE_STR |
static int |
DF_PERMIT_DELETE
Represents the Delete permission.
|
static java.lang.String |
DF_PERMIT_DELETE_STR |
static int |
DF_PERMIT_NONE
Represents the None permission.
|
static java.lang.String |
DF_PERMIT_NONE_STR |
static int |
DF_PERMIT_NOTE_STR
Represents the Note permission.
|
static int |
DF_PERMIT_READ
Represents the Read permission.
|
static java.lang.String |
DF_PERMIT_READ_STR |
static int |
DF_PERMIT_RELATE
Represents the Relate permission.
|
static java.lang.String |
DF_PERMIT_RELATE_STR |
static int |
DF_PERMIT_VERSION
Represents the Version permission.
|
static java.lang.String |
DF_PERMIT_VERSION_STR |
static int |
DF_PERMIT_WRITE
Represents the Write permission.
|
static java.lang.String |
DF_PERMIT_WRITE_STR |
static java.lang.String |
DF_XPERMIT_CHANGE_FOLDER_LINKS_STR
Represent the extended permission to bypass folder security.
|
static java.lang.String |
DF_XPERMIT_CHANGE_LOCATION_STR
Represent the extended permission change location
|
static java.lang.String |
DF_XPERMIT_CHANGE_OWNER_STR
Represent the extended permission change owner
|
static java.lang.String |
DF_XPERMIT_CHANGE_PERMIT_STR
Represent the extended permission change permit
|
static java.lang.String |
DF_XPERMIT_CHANGE_STATE_STR
Represent the extended permission change state
|
static java.lang.String |
DF_XPERMIT_DELETE_OBJECT_STR
Represent the extended permission delete object
|
static java.lang.String |
DF_XPERMIT_EXECUTE_PROC_STR
Represent the extended permission execute procedure
|
static java.lang.String |
GLOBALLY_MANAGED |
static java.lang.String |
HAS_ACCESS_RESTRICTIONS |
static java.lang.String |
HAS_EVENTS |
static java.lang.String |
HAS_REQUIRED_GROUP_SET |
static java.lang.String |
HAS_REQUIRED_GROUPS |
static java.lang.String |
IS_GROUP |
static java.lang.String |
IS_INTERNAL |
static java.lang.String |
OBJECT_NAME |
static java.lang.String |
OWNER_NAME |
static java.lang.String |
PERMIT_TYPE |
static java.lang.String |
TEMPLATE_ID |
CURRENCY_CHECK_ALWAYS, CURRENCY_CHECK_FIRST_ACCESS, CURRENCY_CHECK_NEVER, CURRENCY_CHECK_ONCE_PER_SCOPE
Modifier and Type | Method and Description |
---|---|
void |
destroyACL(boolean force)
Removes an ACL object from a repository.
|
java.lang.String |
getAccessorApplicationPermit(int index)
Returns the application permit assigned to a user or group.
|
int |
getAccessorCount()
Returns the number of users and groups referenced in an ACL object.
|
java.lang.String |
getAccessorName(int index)
Returns the name of an individual user, group or alias in an ACL object.
|
int |
getAccessorPermit(int index)
Returns the basic permission level granted to a user or group.
|
int |
getAccessorPermitType(int index)
Identifies the type of permission granted an accessor in the ACL.
|
int |
getAccessorXPermit(int index)
Returns extended permissions granted to a user or group.
|
java.lang.String |
getAccessorXPermitNames(int index)
Returns the extended permissions in string form assigned to a user or group.
|
int |
getACLClass()
Returns the ACL class value.
|
java.lang.String |
getDescription()
Returns the user-defined description of an ACL object.
|
java.lang.String |
getDomain()
Returns the domain (owner name) of an ACL.
|
java.lang.String |
getObjectName()
Returns the ACL name.
|
IDfList |
getPermissions()
Returns a list of
DfPermit objects representing all the permissions specified in the ACL. |
int |
getPermit(java.lang.String accessorName)
Returns the basic permission level assigned to a user or group.
|
int |
getXPermit(java.lang.String accessorName)
Returns the extended permissions assigned to a user or group.
|
java.lang.String |
getXPermitList()
Returns a full list of the extended permissions, in string form, currently supported by the current server.
|
java.lang.String |
getXPermitNames(java.lang.String accessorName)
Returns the list of the extended permissions, in string form, for the specified user or group.
|
void |
grant(java.lang.String accessorName,
int accessorPermit,
java.lang.String extendedPermitNames)
Sets permissions for a user or group in an ACL object.
|
void |
grantPermit(IDfPermit permit)
Creates an access control entry in this object, assigning an access level to a specified user or group.
|
boolean |
hasPermission(java.lang.String permissionName,
java.lang.String accessorName)
Indicates whether a user or group has a specified extended permission.
|
boolean |
isGloballyManaged()
Indicates whether an ACL object is managed globally or locally.
|
boolean |
isGroup(int index)
Indicates if an accessor name in an ACL object is a group or a user.
|
boolean |
isInternal()
Indicates whether an ACL object was created explicitly by the user or implicitly by the server.
|
void |
revoke(java.lang.String accessorName,
java.lang.String extendedPermitNames)
Removes all extended permissions granted to a user or group in an ACL object
You must execute either the
save , saveAsNew , or checkin method to commit
the granted permission to a repository. |
void |
revokePermit(IDfPermit permit)
Removes specified permit from the acl.
|
IDfId |
saveAsNew()
Creates a new copy of the object. object is shared with the new object.
|
void |
setACLClass(int aclClass)
Sets the ACL class value.
|
void |
setDescription(java.lang.String description)
Sets the user-defined description of an ACL object.
|
void |
setDomain(java.lang.String domain)
Sets the domain (owner name) of an ACL object.
|
void |
setObjectName(java.lang.String name)
Sets the name of the ACL.
|
addChildRelative, addParentRelative, apiExec, apiGet, apiSet, destroy, fetch, fetchWithCaching, getAttrAssistance, getAttrAssistanceWithValues, getAttrAsstDependencies, getChildRelatives, getParentRelatives, getPartition, getType, getValidator, getVStamp, getWidgetType, isDeleted, isDirty, isInstanceOf, isNew, isReplica, lock, lockEx, registerEvent, removeChildRelative, removeParentRelative, revert, save, setPartition, signoff, unRegisterEvent, unRegisterEventEx, validateAllRules, validateAttrRules, validateAttrRulesWithValue, validateAttrRulesWithValues, validateObjRules, validateObjRulesWithValues
appendBoolean, appendDouble, appendId, appendInt, appendString, appendTime, appendValue, dump, enumAttrs, findAttrIndex, findBoolean, findDouble, findId, findInt, findString, findTime, findValue, getAllRepeatingStrings, getAttr, getAttrCount, getAttrDataType, getBoolean, getDouble, getId, getInt, getLong, getObjectId, getObjectSession, getOriginalSession, getRepeatingBoolean, getRepeatingDouble, getRepeatingId, getRepeatingInt, getRepeatingLong, getRepeatingString, getRepeatingTime, getRepeatingValue, getSession, getSessionManager, getString, getTime, getValue, getValueAt, getValueCount, hasAttr, insertBoolean, insertDouble, insertId, insertInt, insertString, insertTime, insertValue, isAttrRepeating, isNull, remove, removeAll, setBoolean, setDouble, setId, setInt, setNull, setRepeatingBoolean, setRepeatingDouble, setRepeatingId, setRepeatingInt, setRepeatingString, setRepeatingTime, setRepeatingValue, setSessionManager, setString, setTime, setValue, truncate
static final java.lang.String OBJECT_NAME
static final java.lang.String DESCRIPTION
static final java.lang.String OWNER_NAME
static final java.lang.String IS_INTERNAL
static final java.lang.String ACCESSOR_NAME
static final java.lang.String ACCESSOR_PERMIT
static final java.lang.String ACCESSOR_XPERMIT
static final java.lang.String IS_GROUP
static final java.lang.String GLOBALLY_MANAGED
static final java.lang.String ACL_CLASS
static final java.lang.String HAS_EVENTS
static final java.lang.String PERMIT_TYPE
static final java.lang.String APPLICATION_PERMIT
static final java.lang.String HAS_REQUIRED_GROUPS
static final java.lang.String HAS_REQUIRED_GROUP_SET
static final java.lang.String HAS_ACCESS_RESTRICTIONS
static final java.lang.String TEMPLATE_ID
static final java.lang.String ALIAS_SET_ID
static final int DF_PERMIT_NONE
static final java.lang.String DF_PERMIT_NONE_STR
static final int DF_PERMIT_BROWSE
static final java.lang.String DF_PERMIT_BROWSE_STR
static final int DF_PERMIT_READ
static final java.lang.String DF_PERMIT_READ_STR
static final int DF_PERMIT_NOTE_STR
static final int DF_PERMIT_RELATE
static final java.lang.String DF_PERMIT_RELATE_STR
static final int DF_PERMIT_VERSION
static final java.lang.String DF_PERMIT_VERSION_STR
static final int DF_PERMIT_WRITE
static final java.lang.String DF_PERMIT_WRITE_STR
static final int DF_PERMIT_DELETE
static final java.lang.String DF_PERMIT_DELETE_STR
static final java.lang.String DF_XPERMIT_EXECUTE_PROC_STR
static final java.lang.String DF_XPERMIT_CHANGE_LOCATION_STR
static final java.lang.String DF_XPERMIT_CHANGE_STATE_STR
static final java.lang.String DF_XPERMIT_CHANGE_PERMIT_STR
static final java.lang.String DF_XPERMIT_CHANGE_OWNER_STR
static final java.lang.String DF_XPERMIT_DELETE_OBJECT_STR
static final java.lang.String DF_XPERMIT_CHANGE_FOLDER_LINKS_STR
java.lang.String getObjectName() throws DfException
DfException
- if a server error occurssetObjectName(java.lang.String)
void setObjectName(java.lang.String name) throws DfException
name
- the name of the ACL objectDfException
- if a server error occursgetObjectName()
,
setDomain(java.lang.String)
java.lang.String getDescription() throws DfException
DfException
- if a server error occurssetDescription(java.lang.String)
void setDescription(java.lang.String description) throws DfException
description
- the user-defined description of the ACLDfException
- if a server error occursgetDescription()
java.lang.String getDomain() throws DfException
DfException
- if a server error occurssetDomain(java.lang.String)
void setDomain(java.lang.String domain) throws DfException
null
or "", "dm_dbo" is
used.domain
- the domain (owner name) of the ACL objectDfException
- if a server error occursgetDomain()
int getACLClass() throws DfException
DfException
- if a server error occurssetACLClass(int)
void setACLClass(int aclClass) throws DfException
aclClass
- the ACL class valueDfException
- if a server error occursgetACLClass()
boolean isInternal() throws DfException
true
if the ACL object was created implicitly by the server; false
if the ACL
object was created by the user.DfException
- if a server error occursboolean isGloballyManaged() throws DfException
true
if the ACL object is managed globally; false
if the ACL object is managed
locally.DfException
- if a server error occursboolean isGroup(int index) throws DfException
index
- the index position of the user or group among the ACL's accessorstrue
if the specified name is a group; false
if the specified name is a user.DfException
- if a server error occursgetAccessorCount()
,
getAccessorName(int)
int getAccessorCount() throws DfException
DfException
- if a server error occursgetAccessorName(int)
,
getAccessorPermit(int)
,
getAccessorXPermit(int)
,
getAccessorXPermitNames(int)
java.lang.String getAccessorName(int index) throws DfException
index
- the index position of the user or group among the ACL's accessorsDfException
- if a server error occursgetAccessorCount()
int getAccessorPermitType(int index) throws DfException
index
- the index position of the user or group among the ACL's accessors.IDfPermitType
.DfException
- if a server error occursgetAccessorCount()
int getAccessorPermit(int index) throws DfException
Value Field Constant 1 DF_PERMIT_NONE 2 DF_PERMIT_BROWSE 3 DF_PERMIT_READ 4 DF_PERMIT_RELATE or DF_PERMIT_NOTE 5 DF_PERMIT_VERSION 6 DF_PERMIT_WRITE 7 DF_PERMIT_DELETENote that DF_PERMIT_RELATE and DF_PERMIT_NOTE are synonymous. Refer to the Server Administrator's Guide for more information about basic permissions.
index
- the index position of the user or group among the ACL's accessors.DfException
- if a server error occursgetAccessorCount()
int getAccessorXPermit(int index) throws DfException
index
- the index position of the user or group among the ACL's accessors[20][19][18][17][16][15][14][13]12]11][10][9][8][7][6][5][4][3][2][1][0] Field 0: Execute Procedure 0 = have extended permission; 1 = don't have extended permission Field 1: Change Location 0 = have extended permission; 1 = don't have extended permission Fields 2-15: Reserved NA Field 16: Change State 1 = have extended permission; 0 = don't have extended permission Field 17: Change Permit 1 = have extended permission; 0 = don't have extended permission Field 18: Change Ownership 1 = have extended permission; 0 = don't have extended permission Field 19: Delete Object 1 = have extended permission; 0 = don't have extended permission Field 20: Change Folder Links 1 = have extended permission; 0 = don't have extended permission
DfException
- if a server error occursgetAccessorCount()
java.lang.String getAccessorXPermitNames(int index) throws DfException
EXECUTE_PROC CHANGE_LOCATION CHANGE_STATE CHANGE_PERMIT CHANGE_OWNER DELETE_OBJECT CHANGE_FOLDER_LINKS
index
- the index position of the user or group among the ACL's accessorsDfException
- if a server error occursgetAccessorCount()
,
getAccessorXPermit(int)
java.lang.String getAccessorApplicationPermit(int index) throws DfException
index
- the index position of the user or group among the ACL's accessorsDfException
- if a server error occursgetAccessorCount()
boolean hasPermission(java.lang.String permissionName, java.lang.String accessorName) throws DfException
permissionName
- the name of the extended permission attribute. Possible values are:
_allow_execute_proc _allow_change_location _allow_change_state _allow_change_owner _allow_change_permit _allow_change_folder_links
accessorName
- The name of the user or grouptrue
if the user or group has the specified extended permission; false
if the
user or group does not.DfException
- if a server error occursint getPermit(java.lang.String accessorName) throws DfException
accessorName
, the permissions of the current Documentum user
are returned.accessorName
- the name of the user or groupDfException
- if a server error occursgetXPermit(java.lang.String)
int getXPermit(java.lang.String accessorName) throws DfException
accessorName
, the extended permissions of the current
Documentum user are returned.
Remember, extended permissions are not cumulative, as are basic permissions. Refer to the Server
Administrator's Guide for more information about extended permissions.accessorName
- the name of the user or group[19][18][17][16][15][14][13]12]11][10][9][8][7][6][5][4][3][2][1][0] Field 0: Execute Procedure 0 = have extended permission; 1 = don't have extended permission Field 1: Change Location 0 = have extended permission; 1 = don't have extended permission Fields 2-15: Reserved NA Field 16: Change State 1 = have extended permission; 0 = don't have extended permission Field 17: Change Permit 1 = have extended permission; 0 = don't have extended permission Field 18: Change Ownership 1 = have extended permission; 0 = don't have extended permission Field 19: Delete Object 1 = have extended permission; 0 = don't have extended permission
DfException
- if a server error occursgetPermit(java.lang.String)
java.lang.String getXPermitNames(java.lang.String accessorName) throws DfException
accessorName
, the extended permissions of the current
Documentum user (logged in user) are returned. Refer to the Server Administrator's Guide for more
information about extended permissions.accessorName
- the name of the user or groupDfException
- if a server error occursgetXPermit(java.lang.String)
java.lang.String getXPermitList() throws DfException
DfException
- if a server error occursgetXPermitNames(java.lang.String)
void grant(java.lang.String accessorName, int accessorPermit, java.lang.String extendedPermitNames) throws DfException
save
, saveAsNew
, or
checkin
method to commit the granted permission to a repository. You must execute either
revert
, cancelCheckout
, or destory
method to discard changes made to an
ACL object.
Refer to the Server Administrator's Guide for more information about permissions.accessorName
- the name of the user or groupaccessorPermit
- the integer corresponding to the basic permission that you want to grant. The following
list specifies the integer corresponding to each basic permission. You may use either
the value or the field constant to set permissions. Note that DF_PERMIT_RELATE and
DF_PERMIT_NOTE are synonymous.
Value Field Constant 1 DF_PERMIT_NONE 2 DF_PERMIT_BROWSE 3 DF_PERMIT_READ 4 DF_PERMIT_RELATE, DF_PERMIT_NOTE 5 DF_PERMIT_VERSION 6 DF_PERMIT_WRITE 7 DF_PERMIT_DELETENote that DF_PERMIT_RELATE and DF_PERMIT_NOTE are synonymous.
extendedPermitNames
- the extended permission that you want to grant; if you specify null
for
this parameter then the server will supply default extended permissions which include
change location and execute procedure.DfException
- if a server error occursrevoke(java.lang.String, java.lang.String)
void grantPermit(IDfPermit permit) throws DfException
save
or a checkin
.DfException
- if a server error occurs.void revoke(java.lang.String accessorName, java.lang.String extendedPermitNames) throws DfException
save
, saveAsNew
, or checkin
method to commit
the granted permission to a repository. You must execute either revert
, cancelCheckout
,
or destory
method to discard changes made to an ACL object.
Refer to the Server Administrator's Guide for more information about permissions.accessorName
- the name of the user or groupextendedPermitNames
- the extended permissions that you want to revoke; If you do not want to revoke an
extended permission, specify null
for this parameter.DfException
- if a server error occursgrant(java.lang.String, int, java.lang.String)
void revokePermit(IDfPermit permit) throws DfException
save
or a
checkin
.DfException
- if a server error occurs.IDfList getPermissions() throws DfException
DfPermit
objects representing all the permissions specified in the ACL.DfException
- if a server error occursvoid destroyACL(boolean force) throws DfException
force
- indicates whether to destroy the ACL object even if it is referenced by other objects in the
repository. If so, enter true
; If not, enter false
.DfException
- if a server error occursIDfId saveAsNew() throws DfException
DfException
- if a server error occurs.Copyright 1994-2023 OpenText Corporation. All rights reserved.