com.microsoft.tfs.core.clients.security
Interface ISecurityService

All Known Implementing Classes:
SecurityService

public interface ISecurityService

An interface for managing collections of security namespaces.


Method Summary
 SecurityNamespace createSecurityNamespace(SecurityNamespaceDescription description)
          Creates a SecurityNamespace that is based off of the provided information.
 boolean deleteSecurityNamespace(com.microsoft.tfs.util.GUID namespaceId)
          Deletes the SecurityNamespace from the collection of SecurityNamespaces.
 SecurityNamespace getSecurityNamespace(com.microsoft.tfs.util.GUID namespaceId)
          Returns the SecurityNamespace associated with this id.
 SecurityNamespace[] getSecurityNamespaces()
           
 

Method Detail

createSecurityNamespace

SecurityNamespace createSecurityNamespace(SecurityNamespaceDescription description)
                                          throws InvalidSecurityNamespaceDescriptionException,
                                                 SecurityNamespaceAlreadyExistsException
Creates a SecurityNamespace that is based off of the provided information.

Parameters:
description - The description to create the namespace from.
Returns:
the SecurityNamespace that was created
Throws:
InvalidSecurityNamespaceDescriptionException - if the SecurityNamespaceDescription does not pass validation for some reason
SecurityNamespaceAlreadyExistsException - if a SecurityNamespace already exists with id of the description passed in

deleteSecurityNamespace

boolean deleteSecurityNamespace(com.microsoft.tfs.util.GUID namespaceId)
Deletes the SecurityNamespace from the collection of SecurityNamespaces.

Parameters:
namespaceId - The id of the SecurityNamespace to delete
Returns:
True if something was deleted

getSecurityNamespace

SecurityNamespace getSecurityNamespace(com.microsoft.tfs.util.GUID namespaceId)
Returns the SecurityNamespace associated with this id. null is returned if a SecurityNamespace with this id does not exist.

Parameters:
namespaceId - The id for the SecurityNamespace desired
Returns:
SecurityNamespace associated with this id. null is returned if a SecurityNamespace with this id does not exist

getSecurityNamespaces

SecurityNamespace[] getSecurityNamespaces()
Returns:
An enumeration of all of the SecurityNamespaces that exist as a part of this Security Service.


© 2015 Microsoft. All rights reserved.