|
Project: stp | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface StpAccessControlEntry
The interface for an entry in a resource's access control list. Each access control entry denotes access rights to a specific resource granted to one or more principals (denoted by a group, user, or role).
In addition, each StpAccessControlEntry instance returned by this API specifies whether the entry represents an access right applied directly to the resource or an access right derived from access rights applied to one or more related resources. In most cases, the resource to which the effective access right is actually applied is also included in the StpAccessControlEntry returned from the API.
To add an access control entry to a resource an instance of
StpAccessControlEntry is required. It can be constructed using
StpProvider.buildAccessControlEntry(StpPrincipal, com.ibm.rational.wvcm.stp.StpAccessControlEntry.AccessRight[])
if the access right is known a priori or by requesting the
StpAccessControlledResource.POSSIBLE_ACCESS_RIGHTS
property and selecting one of
those. When adding an access control entry to a resource, only the access
rights and principal fields of the StpAccessControlEntry object are
significant.
Resources that may have access control lists applied them implement the
StpAccessControlledResource
interface.
Resources that represent entities to which access rights may be granted
implement the StpPrincipal
interface.
Nested Class Summary | |
---|---|
static class |
StpAccessControlEntry.AccessRight
An enumeration of the possible access rights that can be applied to a controlled resource. |
static class |
StpAccessControlEntry.EntryType
An enumeration of the type of permission being reported |
Method Summary | |
---|---|
boolean |
allowsRead()
|
boolean |
allowsWrite()
|
StpAccessControlEntry.AccessRight[] |
getAccessRights()
|
StpAccessControlledResource |
getAppliedResource()
|
StpAccessControlledResource |
getControlledResource()
|
StpAccessControlEntry.EntryType |
getEntryType()
|
StpPrincipal |
getPrincipal()
|
void |
setAccessRights(StpAccessControlEntry.AccessRight... accessRights)
Defines a new value for the access rights granted by this entry. |
void |
setControlledResource(StpAccessControlledResource controlledResource)
Assigns a new value to the controlled resource of this entry. |
void |
setPrincipal(StpPrincipal principal)
Assigns a new value for the principal of this access control entry. |
Method Detail |
---|
boolean allowsRead()
boolean allowsWrite()
StpAccessControlEntry.AccessRight[] getAccessRights()
StpAccessControlledResource getAppliedResource()
StpAccessControlledResource getControlledResource()
StpAccessControlEntry.EntryType getEntryType()
StpPrincipal getPrincipal()
void setAccessRights(StpAccessControlEntry.AccessRight... accessRights)
accessRights
- An array of access right instances specifying the
access rights granted by this entry; must not be null
or empty.void setControlledResource(StpAccessControlledResource controlledResource)
controlledResource
- An StpResource proxy specifying the resource to
be controlled by this entry. Not all resource types can be
controlled by an access control list.void setPrincipal(StpPrincipal principal)
principal
- An StpResource proxy specifying the group, user, or role
identifying the principals granted access rights by this
entry. Not all resources accept all types of principals.
|
Generated Wed 16-Apr-2014 05:20 PM | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |