|
Project: stp | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface StpAccessControlledResource
The interface implemented by resources that support access control lists
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface com.ibm.rational.wvcm.stp.StpResource |
---|
StpResource.UnsupportedProperty |
Nested classes/interfaces inherited from interface javax.wvcm.Resource |
---|
Resource.CopyFlag |
Field Summary | |
---|---|
static PropertyNameList.PropertyName<StpAccessControlEntry> |
ACCESS_RIGHTS
The effective access rights granted the current user to this resource |
static PropertyNameList.PropertyName<List<StpAccessControlEntry>> |
APPLIED_ACCESS_CONTROL_ENTRIES
A list of the access control entries applied directly to this resource. |
static PropertyNameList.PropertyName<Boolean> |
CAN_CHANGE_ACCESS_RIGHTS
A Boolean indicating whether or not the session user is allowed to change the access rights on this resource. |
static PropertyNameList.PropertyName<List<StpAccessControlEntry>> |
EFFECTIVE_ACCESS_CONTROL_ENTRIES
A list of the access control entries in effect on this resource for all principals known to the user. |
static PropertyNameList.PropertyName<List<StpAccessControlEntry>> |
POSSIBLE_ACCESS_RIGHTS
A list of access control entries each representing an access right that could be applied to this resource. |
Fields inherited from interface com.ibm.rational.wvcm.stp.StpResource |
---|
ALL_PROPERTIES, AUTHENTICATION_REALM, CREATOR_GROUP_NAME, CREATOR_LOGIN_NAME, EFFICIENT_LOCATION, INVALID_PROPERTIES, REPOSITORY, STABLE_LOCATION, USER_FRIENDLY_LOCATION |
Fields inherited from interface javax.wvcm.Resource |
---|
ALL_CUSTOM_PROPERTIES, COMMENT, CONTENT_CHARACTER_SET, CONTENT_IDENTIFIER, CONTENT_LANGUAGE, CONTENT_LENGTH, CONTENT_TYPE, CREATION_DATE, CREATOR_DISPLAY_NAME, DISPLAY_NAME, IS_EXECUTABLE, LAST_MODIFIED, PARENT_LIST, PATHNAME_LOCATION, PROVIDER_LIST, RESOURCE_IDENTIFIER, WORKSPACE_FOLDER_LIST |
Method Summary | |
---|---|
StpAccessControlEntry |
getAccessRights()
Returns the value of the ACCESS_RIGHTS property as
defined by this proxy. |
List<StpAccessControlEntry> |
getAppliedAccessControlEntries()
Returns the value of the APPLIED_ACCESS_CONTROL_ENTRIES
property as defined by this proxy. |
boolean |
getCanChangeAccessRights()
Returns the value of the CAN_CHANGE_ACCESS_RIGHTS property as
defined by this proxy. |
List<StpAccessControlEntry> |
getEffectiveAccessControlEntries()
Returns the value of the EFFECTIVE_ACCESS_CONTROL_ENTRIES
property as defined by this proxy. |
List<StpAccessControlEntry> |
getPossibleAccessRights()
Returns the value of the POSSIBLE_ACCESS_RIGHTS property as
defined by this proxy. |
void |
setAppliedAccessControlEntries(List<StpAccessControlEntry> value)
Defines a new value for the APPLIED_ACCESS_CONTROL_ENTRIES
property of this proxy. |
void |
setAppliedAccessControlEntries(List<StpAccessControlEntry> additions,
List<StpAccessControlEntry> deletions)
Defines modifications to be made to the APPLIED_ACCESS_CONTROL_ENTRIES
property of the resource referenced by this proxy. |
Methods inherited from interface com.ibm.rational.wvcm.stp.StpResource |
---|
doReadProperties, equals, getAllProperties, getAuthenticationRealm, getCreatorGroupName, getCreatorLoginName, getCustomProperties, getEfficientLocation, getInvalidProperties, getMetaProperties, getPropertyException, getRepository, getResourceError, getResourceIdentifier, getStableLocation, getUserFriendlyLocation, hashCode, hasProperties, initMetaProperty, proxyType, setPropertyClean, stpLocation, stpProvider |
Field Detail |
---|
static final PropertyNameList.PropertyName<StpAccessControlEntry> ACCESS_RIGHTS
static final PropertyNameList.PropertyName<List<StpAccessControlEntry>> APPLIED_ACCESS_CONTROL_ENTRIES
static final PropertyNameList.PropertyName<Boolean> CAN_CHANGE_ACCESS_RIGHTS
static final PropertyNameList.PropertyName<List<StpAccessControlEntry>> EFFECTIVE_ACCESS_CONTROL_ENTRIES
static final PropertyNameList.PropertyName<List<StpAccessControlEntry>> POSSIBLE_ACCESS_RIGHTS
Method Detail |
---|
StpAccessControlEntry getAccessRights() throws WvcmException
ACCESS_RIGHTS
property as
defined by this proxy.
WvcmException
- if this proxy does not define a value for the
ACCESS_RIGHTS
property.List<StpAccessControlEntry> getAppliedAccessControlEntries() throws WvcmException
APPLIED_ACCESS_CONTROL_ENTRIES
property as defined by this proxy.
WvcmException
- if this proxy does not define a value for the
APPLIED_ACCESS_CONTROL_ENTRIES
property.boolean getCanChangeAccessRights() throws WvcmException
CAN_CHANGE_ACCESS_RIGHTS
property as
defined by this proxy.
WvcmException
- if this proxy does not define a value for the
CAN_CHANGE_ACCESS_RIGHTS
property.List<StpAccessControlEntry> getEffectiveAccessControlEntries() throws WvcmException
EFFECTIVE_ACCESS_CONTROL_ENTRIES
property as defined by this proxy.
WvcmException
- if this proxy does not define a value for the
EFFECTIVE_ACCESS_CONTROL_ENTRIES
property.List<StpAccessControlEntry> getPossibleAccessRights() throws WvcmException
POSSIBLE_ACCESS_RIGHTS
property as
defined by this proxy.
WvcmException
- if this proxy does not define a value for the
POSSIBLE_ACCESS_RIGHTS
property.void setAppliedAccessControlEntries(List<StpAccessControlEntry> value)
APPLIED_ACCESS_CONTROL_ENTRIES
property of this proxy.
Set new access control entries for the resource. The specified access control entries replace all existing entries for "visible" principals already set on the folder. This operation affects only the principals the user can see, so it may only affect a subset of the full set of access control entries on the resource.
value
- A List of StpAccessControlEntry instances specifying the new
value of the access control list. Only the principal and
access rights of each access control entry are significant.
The type, controlled resource and applied resource fields of
these access control entries are ignored (the effective values
being APPLIED and this resource, respectively).void setAppliedAccessControlEntries(List<StpAccessControlEntry> additions, List<StpAccessControlEntry> deletions)
APPLIED_ACCESS_CONTROL_ENTRIES
property of the resource referenced by this proxy.
additions
- Access control entries to be added to those already set
on the resource; does not add duplicates, and does not produce
an error if there are duplicates. An entry on this list
replaces any existing entry for the same principal. Does not
add an access control entry for a principal the user is not a
member of, unless the user also has the Security Administrator
privilege.deletions
- All access control entries in this list that match any
visible entries on the resource are removed from the respource;
matching does not consider the access rights or controlled
resource fields.
|
Generated Tue 14-Jul-2015 08:49 PM | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |