|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.microsoft.tfs.core.clients.webservices.IdentityManagementService
public class IdentityManagementService
A client for the TFS 2012 _IdentityManagementWebServiceSoap.
Unlike the VS implementation, it does not support pre-TFS 2010 servers.
| Constructor Summary | |
|---|---|
IdentityManagementService(TFSConnection connection)
|
|
| Method Summary | |
|---|---|
void |
addMemberToApplicationGroup(IdentityDescriptor groupDescriptor,
IdentityDescriptor descriptor)
Add member to TFS Group. |
IdentityDescriptor |
createApplicationGroup(java.lang.String projectUri,
java.lang.String groupName,
java.lang.String groupDescription)
Creates a TFS application group |
void |
deleteApplicationGroup(IdentityDescriptor groupDescriptor)
Deletes a TFS application group |
java.lang.String |
getIdentityDomainScope()
|
static java.lang.String |
getIdentityDomainScope(com.microsoft.tfs.util.GUID hostID)
|
java.lang.String |
getScopeName(java.lang.String scopeId)
Gets the scope name for the provided scope id. |
boolean |
isMember(IdentityDescriptor groupDescriptor,
IdentityDescriptor descriptor)
Expanded membership query for direct or nested member. |
boolean |
isOwnedWellKnownGroup(IdentityDescriptor descriptor)
Check if the given descriptor is of TeamFoundation type, belongs to this IMS host and is a well-known group. |
boolean |
isOwner(IdentityDescriptor descriptor)
Check if the given descriptor is of TeamFoundation type, and belongs to this IMS host. |
TeamFoundationIdentity[] |
listApplicationGroups(java.lang.String projectUri,
ReadIdentityOptions readOptions)
Lists all TFS application groups within the specified scope |
TeamFoundationIdentity[] |
readIdentities(com.microsoft.tfs.util.GUID[] teamFoundationIds,
MembershipQuery queryMembership)
Read identities by Team Foundation Id. |
TeamFoundationIdentity[] |
readIdentities(IdentityDescriptor[] descriptors,
MembershipQuery queryMembership,
ReadIdentityOptions readOptions)
Read identities for given descriptors. |
TeamFoundationIdentity[][] |
readIdentities(IdentitySearchFactor searchFactor,
java.lang.String[] factorValues,
MembershipQuery queryMembership,
ReadIdentityOptions readOptions)
Read identities based on search factor. |
TeamFoundationIdentity |
readIdentity(IdentityDescriptor descriptor,
MembershipQuery queryMembership,
ReadIdentityOptions readOptions)
Overload that takes a single descriptor. |
TeamFoundationIdentity |
readIdentity(IdentitySearchFactor searchFactor,
java.lang.String factorValue,
MembershipQuery queryMembership,
ReadIdentityOptions readOptions)
Overload that takes a single search factor and returns match following this order. |
boolean |
refreshIdentity(IdentityDescriptor descriptor)
Refresh identity properties from provider now. |
void |
removeMemberFromApplicationGroup(IdentityDescriptor groupDescriptor,
IdentityDescriptor descriptor)
Remove member from TFS Group. |
void |
updateApplicationGroup(IdentityDescriptor groupDescriptor,
GroupProperty property,
java.lang.String newValue)
Updates a property of a TFS application group |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public IdentityManagementService(TFSConnection connection)
| Method Detail |
|---|
public static java.lang.String getIdentityDomainScope(com.microsoft.tfs.util.GUID hostID)
public TeamFoundationIdentity[] readIdentities(IdentityDescriptor[] descriptors,
MembershipQuery queryMembership,
ReadIdentityOptions readOptions)
IIdentityManagementService
readIdentities in interface IIdentityManagementServicedescriptors - descriptors (descriptor is identity type + identifier)queryMembership - none, direct or expanded membership informationreadOptions - read options, such as reading from source
public TeamFoundationIdentity readIdentity(IdentityDescriptor descriptor,
MembershipQuery queryMembership,
ReadIdentityOptions readOptions)
IIdentityManagementService
readIdentity in interface IIdentityManagementServicedescriptor - identity type + identifierqueryMembership - none, direct or expanded membership informationreadOptions - read options, such as reading from source
public TeamFoundationIdentity[] readIdentities(com.microsoft.tfs.util.GUID[] teamFoundationIds,
MembershipQuery queryMembership)
IIdentityManagementService
readIdentities in interface IIdentityManagementServiceteamFoundationIds - identity idsqueryMembership - none, direct or expanded membership information
public TeamFoundationIdentity[][] readIdentities(IdentitySearchFactor searchFactor,
java.lang.String[] factorValues,
MembershipQuery queryMembership,
ReadIdentityOptions readOptions)
IIdentityManagementService
readIdentities in interface IIdentityManagementServicesearchFactor - how search is specified (by account name, etc.)factorValues - actual search strings (account names, etc.)queryMembership - none, direct or expanded membership informationreadOptions - readOptions, such as reading from source
public TeamFoundationIdentity readIdentity(IdentitySearchFactor searchFactor,
java.lang.String factorValue,
MembershipQuery queryMembership,
ReadIdentityOptions readOptions)
IIdentityManagementService
readIdentity in interface IIdentityManagementServicesearchFactor - how search is specified (by account name, etc.)factorValue - actual search string (account name, etc.)queryMembership - none, direct or expanded membership informationreadOptions - readOptions, such as reading from source
public IdentityDescriptor createApplicationGroup(java.lang.String projectUri,
java.lang.String groupName,
java.lang.String groupDescription)
IIdentityManagementService
createApplicationGroup in interface IIdentityManagementServiceprojectUri - Scope Uri, specifying whether group scope is project level or
global to this host. Null or empty value signifies global scopegroupName - namegroupDescription - description. can be null
public TeamFoundationIdentity[] listApplicationGroups(java.lang.String projectUri,
ReadIdentityOptions readOptions)
IIdentityManagementService
listApplicationGroups in interface IIdentityManagementServiceprojectUri - Scope Uri, specifying whether group scope is project level or
global to this host. Null or empty value signifies global scopereadOptions - read options
public java.lang.String getScopeName(java.lang.String scopeId)
IIdentityManagementService
getScopeName in interface IIdentityManagementServicescopeId - scope id, which is the project or domain Uri
public void updateApplicationGroup(IdentityDescriptor groupDescriptor,
GroupProperty property,
java.lang.String newValue)
IIdentityManagementService
updateApplicationGroup in interface IIdentityManagementServiceproperty - which property to updatenewValue - the new value for the propertypublic void deleteApplicationGroup(IdentityDescriptor groupDescriptor)
IIdentityManagementService
deleteApplicationGroup in interface IIdentityManagementServicegroupDescriptor - groupDescriptor
public void addMemberToApplicationGroup(IdentityDescriptor groupDescriptor,
IdentityDescriptor descriptor)
IIdentityManagementService
addMemberToApplicationGroup in interface IIdentityManagementServicegroupDescriptor - groupDescriptordescriptor - member
public void removeMemberFromApplicationGroup(IdentityDescriptor groupDescriptor,
IdentityDescriptor descriptor)
IIdentityManagementService
removeMemberFromApplicationGroup in interface IIdentityManagementServicegroupDescriptor - groupDescriptordescriptor - member
public boolean isMember(IdentityDescriptor groupDescriptor,
IdentityDescriptor descriptor)
IIdentityManagementService
isMember in interface IIdentityManagementServicegroupDescriptor - groupdescriptor - memberpublic boolean refreshIdentity(IdentityDescriptor descriptor)
IIdentityManagementServiceIdentity properties, such as display name, are synced from the provider over a 24h cylce, by default. Use this API to sync now.
refreshIdentity in interface IIdentityManagementServicedescriptor - identity specification. Null implies caller
public boolean isOwner(IdentityDescriptor descriptor)
IIdentityManagementService
isOwner in interface IIdentityManagementServicepublic boolean isOwnedWellKnownGroup(IdentityDescriptor descriptor)
IIdentityManagementService
isOwnedWellKnownGroup in interface IIdentityManagementServicepublic java.lang.String getIdentityDomainScope()
getIdentityDomainScope in interface IIdentityManagementService
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||