|
||||||||||
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.TFSTeamProjectCollection
public class TFSTeamProjectCollection
A connection to a team project collection in a TFS 2010 or later server, or to the entire service area of a TFS 2005 or TFS 2008 server.
TFSConnection
Nested Class Summary |
---|
Nested classes/interfaces inherited from class com.microsoft.tfs.core.TFSConnection |
---|
TFSConnection.HTTPClientReference |
Constructor Summary | |
---|---|
protected |
TFSTeamProjectCollection(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 . |
|
TFSTeamProjectCollection(java.net.URI serverURI,
Credentials credentials)
A convenience constructor to create a TFSTeamProjectCollection
from a URI . |
|
TFSTeamProjectCollection(java.net.URI serverURI,
Credentials credentials,
ConnectionAdvisor advisor)
The most complete way of creating a TFSTeamProjectCollection . |
Method Summary | |
---|---|
IBuildServer |
getBuildServer()
A convenience method to get the Build service client from this TFSConnection . |
protected ICatalogService |
getCatalogService()
Gets the ICatalogService for this connection. |
ILocationService |
getCollectionLocationService()
|
CommonStructureClient |
getCommonStructureClient()
A convenience method to get the common structure service client from this TFSConnection . |
TFSConfigurationServer |
getConfigurationServer()
|
TFSEntitySession |
getConfigurationSession(boolean refresh)
Gets the catalog service TFSEntitySession for this team project
collection. |
RegistrationClient |
getRegistrationClient()
Convenience method to get the registration client for this connection. |
ServerDataProvider |
getServerDataProvider()
Gets the ServerDataProvider for this connection. |
SourceControlCapabilityFlags |
getSourceControlCapability(ProjectInfo project)
|
ProjectCollectionEntity |
getTeamProjectCollectionEntity(boolean refresh)
Gets the team ProjectCollectionEntity for this collection. |
VersionControlClient |
getVersionControlClient()
A convenience method to get the version control client from this TFSConnection . |
WorkItemClient |
getWorkItemClient()
A convenience method to get the WIT client from this TFSConnection . |
boolean |
hasAuthenticated()
Tests whether the connection has authenticated. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public TFSTeamProjectCollection(java.net.URI serverURI, Credentials credentials)
TFSTeamProjectCollection
from a URI
. A default ConnectionAdvisor
is used.
uri
- the URI
to use to connect (must not be null
)credentials
- the Credentials
to connect with (or null
to
attempt to use the best available credentials)public TFSTeamProjectCollection(java.net.URI serverURI, Credentials credentials, ConnectionAdvisor advisor)
TFSTeamProjectCollection
. A
URI
, Credentials
and a ConnectionAdvisor
are
specified.
serverURI
- the URI
to connect to (must not be null
)credentials
- the Credentials
to connect with (or null
to
attempt to use the best available credentials)advisor
- the ConnectionAdvisor
to use (must not be
null
)protected TFSTeamProjectCollection(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 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
)protected ICatalogService getCatalogService()
ICatalogService
for this connection. Derived classes
must implement this to support TFSConnection.getCatalogNode()
.
getCatalogService
in class TFSConnection
public TFSConfigurationServer getConfigurationServer()
public ILocationService getCollectionLocationService()
public TFSEntitySession getConfigurationSession(boolean refresh)
TFSEntitySession
for this team project
collection.
refresh
- true
to force a refresh of the data from the server,
false
to use cached data
TFSEntitySession
for this project collectionpublic ProjectCollectionEntity getTeamProjectCollectionEntity(boolean refresh)
ProjectCollectionEntity
for this collection.
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 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 RegistrationClient getRegistrationClient()
null
if this kind of TFSConnection
doesn't support the registration service.
getRegistrationClient
in class TFSConnection
RegistrationClient
(possibly null
)public VersionControlClient getVersionControlClient()
TFSConnection
.
VersionControlClient
public WorkItemClient getWorkItemClient()
TFSConnection
.
WorkItemClient
public IBuildServer getBuildServer()
TFSConnection
.
BuildClient
which implements IBuildServer
public CommonStructureClient getCommonStructureClient()
TFSConnection
.
CommonStructureClient
public SourceControlCapabilityFlags getSourceControlCapability(ProjectInfo project)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |