|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.microsoft.tfs.core.TFSConnection
com.microsoft.tfs.core.TFSConfigurationServer
public class TFSConfigurationServer
A connection to the configuration server area of a TFS 2010 or later installation.
TFSConnection
Nested Class Summary |
---|
Nested classes/interfaces inherited from class com.microsoft.tfs.core.TFSConnection |
---|
TFSConnection.HTTPClientReference |
Constructor Summary | |
---|---|
protected |
TFSConfigurationServer(java.net.URI serverURI,
java.util.concurrent.atomic.AtomicReference<Credentials> credentialsHolder,
ConnectionAdvisor advisor)
Package-protected constructor that allows TFSConfigurationServer
and TFSTeamProjectCollection s to share credentials (that may be
updated at any time) by way of an AtomicReference . |
|
TFSConfigurationServer(java.net.URI serverURI,
Credentials credentials)
A convenience constructor to create a TFSConfigurationServer from
a URI and Credentials . |
|
TFSConfigurationServer(java.net.URI serverURI,
Credentials credentials,
ConnectionAdvisor advisor)
The most complete way of creating a TFSConfigurationServer . |
Method Summary | |
---|---|
ICatalogService |
getCatalogService()
Gets the ICatalogService for this connection. |
TFSEntitySession |
getConfigurationSession(boolean refresh)
Gets the catalog service TFSEntitySession for this configuration
server. |
ILocationService |
getLocationService()
|
RegistrationClient |
getRegistrationClient()
The registration service is not available for a configuration server instance. |
ServerDataProvider |
getServerDataProvider()
Gets the ServerDataProvider for this connection. |
TeamFoundationServerEntity |
getTeamFoundationServerEntity(boolean refresh)
Gets the team ProjectCollectionEntity for this configuration
server. |
TFSTeamProjectCollection |
getTeamProjectCollection(com.microsoft.tfs.util.GUID collectionID)
Gets the TFSTeamProjectCollection for the specified ID. |
boolean |
hasAuthenticated()
Tests whether the connection has authenticated. |
void |
reactToPossibleServerUpdate(int locationServiceLastChangeId)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public TFSConfigurationServer(java.net.URI serverURI, Credentials credentials)
TFSConfigurationServer
from
a URI
and Credentials
. A default
ConnectionAdvisor
is used.
serverURI
- the URI
to connect to (must not be null
)credentials
- the Credentials
to connect withpublic TFSConfigurationServer(java.net.URI serverURI, Credentials credentials, ConnectionAdvisor advisor)
TFSConfigurationServer
. A
URI
, Credentials
and a ConnectionAdvisor
are
specified.
serverURI
- the URI
to connect to (must not be null
)credentials
- the Credentials
to connect withadvisor
- the ConnectionAdvisor
to use (must not be
null
)protected TFSConfigurationServer(java.net.URI serverURI, java.util.concurrent.atomic.AtomicReference<Credentials> credentialsHolder, ConnectionAdvisor advisor)
TFSConfigurationServer
and TFSTeamProjectCollection
s to share credentials (that may be
updated at any time) by way of an AtomicReference
.
serverURI
- the URI
to connect to (must not be null
)credentialsHolder
- an AtomicReference
to the Credentials
to connect
with (must not be null
)advisor
- the ConnectionAdvisor
to use (must not be
null
)Method Detail |
---|
public TFSTeamProjectCollection getTeamProjectCollection(com.microsoft.tfs.util.GUID collectionID)
TFSTeamProjectCollection
for the specified ID.
collectionID
- the collection's ID (must not be null
)
TFSTeamProjectCollection
that matches the ID, or
null
if no matching collection was foundpublic TFSEntitySession getConfigurationSession(boolean refresh)
TFSEntitySession
for this configuration
server.
refresh
- true
to force a refresh of the data from the server,
false
to use cached data
TFSEntitySession
for this configuration serverpublic TeamFoundationServerEntity getTeamFoundationServerEntity(boolean refresh)
ProjectCollectionEntity
for this configuration
server.
refresh
- true
to force a refresh of the data from the server,
false
to use cached data
null
if none could be
found (ie, pre-framework server.)public ServerDataProvider getServerDataProvider()
ServerDataProvider
for this connection.
Service discovery is often a slow process. Derived classes should cache the result of the first call to ensure subsequent calls to this method finish quickly.
getServerDataProvider
in class TFSConnection
ServerDataProvider
, which provides information about
the server this TFSConnection
is connected to (never
null
)public ICatalogService getCatalogService()
ICatalogService
for this connection. Derived classes
must implement this to support TFSConnection.getCatalogNode()
.
getCatalogService
in class TFSConnection
public boolean hasAuthenticated()
ServerDataProvider
has been initialized to make the test more
efficient.
hasAuthenticated
in class TFSConnection
true
if this connection has authenticated to the
server, false
if it has notpublic void reactToPossibleServerUpdate(int locationServiceLastChangeId)
public RegistrationClient getRegistrationClient()
null
if this kind of TFSConnection
doesn't support the registration service.
getRegistrationClient
in class TFSConnection
RegistrationClient
(possibly null
)public ILocationService getLocationService()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |