com.microsoft.tfs.core.config.tfproxy
Interface TFProxyServerSettingsFactory

All Known Implementing Classes:
DefaultTFProxyServerSettingsFactory

public interface TFProxyServerSettingsFactory

An TFProxyServerSettingsFactory is used by a TFSTeamProjectCollection to obtain TF proxy server settings. An TFProxyServerSettingsFactory is supplied to a TFSTeamProjectCollection by a ConnectionAdvisor.

TFSTeamProjectCollection allows only a single thread to use a TFProxyServerSettingsFactory at a time.

For a default implementation, see DefaultTFProxyServerSettings.

See Also:
TFSTeamProjectCollection, ConnectionAdvisor, DefaultTFProxyServerSettings
Since:
TEE-SDK-10.1
Thread-safety:
thread-compatible

Method Summary
 void dispose(TFProxyServerSettings proxyServerSettings)
           Called to dispose a TFProxyServerSettings that was previously obtained from a call to newProxyServerSettings().
 TFProxyServerSettings newProxyServerSettings()
          Called to obtain TF proxy server settings.
 

Method Detail

newProxyServerSettings

TFProxyServerSettings newProxyServerSettings()
Called to obtain TF proxy server settings.

Returns:
a TFProxyServerSettings instance or null if there are no TF proxy server settings

dispose

void dispose(TFProxyServerSettings proxyServerSettings)

Called to dispose a TFProxyServerSettings that was previously obtained from a call to newProxyServerSettings().

This method is called by TFSConnection.close() to clean up any resources. It can be assumed that the specified TFProxyServerSettings instance will no longer be used after calling this method.

Parameters:
proxyServerSettings - an TFProxyServerSettings instance to dispose (must not be null)


© 2015 Microsoft. All rights reserved.