|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface ConnectionAdvisor
A ConnectionAdvisor provides services and configuration data for a
TFSConnection to use. A ConnectionAdvisor is provided to a
TFSConnection at construction time, and the TFSConnection
retains the ConnectionAdvisor instance for the lifetime of the
TFSConnection.
Any thread may call any of the ConnectionAdvisor methods.
TFSConnection allows only a single thread at a time to call a given
method. However, since a ConnectionAdvisor is passed to a
TFSConnection, controlling all concurrent usage to the
ConnectionAdvisor is outside the scope of the TFSConnection's
control. Implementations should document their thread safety, and clients who
use the implementations and create TFSConnections are responsible for
obeying the implementation's threading guidelines.
Each method receives a ConnectionInstanceData object. This object
encapsulates all of the instance configuration data that a
TFSConnection has. The return value of each method is cached by the
TFSConnection if the TFSConnection needs to use it in the
future.
TFSConnection,
ConnectionInstanceData| Method Detail |
|---|
java.util.TimeZone getTimeZone(ConnectionInstanceData instanceData)
TFSConnection the first time that the
TFSConnection's TimeZone is requested.
instanceData - the TFSConnection's instance data
TimeZone for the TFSConnection to use, never
nulljava.util.Locale getLocale(ConnectionInstanceData instanceData)
Called by the TFSConnection the first time that the
TFSConnection's Locale is requested.
This value will be sent to the server with web service requests to identify the client's preferred language and country (via the HTTP Accept-Language header). It is also used by core classes to compare strings, format output, etc., in the correct way for the current connection.
instanceData - the TFSConnection's instance data
Locale for the TFSConnection to use, never
nullPersistenceStoreProvider getPersistenceStoreProvider(ConnectionInstanceData instanceData)
TFSConnection the first time that the
TFSConnection's PersistenceStoreProvider is requested.
instanceData - the TFSConnection's instance data
PersistenceStoreProvider for the TFSConnection
to use, never nullHTTPClientFactory getHTTPClientFactory(ConnectionInstanceData instanceData)
TFSConnection the first time that the
TFSConnection's HttpClient is requested.
instanceData - the TFSConnection's instance data
HTTPClientFactory for the TFSConnection to use
(must not be null)ServerURIProvider getServerURIProvider(ConnectionInstanceData instanceData)
TFSConnection the first time that the
TFSConnection's server URI is requested.
instanceData - the TFSConnection's instance data
ServerURIProvider for the TFSConnection to use
(must not be null)WebServiceFactory getWebServiceFactory(ConnectionInstanceData instanceData)
TFSConnection the first time that a web service is
requested.
instanceData - the TFSConnection's instance data
WebServiceFactory for the TFSConnection to use
(must not be null)ClientFactory getClientFactory(ConnectionInstanceData instanceData)
TFSConnection the first time that a client is
requested.
instanceData - the TFSConnection's instance data
ClientFactory for the TFSConnection to use
(must not be null)TFProxyServerSettingsFactory getTFProxyServerSettingsFactory(ConnectionInstanceData instanceData)
TFSConnection the first time that the
TFSConnection's TFProxyServerSettings is requested.
instanceData - the TFSConnection's instance data (never null
)
TFProxyServerSettings object for the
TFSConnection to use, or null to not use a
TFS proxy server
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||