|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.microsoft.tfs.core.internal.wrappers.WebServiceObjectWrapper
com.microsoft.tfs.core.clients.security.AccessControlList
public class AccessControlList
The AccessControlList class is meant to associate a set of AccessControlEntries with a security token and its inheritance settings. It is important to note that the AccessControlList class does not talk to a web service when its methods are called. It provides a staging area for changes to the AccessControlEntries for a secured token. Once changes are made to an AccessControlList it can be saved to the web service by passing it into a SecurityNamespace.
Field Summary |
---|
Fields inherited from class com.microsoft.tfs.core.internal.wrappers.WebServiceObjectWrapper |
---|
webServiceObject |
Constructor Summary | |
---|---|
AccessControlList(ms.ws._AccessControlList webServiceObject)
|
|
AccessControlList()
|
|
AccessControlList(AccessControlList existingList)
Builds an instance of an AccessControlList |
|
AccessControlList(java.lang.String token,
boolean inherit)
Creates a new AccessControlList |
|
AccessControlList(java.lang.String token,
boolean inherit,
AccessControlEntryDetails[] accessControlEntries)
Builds an instance of an AccessControlList |
Method Summary | |
---|---|
AccessControlEntryDetails[] |
getAccessControlEntries()
The list of AccessControlEntries that apply to this AccessControlList. |
java.lang.String |
getToken()
|
ms.ws._AccessControlList |
getWebServiceObject()
Gets the web service object this class wraps. |
boolean |
isIncludeExtendedInfoForAces()
|
boolean |
isInheritPermissions()
|
void |
loadAce(AccessControlEntryDetails ace)
|
AccessControlEntryDetails[] |
queryAccessControlEntries(IdentityDescriptor[] descriptors)
Returns the AccessControlEntries for the descriptors provided. |
AccessControlEntryDetails |
queryAccessControlEntry(IdentityDescriptor descriptor)
Returns the AccessControlEntry for the descriptor provided. |
boolean |
removeAccessControlEntry(IdentityDescriptor descriptor)
Removes the AccessControlEntry from this AccessControlList that applies to the given descriptor. |
AccessControlEntry |
removePermissions(IdentityDescriptor descriptor,
int permissionsToRemove)
Removes the specified permission bits from the existing allows and denys for this descriptor. |
AccessControlEntryDetails[] |
setAccessControlEntries(AccessControlEntryDetails[] accessControlEntryDetailsList,
boolean merge)
Sets the provided AccessControlEntry in this AccessControlList. |
AccessControlEntryDetails |
setAccessControlEntry(AccessControlEntryDetails accessControlEntry,
boolean merge)
Sets the provided AccessControlEntry in this AccessControlList. |
void |
setIncludeExtendedInfoForAces(boolean value)
|
void |
setInheritPermissions(boolean value)
|
AccessControlEntryDetails |
setPermissions(IdentityDescriptor descriptor,
int allow,
int deny,
java.lang.Boolean merge)
Sets a permission for the descriptor on this AccessControlList. |
void |
setToken(java.lang.String token)
|
Methods inherited from class com.microsoft.tfs.core.internal.wrappers.WebServiceObjectWrapper |
---|
equals, hashCode, toString |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public AccessControlList()
public AccessControlList(ms.ws._AccessControlList webServiceObject)
public AccessControlList(java.lang.String token, boolean inherit)
Creates a new AccessControlList
token
- The token that this AccessControlList is for.inherit
- True if this AccessControlList should inherit permissions from its
parents.public AccessControlList(java.lang.String token, boolean inherit, AccessControlEntryDetails[] accessControlEntries)
Builds an instance of an AccessControlList
token
- The token that this AccessControlList is for.inherit
- True if this AccessControlList should inherit permissions from its
parents.accessControlEntries
- The list of AccessControlEntries that apply to this
AccessControlList.public AccessControlList(AccessControlList existingList)
Builds an instance of an AccessControlList
existingList
- The AccessControlList to take its data from.Method Detail |
---|
public ms.ws._AccessControlList getWebServiceObject()
public boolean isInheritPermissions()
public void setInheritPermissions(boolean value)
public java.lang.String getToken()
public void setToken(java.lang.String token)
public AccessControlEntryDetails[] getAccessControlEntries()
public AccessControlEntry removePermissions(IdentityDescriptor descriptor, int permissionsToRemove)
Removes the specified permission bits from the existing allows and denys for this descriptor. If the descriptor is not found, nothing is done and an empty AccessControlEntry is returned.
descriptor
- The descriptor to remove the permissions from.permissionsToRemove
- The permission bits to remove.
public boolean removeAccessControlEntry(IdentityDescriptor descriptor)
Removes the AccessControlEntry from this AccessControlList that applies to the given descriptor.
descriptor
- The descriptor for for the AccessControlEntry to remove.
public AccessControlEntryDetails setPermissions(IdentityDescriptor descriptor, int allow, int deny, java.lang.Boolean merge)
Sets a permission for the descriptor on this AccessControlList.
descriptor
- The descriptor to set the permissions for.allow
- The allowed permissions to set.deny
- The denied permissions to set.merge
- If merge is true and a preexisting AccessControlEntry for the
descriptor is found the two AccessControlEntries will be merged.
When merging permissions in AccessControlEntries, if there is a
conflict, the new permissions will take precedence over the old
permissions. If merge is false and a preexisting
AccessControlEntry for the descriptor is found it will be dropped
and the passed in AccessControlEntry will be the only
AccessControlEntry that remains for this descriptor on this
AccessControlList.
public AccessControlEntryDetails setAccessControlEntry(AccessControlEntryDetails accessControlEntry, boolean merge)
Sets the provided AccessControlEntry in this AccessControlList.
accessControlEntry
- The AccessControlEntry to set in the AccessControlList.merge
- If merge is true and a preexisting AccessControlEntry for the
descriptor is found the two AccessControlEntries will be merged.
When merging permissions in AccessControlEntries, if there is a
conflict, the new permissions will take precedence over the old
permissions. If merge is false and a preexisting
AccessControlEntry for the descriptor is found it will be dropped
and the passed in AccessControlEntry will be the only
AccessControlEntry that remains for this descriptor on this
AccessControlList.
public AccessControlEntryDetails[] setAccessControlEntries(AccessControlEntryDetails[] accessControlEntryDetailsList, boolean merge)
Sets the provided AccessControlEntry in this AccessControlList.
accessControlEntryDetailsList
- The AccessControlEntries to set in the SecurityNamespace.merge
- If merge is true and a preexisting AccessControlEntry for the
descriptor is found the two AccessControlEntries will be merged.
When merging permissions in AccessControlEntries, if there is a
conflict, the new permissions will take precedence over the old
permissions. If merge is false and a preexisting
AccessControlEntry for the descriptor is found it will be dropped
and the passed in AccessControlEntry will be the only
AccessControlEntry that remains for this descriptor on this
AccessControlList.
public AccessControlEntryDetails queryAccessControlEntry(IdentityDescriptor descriptor)
Returns the AccessControlEntry for the descriptor provided. If no AccessControlEntry exists for the provided descriptor in this AccessControlList then an empty AccessControlEntry will be returned.
descriptor
- The descriptor to query the AccessControlEntry for. This cannot be
null.
public AccessControlEntryDetails[] queryAccessControlEntries(IdentityDescriptor[] descriptors)
Returns the AccessControlEntries for the descriptors provided.
descriptors
- The descriptors to query AccessControlEntries for. If null is
passed in for this, AccessControlEntries for all descriptors will
be returned.
public void loadAce(AccessControlEntryDetails ace)
public boolean isIncludeExtendedInfoForAces()
public void setIncludeExtendedInfoForAces(boolean value)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |