com.microsoft.tfs.core.clients.framework
Interface ServerDataProvider

All Superinterfaces:
ILocationService
All Known Implementing Classes:
FrameworkServerDataProvider, LocationService, PreFrameworkServerDataProvider

public interface ServerDataProvider
extends ILocationService

Provides information about the server a TFSConnection is connected to. An abstraction of server identification; implementations exist for pre-TFS 2010 and post-TFS 2010 services which provide the actual data.

See Also:
FrameworkServerDataProvider, PreFrameworkServerDataProvider
Since:
TEE-SDK-10.1
Thread-safety:
thread-safe

Method Summary
 void authenticate()
           
 void connect(ConnectOptions connectOptions)
          Performs all of the steps that are necessary for setting up a connection with a Team Foundation Server.
 void ensureAuthenticated()
           
 java.lang.String findServerLocation(com.microsoft.tfs.util.GUID serverGUID)
          The function finds the location of the server that has the guid passed.
 TeamFoundationIdentity getAuthenticatedIdentity()
           
 TeamFoundationIdentity getAuthorizedIdentity()
           
 com.microsoft.tfs.util.GUID getCatalogResourceID()
           
 com.microsoft.tfs.util.GUID getInstanceID()
           
 ServerCapabilities getServerCapabilities()
          The capabilities of the TFS server.
 boolean hasAuthenticated()
           
 void reactToPossibleServerUpdate(int serverLastChangeId)
          Clears any caches that it has if the server has been updated.
 
Methods inherited from interface com.microsoft.tfs.core.clients.framework.location.ILocationService
configureAccessMapping, findServiceDefinition, findServiceDefinitions, findServiceDefinitionsByToolType, getAccessMapping, getClientAccessMapping, getConfiguredAccessMappings, getDefaultAccessMapping, locationForAccessMapping, locationForAccessMapping, locationForAccessMapping, locationForCurrentConnection, locationForCurrentConnection, removeAccessMapping, removeServiceDefinition, removeServiceDefinition, removeServiceDefinitions, saveServiceDefinition, saveServiceDefinitions, setDefaultAccessMapping
 

Method Detail

getInstanceID

com.microsoft.tfs.util.GUID getInstanceID()

getCatalogResourceID

com.microsoft.tfs.util.GUID getCatalogResourceID()

getAuthorizedIdentity

TeamFoundationIdentity getAuthorizedIdentity()

getAuthenticatedIdentity

TeamFoundationIdentity getAuthenticatedIdentity()

hasAuthenticated

boolean hasAuthenticated()

ensureAuthenticated

void ensureAuthenticated()

authenticate

void authenticate()

getServerCapabilities

ServerCapabilities getServerCapabilities()
The capabilities of the TFS server.


findServerLocation

java.lang.String findServerLocation(com.microsoft.tfs.util.GUID serverGUID)
The function finds the location of the server that has the guid passed. Note that the server in question must be a "child" server of the server this object is providing data for.

Parameters:
serverGUID - the GUID for the server we are looking up
Returns:
the location URI for the server with the provided GUID or null if this server does not have a child with the provided GUID

connect

void connect(ConnectOptions connectOptions)
Performs all of the steps that are necessary for setting up a connection with a Team Foundation Server. Specify what information should be returned in the connectOptions parameter. Each time this call is made the username for the current user will be returned as well as the client zone that this client is making requests from.

Parameters:
connectOptions - Specifies what information that should be returned from the server.

reactToPossibleServerUpdate

void reactToPossibleServerUpdate(int serverLastChangeId)
Clears any caches that it has if the server has been updated.



© 2015 Microsoft. All rights reserved.