|
Oracle Content Services Web Services Java API Reference 10g Release 1 (10.1.2.3) B25584-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The security management interface.
Method Summary | |
Item |
addGrants(long id, NamedValue[] def, AttributeRequest[] attributes) Adds the specified grants to the SecurityConfiguration of the target item. |
boolean |
checkPermission(long target, long userOrGroup, long permission) Determines whether the given DirectoryObject has the given permission on the given target object. |
Item |
createRole(long target, NamedValue[] def, AttributeRequest[] attributes) Creates a new Role for use in the target domain. |
void |
deleteRole(long target, NamedValue[] def) Deletes a Role. |
Item |
findRoleByKey(java.lang.String key, AttributeRequest[] attributes) Fetches a single OOTB role by its registered role key. |
Item[] |
getComputedGranteeList(long target, long role, AttributeRequest[] attributes) Deprecated. 10.1.3.0.0 use getComputedUserGranteeList |
Item[] |
getComputedGroupGranteeList(long target, long role, AttributeRequest[] attributes) Returns the set of groups that are granted the specified role on the specified SecurityConfiguration. |
Item[] |
getComputedUserGranteeList(long target, long role, AttributeRequest[] attributes) Returns the set of users that are granted the specified role on the specified SecurityConfiguration. |
Item |
getRole(long id, AttributeRequest[] attributes) Fetches a single role |
Item |
getRoleByName(java.lang.String name, AttributeRequest[] attributes) Fetches a single role by its common name. |
boolean |
hasOnlyExplicitGrantedAccess(long target, long user) Returns true if the specified user has a grant on the specified public object that names the user as the grantee, and the permissions granted by this grant represent all the permissions of that user on the public object. |
boolean |
hasPropagatingGrants(long target, long user) Returns true if the specified user has any grants on the specified SecurityConfiguration that propagated from a parent. |
Item[] |
listRoles(long id, NamedValue[] options, AttributeRequest[] attributes) Returns the available security roles in the domain that apply to the given target object. |
Item[] |
listRolesByItemType(java.lang.String itemType, NamedValue[] options, AttributeRequest[] attributes) Returns the available security roles in the domain that apply to the given target object class. |
void |
removeSecurityConfiguration(long id) Removes the SecurityConfiguration from the target item. |
Item |
setSecurityConfiguration(long id, NamedValue[] def, AttributeRequest[] attributes) Updates the SecurityConfiguration of the target item. |
Item |
updateRole(long target, NamedValue[] def, AttributeRequest[] attributes) Updates a Role. |
Method Detail |
public Item getRole(long id, AttributeRequest[] attributes) throws FdkException
id
- Id of the role.attributes
- Additional attributes to be fetched.FdkException
- if the operation fails.public Item getRoleByName(java.lang.String name, AttributeRequest[] attributes) throws FdkException
Note that this method should not be used for pre-defined roles; use findRoleByKey
instead.
name
- Common name of the role.attributes
- Additional attributes to be fetched.FdkException
- if the operation fails.public Item findRoleByKey(java.lang.String key, AttributeRequest[] attributes) throws FdkException
key
- Registered role key of the role, which must match one of the ECM_ROLEKEY-prefixed strings in FdkConstants.attributes
- Additional attributes to be fetched.FdkException
- if the operation fails.public Item[] listRoles(long id, NamedValue[] options, AttributeRequest[] attributes) throws FdkException
id
- the id of the target objectoptions
- Options on the retrieved list. Valid options are:
attributes
- attributes to retrieve.FdkException
- if the operation fails.public Item[] listRolesByItemType(java.lang.String itemType, NamedValue[] options, AttributeRequest[] attributes) throws FdkException
itemType
- ItemTypes string representing these supported types:
options
- Options on the retrieved list. Valid options are:
attributes
- attributes to retrieve.FdkException
- if the operation fails.public Item createRole(long target, NamedValue[] def, AttributeRequest[] attributes) throws FdkException
target
- The ID of the target domain.def
- Attributes for the new role.
ClientUtils.getSupportedCapabilities()
. You can OR these capabilities to create an ACCESS_LEVEL.attributes
- requested attributes for each item, or null.FdkException
- if the operation fails.public void deleteRole(long target, NamedValue[] def) throws FdkException
target
- The ID of the target role.def
- Optional attributes.FdkException
- if the operation fails.public Item updateRole(long target, NamedValue[] def, AttributeRequest[] attributes) throws FdkException
target
- The ID of the target role.def
- New attributes for the role.
ClientUtils.getSupportedCapabilities()
. You can OR these capabilities to create an ACCESS_LEVEL.attributes
- the requested attributes for the itemFdkException
- if the operation fails.public Item setSecurityConfiguration(long id, NamedValue[] def, AttributeRequest[] attributes) throws FdkException
Note: to execute this operation asynchronously, specify the optional RUN_ASYNC
option with a value of Boolean.TRUE
.
The following restrictions are enforced for Attributes.GRANT
id
- The ID of the target objectdef
- Attributes for the securityconfiguration.
attributes
- requested attributes for each item, or null.FdkException
- if the operation fails.public Item addGrants(long id, NamedValue[] def, AttributeRequest[] attributes) throws FdkException
Note: to execute this operation asynchronously, specify the optional RUN_ASYNC
option with a value of Boolean.TRUE
.
id
- The ID of the target objectdef
- Attributes for the securityconfiguration.
attributes
- requested attributes for each item, or null.FdkException
- if the operation fails.public void removeSecurityConfiguration(long id) throws FdkException
id
- The ID of the target itemFdkException
- if the operation fails.public boolean checkPermission(long target, long userOrGroup, long permission) throws FdkException
target
- The ID of the target PublicObject.userOrGroup
- The ID of the DirectoryObject.permission
- The long (bit value) representing the permission bit.FdkException
- if the operation fails.public Item[] getComputedGranteeList(long target, long role, AttributeRequest[] attributes) throws FdkException
getComputedUserGranteeList
target
- The ID of the target security configuration.role
- The ID of the role.attributes
- Attributes on the users to retrieve.FdkException
- if the operation fails.public Item[] getComputedUserGranteeList(long target, long role, AttributeRequest[] attributes) throws FdkException
target
- The ID of the target security configuration.role
- The ID of the role.attributes
- Attributes on the users to retrieve.FdkException
- if the operation fails.public Item[] getComputedGroupGranteeList(long target, long role, AttributeRequest[] attributes) throws FdkException
target
- The ID of the target security configuration.role
- The ID of the role.attributes
- Attributes on the groups to retrieve.FdkException
- if the operation fails.public boolean hasPropagatingGrants(long target, long user) throws FdkException
target
- The ID of the target SecurityConfiguration.user
- The ID of the desired user.FdkException
- if the operation fails.public boolean hasOnlyExplicitGrantedAccess(long target, long user) throws FdkException
target
- The ID of the target SecurityConfiguration.user
- The ID of the desired user.FdkException
- if the operation fails.
|
Oracle Content Services Web Services Java API Reference 10g Release 1 (10.1.2.3) B25584-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |