ServerConfiguration (StarTeam SDK Documentation)

java.lang.Object
- com.starteam.ServerConfiguration

```
public final class ServerConfiguration
extends java.lang.Object
```
Describes Configuration Properties of the connected StarTeam server

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ServerConfiguration.AuthenticationType` AuthenticationType used by the server
`static class`	`ServerConfiguration.DatabaseType` Database type used by the server
`static class`	`ServerConfiguration.DirectoryServiceSecurityType` Security type used while connecting to Directory service.
`static class`	`ServerConfiguration.NotificationType` Notification type used by the server
`static class`	`ServerConfiguration.WebCacheServerConfiguration` Server Configurations exposed via the Web Cache Object Model

Field Summary

Fields
Modifier and Type Field and Description

static int PROTOCOL_TCP_IP_SOCKETS
The TCP/IP (Sockets) Protocol.

Fields
Modifier and Type	Field and Description
`static int`	`PROTOCOL_TCP_IP_SOCKETS` The TCP/IP (Sockets) Protocol.

Constructor Summary

Constructors
Constructor and Description

ServerConfiguration(ServerConfiguration source)
construct a new ServerConfiguration from the source

Constructors
Constructor and Description
`ServerConfiguration(ServerConfiguration source)` construct a new ServerConfiguration from the source

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ServerConfiguration`	`copy()` return a copy of this ServerConfiguration instance
`java.lang.String`	`getAlmServiceUrl()` The location of the ALM Trace Service, if available.
`java.lang.String`	`getArchiveDirectory()` Returns the path to the server's archive directory.
`java.lang.String`	`getAttachmentDirectory()` Returns the path to the server's attachment directory.
`int`	`getAuditsAutoPurgeDays()` Returns the number of days after which audit information is purged from the server.
`boolean`	`getAuditsEnabled()` Indicates whether or not auditing is enabled on the server.
`java.lang.String`	`getCacheDirectory()` Returns the path to the server's vault directory.
`boolean`	`getCheckoutUseRevisionFileName()` returns true if files with different names at older revisions need to be checked out using the old file name
`java.lang.String`	`getCipher()` Returns the server's cipher string.
`boolean`	`getCreateCheckinChangePackage()` Returns true if checkin change packages should be created by the SDK
`boolean`	`getDBAutoRecovery()` Indicates whether or not the server automatically recovers from errors.
`int`	`getDBPooledConnections()` Returns the number of pooled connections to the server database.
`java.lang.String`	`getDBPort()` Returns the port number that the Starteam server database is connected to.
`java.lang.String`	`getDBServerName()` Returns the database server name
`java.lang.String`	`getDBServiceName()` For an Oracle configuration, returns the service name for the database that the StarTeam server is connected to.
`java.lang.String`	`getDBSid()` For an Oracle configuration, returns the Sid for the database that the StarTeam server is connected to.
`boolean`	`getDBTransactionsEnabled()` Indicates whether or not database transactions are enabled.
`ServerConfiguration.DatabaseType`	`getDBType()` Returns the server database type.
`boolean`	`getDBVerifyOnStartup()` Indicates whether or not the server database is verified on startup.
`java.lang.String[]`	`getDefaultBinaryExtensions()` Returns the set of extensions which will be automatically treated as Binary Types by the StarTeam checkin engine.
`int`	`getDiagnosticStatisticsReportingInterval()` Determines the frequency with which the server reports diagnostic statistics.
`boolean`	`getDirectoryServiceEnabled()` Indicates whether Directory Service is enabled on this server.
`java.lang.String`	`getDirectoryServiceHost()` Gets the URL to the Directory Service Host, if Directory Service is enabled.
`int`	`getDirectoryServicePort()` Gets the SSL port used by Directory Service, if Directory Service is enabled.
`ServerConfiguration.DirectoryServiceSecurityType`	`getDirectoryServiceSecurityType()`
`boolean`	`getDisableCustomTools()` returns true if custom tools can be disabled, false otherwise this feature was introduced with the 14.0 server
`boolean`	`getDumpAsserts()` Returns whether the server will create a diagnostic dump when unexpected conditions [i.e., asserts] are discovered.
`boolean`	`getDumpErrors()` Returns whether the server will create a diagnostic dump when errors are discovered.
`int`	`getDumpType()` Returns the mini dump type used for diagnostic dumps
`boolean`	`getEnabled(int protocol)` Returns true if the specified protocol is enabled.
`boolean`	`getEnableDiagnostics()` Indicates whether or not server diagnostics are enabled.
`java.lang.Boolean`	`getEnableSDKWorkflow()` Returns TRUE if SDK Workflow should be turned ON automatically within the SDK, the Command Line etc.
`IPRange[]`	`getEncryptionRequirements()` Returns the required encryption levels for various ranges of TCP/IP addresses.
`java.lang.String`	`getEndPoint(int protocol)` Returns the endpoint for the specified protocol.
`int`	`getExpensiveOperationMinimum()` Returns the minimum number of milliseconds used to determine what is an expensive operation for tracing purposes.
`GUID`	`getFederatedTraceServer()` Returns the GUID corresponding to a Server used to store only Traces in a multi configuration StarTeam environment
`int`	`getFileStatusAutoPurgeDays()` Returns the number of days after which a file's status information will be purged.
`int`	`getInactivityTimeout()` Returns the server's inactivity timeout.
`java.lang.String`	`getLogFile()` Returns the path to the server's log file.
`int`	`getLogonTimeout()` Returns the server's logon timeout.
`boolean`	`getMailEnabled()` Indicates whether or not email is enabled on the server.
`java.lang.String`	`getMultiPartDirectory()` Returns the path to the server's multi-part directory.
`DateTime`	`getNotificationEndTime()` return the notification end time
`java.lang.String`	`getNotificationMessage()` get a configured notification message
`DateTime`	`getNotificationStartTime()` return the notification start time
`ServerConfiguration.NotificationType`	`getNotifyBy()` Gets the method by which notification messages are sent to StarTeam users.
`boolean`	`getNoTimeoutNamedLicenses()` Gets the server's "NoTimeoutNamedLicenses" setting for servers 7.0 and later.
`java.lang.String`	`getOauth2ClientID()` Gets the Oauth2 client id.
`java.lang.String`	`getOauth2IssuerURL()` Gets the Oauth2 Issuer URL configured.
`java.lang.String`	`getOauth2RedirectURI()` Gets the Oauth2 redirect URI configured.
`int`	`getReconnectTimeout()` Gets the server's reconnect timeout.
`java.lang.String`	`getRepositoryPath()` Returns the path to the server's data repository.
`int`	`getRESTServicePort()` return the search service port
`boolean`	`getSecondaryDirectoryServiceEnabled()` Indicates whether Directory Service is enabled on this server.
`java.lang.String`	`getSecondaryDirectoryServiceHost()` Gets the URL to the Directory Service Host, if Directory Service is enabled.
`int`	`getSecondaryDirectoryServicePort()` Gets the SSL port used by Directory Service, if Directory Service is enabled.
`ServerConfiguration.DirectoryServiceSecurityType`	`getSecondaryDirectoryServiceSecurityType()`
`java.lang.String`	`getServerGUID()` Returns the server's globally unique identifier.
`java.lang.String`	`getSMTPAddress()` Gets the SMTP address of the mail server that handles outbound email requests for this StarTeam server.
`java.lang.String`	`getSMTPCertificateName()` Gets the SMTP certificate name of the mail server that handles outbound email requests for this StarTeam server.
`java.lang.String`	`getSMTPHostName()` Gets the SMTP host name of the mail server that handles outbound email requests for this StarTeam server.
`java.lang.String`	`getSMTPLoginName()` Gets the SMTP login name of the mail server that handles outbound email requests for this StarTeam server.
`int`	`getSMTPPort()` Gets the SMTP port of the mail server that handles outbound email requests for this StarTeam server.
`ServerConfiguration.DirectoryServiceSecurityType`	`getSMTPSecurityType()` Gets the SMTP security type of the mail server that handles outbound email requests for this StarTeam server.
`java.lang.String`	`getStarteamAgileWebAddress()` Returns the Starteam Agile web address.
`boolean`	`getStopServerOnErrors()` Indicates whether or not the server automatically stops after an error.
`java.lang.String`	`getTNSNames()` For an Oracle configuration, returns the TNS Names for the database that the StarTeam server is connected to.
`boolean`	`getTraceExpensiveOperations()` Returns whether the server will trace expensive operations.
`ServerConfiguration.AuthenticationType`	`getTypeOfAuthentication()` Gets the authentication type configured on the server.
`int`	`getVaultCacheMaxSize()` Returns the server's vault cache size limit.
`int`	`getVaultCacheRefreshInterval()` Returns the server's vault cache refresh interval.
`java.lang.String`	`getVaultDirectory()` Returns the path to the server's vault directory.
`int`	`getVaultLockTimeLimit()` Returns the server's vault lock time limit.
`boolean`	`isAdvancedViewsDisabled()` Returns whether the server is configured to disable advanced views.
`boolean`	`isAtomicTransactionsDisabled()` Returns whether the server is configured to disable atomic transactions.
`boolean`	`isEqualTo(ServerConfiguration source)` returns true if the Object passed in is a ServerConfiguration instance, with the same set of values as this ServerConfiguration instance
`boolean`	`isMultiCommandTransactionsDisabled()` Returns true if multi-command transactions are disabled at runtime This feature is used for non-transactional vcm commits executed strictly in an administrative context If a vcm commit session discovers that atomic transactions are indeed disabled it will immediately re-enable them in the server (at required administrative privilege) and then honor the setting by running the commit without enabling multi-command transactions
`boolean`	`isProtocolAvailable(int protocol)` Returns true if the server supports the specified protocol.
`void`	`setAdvancedViewsDisabled(boolean bDisabled)` Set whether the server is configured to disable advanced views.
`void`	`setAlmServiceUrl(java.lang.String location)` Sets the location of the ALM Trace Service.
`void`	`setArchiveDirectory(java.lang.String directory)` Sets the path to the server's archive directory.
`void`	`setAtomicTransactionsDisabled(boolean bDisabled)` Set whether the server is configured to disable atomic transactions.
`void`	`setAttachmentDirectory(java.lang.String directory)` Sets the path to the server's attachment directory.
`void`	`setAuditsAutoPurgeDays(int days)` Sets the number of days after which audit information is purged from the server.
`void`	`setAuditsEnabled(boolean enable)` Sets whether or not auditing is enabled on the server.
`void`	`setCacheDirectory(java.lang.String directory)` Sets the path to the server's vault directory.
`void`	`setCipher(java.lang.String cipher)` Sets the server's cipher string.
`void`	`setCreateCheckinChangePackage(boolean createCCP)` Set to true to always create checkin change packages This property was introduced on 12.0+ servers
`void`	`setDBAutoRecovery(boolean recover)` Sets whether or not the server automatically recovers from errors.
`void`	`setDBPooledConnections(int connections)` Sets the number of pooled connections to the server database.
`void`	`setDBPort(java.lang.String dbPort)` Sets the port number of the Starteam server database
`void`	`setDBServerName(java.lang.String dbServerName)` Sets the database server name.
`void`	`setDBServiceName(java.lang.String dbServiceName)` For an Oracle configuration, sets the service name for the database that the StarTeam server is connected to.
`void`	`setDBSid(java.lang.String dbSid)` For an Oracle configuration, sets the sid for the database that the StarTeam server is connected to.
`void`	`setDBTransactionsEnabled(boolean enabled)` Sets whether or not database transactions are enabled.
`void`	`setDBType(ServerConfiguration.DatabaseType type)` Sets the server database type.
`void`	`setDBVerifyOnStartup(boolean verify)` Sets whether or not the server database is verified on startup.
`void`	`setDiagnosticStatisticsReportingInterval(int nSeconds)` Configures the server to reporting diagnostic statistics with the given frequency.
`void`	`setDirectoryServiceEnabled(boolean bEnable)` Sets Directory Service enabled or disabled on this server.
`void`	`setDirectoryServiceHost(java.lang.String host)` Sets the Directory Service host address, if Directory Service is enabled.
`void`	`setDirectoryServicePort(int port)` Sets the Directory Service SSL port, if Directory Service is enabled.
`void`	`setDumpAsserts(boolean bDump)` Set whether the server will create a diagnostic dump when unexpected conditions [i.e., asserts] are discovered.
`void`	`setDumpErrors(boolean bDump)` Set whether the server will create a diagnostic dump when errors are discovered.
`void`	`setDumpType(int miniDumpType)` Set the Dump Type used for a subsequent Diagnsotic Dump
`void`	`setEnabled(int protocol, boolean enabled)` Enable or disable the specified communication procotol.
`void`	`setEnableDiagnostics(boolean enable)` Sets whether or not server diagnostics are enabled.
`void`	`setEncryptionRequirements(IPRange[] ranges)` Sets the required encryption levels for various ranges of TCP/IP addresses.
`void`	`setEndPoint(int protocol, java.lang.String endpoint)` Modifies the specified protocol's endpoint.
`void`	`setExpensiveOperationMinimum(int milliseconds)` Set the minimum number of milliseconds used to determine what is an expensive operation for tracing purposes.
`void`	`setFileStatusAutoPurgeDays(int days)` Sets the number of days after which a file's status information will be purged.
`void`	`setInactivityTimeout(int seconds)` Sets the server's inactivity timeout.
`void`	`setLogFile(java.lang.String systemLog)` Sets the path to the server's log file.
`void`	`setLogonTimeout(int seconds)` Sets the server's logon timeout.
`void`	`setMailEnabled(boolean enable)` Sets whether or not email is enabled on the server.
`void`	`setMultiPartDirectory(java.lang.String directory)` Sets the path to the server's multi-part directory.
`void`	`setNotificationEndTime(DateTime end)` set the notification end time
`void`	`setNotificationMessage(java.lang.String message)` set the notification message
`void`	`setNotificationStartTime(DateTime start)` set the notification start time
`void`	`setNotifyBy(ServerConfiguration.NotificationType method)` Sets the method by which notification messages are sent to StarTeam users.
`void`	`setNoTimeoutNamedLicenses(boolean enable)` Sets the server's "NoTimeoutNamedLicenses" value for servers 7.0 and later.
`void`	`setOauth2ClientID(java.lang.String clientID)` Sets the Oauth2 Client ID.
`void`	`setOauth2ClientSecret(java.lang.String oauth2ClientSecret)` Sets the Oauth2 client secret.
`void`	`setOauth2IssuerURL(java.lang.String oauth2IssuerURL)` Sets the Oauth2 Issuer URL.
`void`	`setOauth2RedirectURI(java.lang.String oauth2RedirectURI)` Sets the Oauth2 redirect URI.
`void`	`setReconnectTimeout(int seconds)` Sets the server's reconnect timeout.
`void`	`setRepositoryPath(java.lang.String path)` Sets the path to the server's data repository.
`void`	`setSecondaryDirectoryServiceEnabled(boolean bEnable)` Sets Directory Service enabled or disabled on this server.
`void`	`setSecondaryDirectoryServiceHost(java.lang.String host)` Sets the Directory Service host address, if Directory Service is enabled.
`void`	`setSecondaryDirectoryServicePort(int port)` Sets the Directory Service SSL port, if Directory Service is enabled.
`void`	`setServerGUID(java.lang.String guid)` Sets the server's globally unique identifier.
`void`	`setSMTPAddress(java.lang.String address)` Sets the SMTP address of the mail server that handles outbound email requests for this StarTeam server.
`void`	`setSMTPCertificateName(java.lang.String certName)` Sets the SMTP certificate name of the mail server that handles outbound email requests for this StarTeam server.
`void`	`setSMTPHostName(java.lang.String hostName)` Sets the SMTP host name of the mail server that handles outbound email requests for this StarTeam server.
`void`	`setSMTPLoginName(java.lang.String loginName)` Sets the SMTP login name of the mail server that handles outbound email requests for this StarTeam server.
`void`	`setSMTPPassword(java.lang.String password)` Sets the SMTP password of the mail server that handles outbound email requests for this StarTeam server.
`void`	`setSMTPPort(int port)` Sets the SMTP port of the mail server that handles outbound email requests for this StarTeam server.
`void`	`setSMTPSecurityType(ServerConfiguration.DirectoryServiceSecurityType secTyp)` Sets the SMTP security Type of the mail server that handles outbound email requests for this StarTeam server.
`void`	`setStarteamAgileWebAddress(java.lang.String agileWebAddress)` Sets the Starteam Agile web address.
`void`	`setStopServerOnErrors(boolean stop)` Sets whether or not the server automatically stops after an error.
`void`	`setTNSNames(java.lang.String tnsNames)` For an Oracle configuration, sets the TNSNames for the database that the StarTeam server is connected to.
`void`	`setTraceExpensiveOperations(boolean bTrace)` Set whether the server will trace expensive operations.
`void`	`setTypeOfAuthentication(ServerConfiguration.AuthenticationType authenticationType)` Sets the authentication type (0 for Starteam authentication, 1 for Single sign-on, 2 for Multi-factor authentication).
`void`	`setUsingSecondarySecureDirectoryService(ServerConfiguration.DirectoryServiceSecurityType directoryServiceSecurityType)` Sets the security type for connecting to Directory services.
`void`	`setUsingSecureDirectoryService(ServerConfiguration.DirectoryServiceSecurityType directoryServiceSecurityType)` Sets the security type for connecting to Directory services.
`void`	`setVaultCacheMaxSize(int megs)` Sets the server's vault cache size limit.
`void`	`setVaultCacheRefreshInterval(int seconds)` Sets the server's vault cache refresh interval.
`void`	`setVaultDirectory(java.lang.String directory)` Sets the path to the server's vault directory.
`void`	`setVaultLockTimeLimit(int seconds)` Sets the server's vault lock time limit.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PROTOCOL_TCP_IP_SOCKETS
```
public static final int PROTOCOL_TCP_IP_SOCKETS
```
    The TCP/IP (Sockets) Protocol.
    
    See Also:
    
    ServerConfiguration.isProtocolAvailable(int), ServerConfiguration.setEnabled(int, boolean), ServerConfiguration.setEndPoint(int, String), Constant Field Values
- Constructor Detail
  - ServerConfiguration
```
public ServerConfiguration(ServerConfiguration source)
```
    construct a new ServerConfiguration from the source
    
    Parameters:
    
    source - ServerConfiguration the ServerConfiguration to copy
- Method Detail
  - copy
```
public ServerConfiguration copy()
```
    return a copy of this ServerConfiguration instance
    
    Returns:
    
    ServerConfiguration a copy of this ServerConfiguration instance
  - isEqualTo
```
public boolean isEqualTo(ServerConfiguration source)
```
    returns true if the Object passed in is a ServerConfiguration instance, with the same set of values as this ServerConfiguration instance
    
    Parameters:
    
    source - Object another instance of a ServerConfiguration object
    
    Returns:
    
    boolean true if the ServerConfiguration parameter has the same set of values as this one
  - getDBType
```
public ServerConfiguration.DatabaseType getDBType()
```
    Returns the server database type.
    
    Returns:
    
    The server database type.
  - setDBType
```
public void setDBType(ServerConfiguration.DatabaseType type)
```
    Sets the server database type.
    
    Parameters:
    
    type - The server database type.
    
    See Also:
    
    ServerConfiguration.DatabaseType.UNKNOWN, ServerConfiguration.DatabaseType.SQL_SERVER, ServerConfiguration.DatabaseType.ORACLE
  - getDBServerName
```
public java.lang.String getDBServerName()
```
    Returns the database server name
    
    Returns:
    
    The database server name.
  - setDBServerName
```
public void setDBServerName(java.lang.String dbServerName)
```
    Sets the database server name.
    
    Parameters:
    
    dbServerName - The database server name
  - getDBPooledConnections
```
public int getDBPooledConnections()
```
    Returns the number of pooled connections to the server database.
    
    Returns:
    
    The number of pooled connections to the server database.
  - setDBPooledConnections
```
public void setDBPooledConnections(int connections)
```
    Sets the number of pooled connections to the server database.
    
    Parameters:
    
    connections - The number of pooled connections to the server database.
  - getDBTransactionsEnabled
```
public boolean getDBTransactionsEnabled()
```
    Indicates whether or not database transactions are enabled.
    
    Returns:
    
    true if database transactions are enabled.
  - setDBTransactionsEnabled
```
public void setDBTransactionsEnabled(boolean enabled)
```
    Sets whether or not database transactions are enabled.
    
    Parameters:
    
    enabled - true if database transactions are enabled.
  - getServerGUID
```
public java.lang.String getServerGUID()
```
    Returns the server's globally unique identifier.
    
    Returns:
    
    The server's globally unique identifier.
  - setServerGUID
```
public void setServerGUID(java.lang.String guid)
```
    Sets the server's globally unique identifier.
    
    Parameters:
    
    guid - The server's globally unique identifier.
  - getCipher
```
public java.lang.String getCipher()
```
    Returns the server's cipher string.
    
    Returns:
    
    The server's cipher string.
  - setCipher
```
public void setCipher(java.lang.String cipher)
```
    Sets the server's cipher string.
    
    Parameters:
    
    cipher - The server's cipher string.
  - getLogFile
```
public java.lang.String getLogFile()
```
    Returns the path to the server's log file.
    
    Returns:
    
    The path to the server's log file.
  - setLogFile
```
public void setLogFile(java.lang.String systemLog)
```
    Sets the path to the server's log file.
    
    Parameters:
    
    systemLog - The path to the server's log file.
  - getRepositoryPath
```
public java.lang.String getRepositoryPath()
```
    Returns the path to the server's data repository.
    
    Returns:
    
    The path to the server's data repository.
  - setRepositoryPath
```
public void setRepositoryPath(java.lang.String path)
```
    Sets the path to the server's data repository.
    
    Parameters:
    
    path - The path to the server's data repository.
  - getDBPort
```
public java.lang.String getDBPort()
```
    Returns the port number that the Starteam server database is connected to.
    
    Returns:
    
    The port number that the server database is connected to.
  - setDBPort
```
public void setDBPort(java.lang.String dbPort)
```
    Sets the port number of the Starteam server database
    
    Parameters:
    
    dbPort - Port number of the server database
  - getDBServiceName
```
public java.lang.String getDBServiceName()
```
    For an Oracle configuration, returns the service name for the database that the StarTeam server is connected to.
    
    Returns:
    
    The service name that the server database is connected to.
  - setDBServiceName
```
public void setDBServiceName(java.lang.String dbServiceName)
```
    For an Oracle configuration, sets the service name for the database that the StarTeam server is connected to.
    
    Parameters:
    
    dbServiceName - Service name for the server database
  - getDBSid
```
public java.lang.String getDBSid()
```
    For an Oracle configuration, returns the Sid for the database that the StarTeam server is connected to.
    
    Returns:
    
    The Sid of the database that the StarTeam server is connected to.
  - getTNSNames
```
public java.lang.String getTNSNames()
```
    For an Oracle configuration, returns the TNS Names for the database that the StarTeam server is connected to.
    
    Returns:
    
    The TNS Names of the database that the StarTeam server is connected to.
  - setDBSid
```
public void setDBSid(java.lang.String dbSid)
```
    For an Oracle configuration, sets the sid for the database that the StarTeam server is connected to.
    
    Parameters:
    
    dbSid - Sid of the Starteam server database
  - setTNSNames
```
public void setTNSNames(java.lang.String tnsNames)
```
    For an Oracle configuration, sets the TNSNames for the database that the StarTeam server is connected to.
    
    Parameters:
    
    dbTNSNames - TNS Names of the Starteam server database
  - getEnableDiagnostics
```
public boolean getEnableDiagnostics()
```
    Indicates whether or not server diagnostics are enabled.
    
    Returns:
    
    true if server diagnostics are enabled.
  - setEnableDiagnostics
```
public void setEnableDiagnostics(boolean enable)
```
    Sets whether or not server diagnostics are enabled.
    
    Parameters:
    
    enable - true if server diagnostics are enabled.
  - getLogonTimeout
```
public int getLogonTimeout()
```
    Returns the server's logon timeout.
    
    Returns:
    
    The server's logon timeout, in seconds.
  - setLogonTimeout
```
public void setLogonTimeout(int seconds)
```
    Sets the server's logon timeout.
    
    Parameters:
    
    seconds - The server's logon timeout, in seconds.
  - getInactivityTimeout
```
public int getInactivityTimeout()
```
    Returns the server's inactivity timeout.
    
    Returns:
    
    The server's inactivity timeout, in seconds.
  - setInactivityTimeout
```
public void setInactivityTimeout(int seconds)
```
    Sets the server's inactivity timeout.
    
    Parameters:
    
    seconds - The server's inactivity timeout, in seconds.
  - getReconnectTimeout
```
public int getReconnectTimeout()
```
    Gets the server's reconnect timeout.
    
    Returns:
    
    The server's reconnect timeout, in seconds. Available for StarTeam 6.0 servers and later.
  - setReconnectTimeout
```
public void setReconnectTimeout(int seconds)
```
    Sets the server's reconnect timeout.
    
    Parameters:
    
    seconds - The server's reconnect timeout, in seconds.
  - getNoTimeoutNamedLicenses
```
public boolean getNoTimeoutNamedLicenses()
```
    Gets the server's "NoTimeoutNamedLicenses" setting for servers 7.0 and later.
    
    Returns:
    
    the server's "NoTimeoutNamedLicenses" setting for servers 7.0 and later.
  - setNoTimeoutNamedLicenses
```
public void setNoTimeoutNamedLicenses(boolean enable)
```
    Sets the server's "NoTimeoutNamedLicenses" value for servers 7.0 and later.
    
    Parameters:
    
    enable - True or False to set the server's processing for Named Licenses.
  - getVaultDirectory
```
public java.lang.String getVaultDirectory()
```
    Returns the path to the server's vault directory.
    
    Returns:
    
    The path to the server's vault directory.
  - setVaultDirectory
```
public void setVaultDirectory(java.lang.String directory)
```
    Sets the path to the server's vault directory.
    
    Parameters:
    
    directory - The path to the server's vault directory.
  - getCacheDirectory
```
public java.lang.String getCacheDirectory()
```
    Returns the path to the server's vault directory.
    
    Returns:
    
    The path to the server's vault directory.
  - setCacheDirectory
```
public void setCacheDirectory(java.lang.String directory)
```
    Sets the path to the server's vault directory.
    
    Parameters:
    
    directory - The path to the server's vault directory.
  - getArchiveDirectory
```
public java.lang.String getArchiveDirectory()
```
    Returns the path to the server's archive directory.
    
    Returns:
    
    The path to the server's archive directory.
  - setArchiveDirectory
```
public void setArchiveDirectory(java.lang.String directory)
```
    Sets the path to the server's archive directory.
    
    Parameters:
    
    directory - The path to the server's archive directory.
  - getMultiPartDirectory
```
public java.lang.String getMultiPartDirectory()
```
    Returns the path to the server's multi-part directory.
    
    Returns:
    
    The path to the server's multi-part directory.
  - setMultiPartDirectory
```
public void setMultiPartDirectory(java.lang.String directory)
```
    Sets the path to the server's multi-part directory.
    
    Parameters:
    
    directory - The path to the server's multi-part directory.
  - getVaultLockTimeLimit
```
public int getVaultLockTimeLimit()
```
    Returns the server's vault lock time limit.
    
    Returns:
    
    The server's vault lock time limit, in seconds.
  - setVaultLockTimeLimit
```
public void setVaultLockTimeLimit(int seconds)
```
    Sets the server's vault lock time limit.
    
    Parameters:
    
    seconds - The server's vault lock time limit, in seconds.
  - getVaultCacheMaxSize
```
public int getVaultCacheMaxSize()
```
    Returns the server's vault cache size limit.
    
    Returns:
    
    The server's vault cache size limit, in megabytes.
  - setVaultCacheMaxSize
```
public void setVaultCacheMaxSize(int megs)
```
    Sets the server's vault cache size limit.
    
    Parameters:
    
    megs - The server's vault cache size limit, in megabytes.
  - getVaultCacheRefreshInterval
```
public int getVaultCacheRefreshInterval()
```
    Returns the server's vault cache refresh interval.
    
    Returns:
    
    The server's vault cache refresh interval, in seconds.
  - setVaultCacheRefreshInterval
```
public void setVaultCacheRefreshInterval(int seconds)
```
    Sets the server's vault cache refresh interval.
    
    Parameters:
    
    seconds - The server's vault cache refresh interval, in seconds.
  - getFileStatusAutoPurgeDays
```
public int getFileStatusAutoPurgeDays()
```
    Returns the number of days after which a file's status information will be purged.
    
    Returns:
    
    The number of days after which a file's status information will be purged.
  - setFileStatusAutoPurgeDays
```
public void setFileStatusAutoPurgeDays(int days)
```
    Sets the number of days after which a file's status information will be purged.
    
    Parameters:
    
    days - The number of days after which a file's status information will be purged.
  - getDBVerifyOnStartup
```
public boolean getDBVerifyOnStartup()
```
    Indicates whether or not the server database is verified on startup. This property is supported by StarTeam 4.1 and later.
    
    Returns:
    
    true if the server database is verified on startup. This property is supported by StarTeam 4.1 and later.
  - setDBVerifyOnStartup
```
public void setDBVerifyOnStartup(boolean verify)
```
    Sets whether or not the server database is verified on startup. This property is supported by StarTeam 4.1 and later.
    
    Parameters:
    
    verify - true if the server database is verified on startup. This property is supported by StarTeam 4.1 and later.
  - getDBAutoRecovery
```
public boolean getDBAutoRecovery()
```
    Indicates whether or not the server automatically recovers from errors. This property is supported by StarTeam 4.1 and later.
    
    Returns:
    
    true if the server automatically recovers from errors. This property is supported by StarTeam 4.1 and later.
  - setDBAutoRecovery
```
public void setDBAutoRecovery(boolean recover)
```
    Sets whether or not the server automatically recovers from errors. This property is supported by StarTeam 4.1 and later.
    
    Parameters:
    
    recover - true if the server automatically recovers from errors. This property is supported by StarTeam 4.1 and later.
  - getStopServerOnErrors
```
public boolean getStopServerOnErrors()
```
    Indicates whether or not the server automatically stops after an error. This property is supported by StarTeam 4.1 and later.
    
    Returns:
    
    true if the server automatically stops after an error. This property is supported by StarTeam 4.1 and later.
  - setStopServerOnErrors
```
public void setStopServerOnErrors(boolean stop)
```
    Sets whether or not the server automatically stops after an error. This property is supported by StarTeam 4.1 and later.
    
    Parameters:
    
    stop - true if the server automatically stops after an error. This property is supported by StarTeam 4.1 and later.
  - getAttachmentDirectory
```
public java.lang.String getAttachmentDirectory()
```
    Returns the path to the server's attachment directory.
    
    Returns:
    
    The path to the server's attachment directory.
  - setAttachmentDirectory
```
public void setAttachmentDirectory(java.lang.String directory)
```
    Sets the path to the server's attachment directory.
    
    Parameters:
    
    directory - The path to the server's attachment directory.
  - getMailEnabled
```
public boolean getMailEnabled()
```
    Indicates whether or not email is enabled on the server.
    
    Returns:
    
    true if email is enabled on the server.
  - setMailEnabled
```
public void setMailEnabled(boolean enable)
```
    Sets whether or not email is enabled on the server.
    
    Parameters:
    
    enable - true if email is enabled on the server.
  - getSMTPAddress
```
public java.lang.String getSMTPAddress()
```
    Gets the SMTP address of the mail server that handles outbound email requests for this StarTeam server. This property is supported by StarTeam 4.2 and later.
    
    Returns:
    
    The SMTP address of the mail server that handles outbound email requests for this StarTeam server. This property is supported by StarTeam 4.2 and later.
  - setSMTPAddress
```
public void setSMTPAddress(java.lang.String address)
```
    Sets the SMTP address of the mail server that handles outbound email requests for this StarTeam server. This property is supported by StarTeam 4.2 and later.
    
    Parameters:
    
    address - The SMTP address of the mail server that handles outbound email requests for this StarTeam server. This property is supported by StarTeam 4.2 and later.
  - getSMTPHostName
```
public java.lang.String getSMTPHostName()
```
    Gets the SMTP host name of the mail server that handles outbound email requests for this StarTeam server. This property is supported by StarTeam 15.1 and later.
    
    Returns:
    
    The SMTP host name of the mail server that handles outbound email requests for this StarTeam server. This property is supported by StarTeam 15.1 and later.
  - setSMTPHostName
```
public void setSMTPHostName(java.lang.String hostName)
```
    Sets the SMTP host name of the mail server that handles outbound email requests for this StarTeam server. This property is supported by StarTeam 15.1 and later.
    
    Parameters:
    
    hostName - The SMTP host name of the mail server that handles outbound email requests for this StarTeam server. This property is supported by StarTeam 15.1 and later.
  - getSMTPCertificateName
```
public java.lang.String getSMTPCertificateName()
```
    Gets the SMTP certificate name of the mail server that handles outbound email requests for this StarTeam server. This property is supported by StarTeam 15.1 and later.
    
    Returns:
    
    The SMTP certificate name of the mail server that handles outbound email requests for this StarTeam server. This property is supported by StarTeam 15.1 and later.
  - setSMTPCertificateName
```
public void setSMTPCertificateName(java.lang.String certName)
```
    Sets the SMTP certificate name of the mail server that handles outbound email requests for this StarTeam server. This property is supported by StarTeam 15.1 and later.
    
    Parameters:
    
    certName - The SMTP certificate name of the mail server that handles outbound email requests for this StarTeam server. This property is supported by StarTeam 15.1 and later.
  - getSMTPLoginName
```
public java.lang.String getSMTPLoginName()
```
    Gets the SMTP login name of the mail server that handles outbound email requests for this StarTeam server. This property is supported by StarTeam 15.1 and later.
    
    Returns:
    
    The SMTP login name of the mail server that handles outbound email requests for this StarTeam server. This property is supported by StarTeam 15.1 and later.
  - setSMTPLoginName
```
public void setSMTPLoginName(java.lang.String loginName)
```
    Sets the SMTP login name of the mail server that handles outbound email requests for this StarTeam server. This property is supported by StarTeam 15.1 and later.
    
    Parameters:
    
    loginName - The SMTP login name of the mail server that handles outbound email requests for this StarTeam server. This property is supported by StarTeam 15.1 and later.
  - setSMTPPassword
```
public void setSMTPPassword(java.lang.String password)
```
    Sets the SMTP password of the mail server that handles outbound email requests for this StarTeam server. This property is supported by StarTeam 15.1 and later.
    
    Parameters:
    
    password - The SMTP password of the mail server that handles outbound email requests for this StarTeam server. This property is supported by StarTeam 15.1 and later.
  - getSMTPSecurityType
```
public ServerConfiguration.DirectoryServiceSecurityType getSMTPSecurityType()
```
    Gets the SMTP security type of the mail server that handles outbound email requests for this StarTeam server. This property is supported by StarTeam 15.1 and later.
    
    Returns:
    
    The SMTP security type of the mail server that handles outbound email requests for this StarTeam server.
  - setSMTPSecurityType
```
public void setSMTPSecurityType(ServerConfiguration.DirectoryServiceSecurityType secTyp)
```
    Sets the SMTP security Type of the mail server that handles outbound email requests for this StarTeam server. This property is supported by StarTeam 15.1 and later.
    
    Parameters:
    
    secTyp - The SMTP security type of the mail server that handles outbound email requests for this StarTeam server. This property is supported by StarTeam 15.1 and later.
  - getSMTPPort
```
public int getSMTPPort()
```
    Gets the SMTP port of the mail server that handles outbound email requests for this StarTeam server. This property is supported by StarTeam 4.2 and later.
    
    Returns:
    
    The SMTP port of the mail server that handles outbound email requests for this StarTeam server. This property is supported by StarTeam 4.2 and later.
  - setSMTPPort
```
public void setSMTPPort(int port)
```
    Sets the SMTP port of the mail server that handles outbound email requests for this StarTeam server. This property is supported by StarTeam 4.2 and later.
    
    Parameters:
    
    port - The SMTP port of the mail server that handles outbound email requests for this StarTeam server. This property is supported by StarTeam 4.2 and later.
  - getNotificationMessage
```
public java.lang.String getNotificationMessage()
```
    get a configured notification message
    
    Returns:
    
    a configured notification message
  - setNotificationMessage
```
public void setNotificationMessage(java.lang.String message)
```
    set the notification message
    
    Parameters:
    
    message - the notification message
  - getNotificationStartTime
```
public DateTime getNotificationStartTime()
```
    return the notification start time
    
    Returns:
    
    the notification start time
  - setNotificationStartTime
```
public void setNotificationStartTime(DateTime start)
```
    set the notification start time
    
    Parameters:
    
    start - the notification start time
  - getNotificationEndTime
```
public DateTime getNotificationEndTime()
```
    return the notification end time
    
    Returns:
    
    the notification end time
  - setNotificationEndTime
```
public void setNotificationEndTime(DateTime end)
```
    set the notification end time
    
    Parameters:
    
    start - the notification end time
  - getNotifyBy
```
public ServerConfiguration.NotificationType getNotifyBy()
```
    Gets the method by which notification messages are sent to StarTeam users. This property is supported by StarTeam 4.2 and later.
    
    Returns:
    
    The method by which notification messages are sent to StarTeam users. This property is supported by StarTeam 4.2 and later.
  - setNotifyBy
```
public void setNotifyBy(ServerConfiguration.NotificationType method)
```
    Sets the method by which notification messages are sent to StarTeam users. This property is supported by StarTeam 4.2 and later.
    
    Parameters:
    
    method - The method by which notification messages are sent to StarTeam users. This property is supported by StarTeam 4.2 and later.
    
    See Also:
    
    ServerConfiguration.NotificationType.SYS_TRAY, ServerConfiguration.NotificationType.EMAIL, ServerConfiguration.NotificationType.BOTH
  - getDirectoryServiceEnabled
```
public boolean getDirectoryServiceEnabled()
```
    Indicates whether Directory Service is enabled on this server. This property is supported by server release 6.0 and later; ignored for earlier releases.
    
    Returns:
    
    true if Directory Service is enabled on this server. This property is supported by server release 6.0 and later; ignored for earlier releases.
  - setDirectoryServiceEnabled
```
public void setDirectoryServiceEnabled(boolean bEnable)
```
    Sets Directory Service enabled or disabled on this server. This property is supported by server release 6.0 and later; ignored for earlier releases.
    
    Parameters:
    
    bEnable - true to enable Directory Service, false to disable.
  - getDirectoryServiceHost
```
public java.lang.String getDirectoryServiceHost()
```
    Gets the URL to the Directory Service Host, if Directory Service is enabled. This property is supported by server release 6.0 and later; ignored for earlier releases.
    
    Returns:
    
    the name or IP Address of the Directory Service host. This property is supported by server release 6.0 and later; ignored for earlier releases.
  - setDirectoryServiceHost
```
public void setDirectoryServiceHost(java.lang.String host)
```
    Sets the Directory Service host address, if Directory Service is enabled. This property is supported by server release 6.0 and later; ignored for earlier releases.
    
    Parameters:
    
    host - the host name or IP Address of the Directory Service host.
  - getDirectoryServicePort
```
public int getDirectoryServicePort()
```
    Gets the SSL port used by Directory Service, if Directory Service is enabled. This property is supported by server release 6.0 and later; ignored for earlier releases.
    
    Returns:
    
    the Directory Service SSL port. This property is supported by server release 6.0 and later; ignored for earlier releases.
  - setDirectoryServicePort
```
public void setDirectoryServicePort(int port)
```
    Sets the Directory Service SSL port, if Directory Service is enabled. This property is supported by server release 6.0 and later; ignored for earlier releases.
    
    Parameters:
    
    port - the SSL port used by the Directory Service.
  - getDirectoryServiceSecurityType
```
public ServerConfiguration.DirectoryServiceSecurityType getDirectoryServiceSecurityType()
```
    Returns:
    
    the security type for connecting to Directory services.
  - setUsingSecureDirectoryService
```
public void setUsingSecureDirectoryService(ServerConfiguration.DirectoryServiceSecurityType directoryServiceSecurityType)
```
    Sets the security type for connecting to Directory services. Starting 15.1, the Starteam server supports TLS for directory services in addition to SSL.
    
    Parameters:
    
    directoryServiceSecurityType -
  - getAuditsEnabled
```
public boolean getAuditsEnabled()
```
    Indicates whether or not auditing is enabled on the server.
    
    Returns:
    
    true if auditing is enabled on the server.
  - setAuditsEnabled
```
public void setAuditsEnabled(boolean enable)
```
    Sets whether or not auditing is enabled on the server.
    
    Parameters:
    
    enable - true if auditing is enabled on the server.
  - getAuditsAutoPurgeDays
```
public int getAuditsAutoPurgeDays()
```
    Returns the number of days after which audit information is purged from the server.
    
    Returns:
    
    The number of days after which audit information is purged from the server.
  - setAuditsAutoPurgeDays
```
public void setAuditsAutoPurgeDays(int days)
```
    Sets the number of days after which audit information is purged from the server.
    
    Parameters:
    
    days - The number of days after which audit information is purged from the server.
  - setEnabled
```
public void setEnabled(int protocol,
                       boolean enabled)
```
    Enable or disable the specified communication procotol.
    
    Parameters:
    
    protocol - the protocol identifier
    
    enabled - true if the protocol should be enabled
  - getEnabled
```
public boolean getEnabled(int protocol)
```
    Returns true if the specified protocol is enabled.
    
    Parameters:
    
    protocol - the protocol identifier
    
    Returns:
    
    true if the specified protocol is enabled.
  - setEndPoint
```
public void setEndPoint(int protocol,
                        java.lang.String endpoint)
```
    Modifies the specified protocol's endpoint. The endpoint is protocol specific.
    
    Parameters:
    
    protocol - the protocol identifier
    
    endpoint - the new endpoint for the specified protocol
  - getEndPoint
```
public java.lang.String getEndPoint(int protocol)
```
    Returns the endpoint for the specified protocol.
    
    Parameters:
    
    protocol - the protocol identifier
  - isProtocolAvailable
```
public boolean isProtocolAvailable(int protocol)
```
    Returns true if the server supports the specified protocol.
    
    Parameters:
    
    protocol - the protocol identifier
  - getEncryptionRequirements
```
public IPRange[] getEncryptionRequirements()
```
    Returns the required encryption levels for various ranges of TCP/IP addresses.
    
    Returns:
    
    the required encryption levels for various ranges of TCP/IP addresses.
  - setEncryptionRequirements
```
public void setEncryptionRequirements(IPRange[] ranges)
```
    Sets the required encryption levels for various ranges of TCP/IP addresses.
    
    Parameters:
    
    ranges - the new IP range/required encryption entries.
  - getTraceExpensiveOperations
```
public boolean getTraceExpensiveOperations()
```
    Returns whether the server will trace expensive operations.
    
    Returns:
    
    whether the server will trace expensive operations. Meaningful for server release 6.0 and later; always false for earlier releases.
    
    See Also:
    
    ServerConfiguration.getExpensiveOperationMinimum()
  - setTraceExpensiveOperations
```
public void setTraceExpensiveOperations(boolean bTrace)
```
    Set whether the server will trace expensive operations. Meaningful for server release 6.0 and later; ignored for earlier releases.
    
    Parameters:
    
    bTrace - whether the server will trace expensive operations.
    
    See Also:
    
    ServerConfiguration.getExpensiveOperationMinimum()
  - getExpensiveOperationMinimum
```
public int getExpensiveOperationMinimum()
```
    Returns the minimum number of milliseconds used to determine what is an expensive operation for tracing purposes.
    
    Returns:
    
    the minimum number of milliseconds used to determine what is an expensive operation for tracing purposes. Meaningful for server release 6.0 and later; returns -1 for earlier releases.
    
    See Also:
    
    ServerConfiguration.getTraceExpensiveOperations()
  - setExpensiveOperationMinimum
```
public void setExpensiveOperationMinimum(int milliseconds)
```
    Set the minimum number of milliseconds used to determine what is an expensive operation for tracing purposes. Meaningful for server release 6.0 and later; ignored for earlier releases.
    
    Parameters:
    
    milliseconds -
    
    See Also:
    
    ServerConfiguration.getTraceExpensiveOperations()
  - getDumpAsserts
```
public boolean getDumpAsserts()
```
    Returns whether the server will create a diagnostic dump when unexpected conditions [i.e., asserts] are discovered.
    
    Returns:
    
    whether the server will create a diagnostic dump when unexpected conditions [i.e., asserts] are discovered. Meaningful for server release 6.0 and later; always false for earlier releases.
  - setDumpAsserts
```
public void setDumpAsserts(boolean bDump)
```
    Set whether the server will create a diagnostic dump when unexpected conditions [i.e., asserts] are discovered. Meaningful for server release 6.0 and later; ignored for earlier releases.
    
    Parameters:
    
    bDump - whether the server create a diagnostic dump when asserts are discovered.
  - getDumpErrors
```
public boolean getDumpErrors()
```
    Returns whether the server will create a diagnostic dump when errors are discovered.
    
    Returns:
    
    whether the server will create a diagnostic dump when errors are discovered. Meaningful for server release 6.0 and later; always false for earlier releases.
  - setDumpErrors
```
public void setDumpErrors(boolean bDump)
```
    Set whether the server will create a diagnostic dump when errors are discovered. Meaningful for server release 6.0 and later; ignored for earlier releases.
    
    Parameters:
    
    bDump - whether the server create a diagnostic dump when errors are discovered.
  - getDumpType
```
public int getDumpType()
```
    Returns the mini dump type used for diagnostic dumps
    
    Returns:
    
    int the mini dump type used for diagnostic dumps
  - setDumpType
```
public void setDumpType(int miniDumpType)
```
    Set the Dump Type used for a subsequent Diagnsotic Dump
    
    Parameters:
    
    miniDumpType - int the mini dump type value to set
  - getCreateCheckinChangePackage
```
public boolean getCreateCheckinChangePackage()
```
    Returns true if checkin change packages should be created by the SDK
    
    Returns:
    
    true if checkin change packages should be created by the SDK
  - setCreateCheckinChangePackage
```
public void setCreateCheckinChangePackage(boolean createCCP)
```
    Set to true to always create checkin change packages This property was introduced on 12.0+ servers
    
    Parameters:
    
    createCCP - true to always create checkin change packages
  - getAlmServiceUrl
```
public java.lang.String getAlmServiceUrl()
```
    The location of the ALM Trace Service, if available.
    This setting is ignored by StarTeam server versions prior to StarTeam Server 2008 R2.
    
    Returns:
    
    A string form of the URL used to locate the ALM Trace Service.
  - getRESTServicePort
```
public int getRESTServicePort()
```
    return the search service port
    
    Returns:
    
    the search service port
  - getFederatedTraceServer
```
public GUID getFederatedTraceServer()
```
    Returns the GUID corresponding to a Server used to store only Traces in a multi configuration StarTeam environment
    
    Returns:
    
    the GUID corresponding to a Server used to store just Traces in a multi configuration StarTeam environment
  - getDefaultBinaryExtensions
```
public java.lang.String[] getDefaultBinaryExtensions()
```
    Returns the set of extensions which will be automatically treated as Binary Types by the StarTeam checkin engine. Extensions must be separated from each other by a ; e.g. .doc;.xml;.pdf;.s19
    
    Returns:
    
    the set of default binary extension types
  - getEnableSDKWorkflow
```
public java.lang.Boolean getEnableSDKWorkflow()
```
    Returns TRUE if SDK Workflow should be turned ON automatically within the SDK, the Command Line etc. By default, Workflow is accessible from the SDK via the Workflow engine but is not turned ON.
    
    Returns:
    
    TRUE if SDK Workflow should be turned ON automatically
  - getDisableCustomTools
```
public boolean getDisableCustomTools()
```
    returns true if custom tools can be disabled, false otherwise this feature was introduced with the 14.0 server
    
    Returns:
    
    true if custom tools can be disabled, false otherwise
  - getCheckoutUseRevisionFileName
```
public boolean getCheckoutUseRevisionFileName()
```
    returns true if files with different names at older revisions need to be checked out using the old file name
    
    Returns:
    
    true if files with different names at older revisions need to be checked out using the old file name
  - setAlmServiceUrl
```
public void setAlmServiceUrl(java.lang.String location)
```
    Sets the location of the ALM Trace Service.
    This setting is ignored by StarTeam server versions prior to StarTeam Server 2008 R2.
    
    Parameters:
    
    location - the location of the ALM Trace Service.
  - isMultiCommandTransactionsDisabled
```
public boolean isMultiCommandTransactionsDisabled()
```
    Returns true if multi-command transactions are disabled at runtime This feature is used for non-transactional vcm commits executed strictly in an administrative context If a vcm commit session discovers that atomic transactions are indeed disabled it will immediately re-enable them in the server (at required administrative privilege) and then honor the setting by running the commit without enabling multi-command transactions
    
    Returns:
    
    true if multi-command transactions are disabled at runtime during a vcm commit This request will always force a server command to be executed.
    
    See Also:
    
    ServerConfiguration.isAtomicTransactionsDisabled()
  - isAtomicTransactionsDisabled
```
public boolean isAtomicTransactionsDisabled()
```
    Returns whether the server is configured to disable atomic transactions.
    
    Returns:
    
    whether the server is configured to disable atomic transactions. Meaningful for server release 10.0 and later; always false for earlier releases.
  - setAtomicTransactionsDisabled
```
public void setAtomicTransactionsDisabled(boolean bDisabled)
```
    Set whether the server is configured to disable atomic transactions. Meaningful for server release 10.0 and later; ignored for earlier releases.
    
    Parameters:
    
    bDisabled - whether the server is configured to disable atomic transactions.
  - isAdvancedViewsDisabled
```
public boolean isAdvancedViewsDisabled()
```
    Returns whether the server is configured to disable advanced views.
    
    Returns:
    
    whether the server is configured to disable advanced views. Meaningful for server release 10.0 and later; always false for earlier releases.
  - setAdvancedViewsDisabled
```
public void setAdvancedViewsDisabled(boolean bDisabled)
```
    Set whether the server is configured to disable advanced views. Meaningful for server release 10.0 and later; ignored for earlier releases.
    
    Parameters:
    
    bDisabled - whether the server is configured to disable advanced views.
  - getDiagnosticStatisticsReportingInterval
```
public int getDiagnosticStatisticsReportingInterval()
```
    Determines the frequency with which the server reports diagnostic statistics.
    This setting is ignored by StarTeam server versions prior to 10.4.
    
    Returns:
    
    The frequency, in seconds, with which the server will report diagnostic statistics. The default value is zero, which disables reporting.
  - setDiagnosticStatisticsReportingInterval
```
public void setDiagnosticStatisticsReportingInterval(int nSeconds)
```
    Configures the server to reporting diagnostic statistics with the given frequency.
    This setting is ignored by StarTeam server versions prior to 10.4.
    
    Parameters:
    
    nSeconds - The frequency, in seconds, with which the server will report diagnostic statistics. The default value is zero, which disables reporting.
  - getStarteamAgileWebAddress
```
public java.lang.String getStarteamAgileWebAddress()
```
    Returns the Starteam Agile web address.
    This setting is introduced in Starteam Server version 13.0
    
    Returns:
    
    A Starteam Agile Web address
  - setStarteamAgileWebAddress
```
public void setStarteamAgileWebAddress(java.lang.String agileWebAddress)
```
    Sets the Starteam Agile web address. This setting is introduced in Starteam Server version 13.0
    
    Parameters:
    
    agileWebAddress - The Starteam Agile Web Server address.
  - getSecondaryDirectoryServiceEnabled
```
public boolean getSecondaryDirectoryServiceEnabled()
```
    Indicates whether Directory Service is enabled on this server. This property is supported by server release 6.0 and later; ignored for earlier releases.
    
    Returns:
    
    true if Directory Service is enabled on this server. This property is supported by server release 16.4 and later; ignored for earlier releases.
  - setSecondaryDirectoryServiceEnabled
```
public void setSecondaryDirectoryServiceEnabled(boolean bEnable)
```
    Sets Directory Service enabled or disabled on this server. This property is supported by server release 16.4 and later; ignored for earlier releases.
    
    Parameters:
    
    bEnable - true to enable Directory Service, false to disable.
  - getSecondaryDirectoryServiceHost
```
public java.lang.String getSecondaryDirectoryServiceHost()
```
    Gets the URL to the Directory Service Host, if Directory Service is enabled. This property is supported by server release 16.4 and later; ignored for earlier releases.
    
    Returns:
    
    the name or IP Address of the Directory Service host. This property is supported by server release 16.4 and later; ignored for earlier releases.
  - setOauth2IssuerURL
```
public void setOauth2IssuerURL(java.lang.String oauth2IssuerURL)
```
    Sets the Oauth2 Issuer URL. This property is supported by server release 17.1 and later; ignored for earlier releases.
    
    Parameters:
    
    oauth2IssuerURL - the Oauth2 Issuer URL required for Single sign-on/ Multi-factor authentication.
  - getOauth2IssuerURL
```
public java.lang.String getOauth2IssuerURL()
```
    Gets the Oauth2 Issuer URL configured. This property is supported by server release 17.1 and later; ignored for earlier releases.
    
    Returns:
    
    Oauth2 Issuer URL.
  - setTypeOfAuthentication
```
public void setTypeOfAuthentication(ServerConfiguration.AuthenticationType authenticationType)
```
    Sets the authentication type (0 for Starteam authentication, 1 for Single sign-on, 2 for Multi-factor authentication). This property is supported by server release 17.1 and later; ignored for earlier releases.
    
    Parameters:
    
    authenticationType - - authentication type
  - getTypeOfAuthentication
```
public ServerConfiguration.AuthenticationType getTypeOfAuthentication()
```
    Gets the authentication type configured on the server. This property is supported by server release 17.1 and later; ignored for earlier releases.
    
    Returns:
    
    authentication type.
  - setOauth2RedirectURI
```
public void setOauth2RedirectURI(java.lang.String oauth2RedirectURI)
```
    Sets the Oauth2 redirect URI. This property is supported by server release 17.1 and later; ignored for earlier releases.
    
    Parameters:
    
    oauth2RedirectURI - the Oauth2 redirect URI required for Single sign-on/ Multi-factor authentication.
  - getOauth2RedirectURI
```
public java.lang.String getOauth2RedirectURI()
```
    Gets the Oauth2 redirect URI configured. This property is supported by server release 17.1 and later; ignored for earlier releases.
    
    Returns:
    
    Oauth2 redirect URI.
  - setOauth2ClientID
```
public void setOauth2ClientID(java.lang.String clientID)
```
    Sets the Oauth2 Client ID. This property is supported by server release 17.1 and later; ignored for earlier releases.
    
    Parameters:
    
    oauth2RedirectURI - the Oauth2 client id required for Single sign-on/ Multi-factor authentication.
  - getOauth2ClientID
```
public java.lang.String getOauth2ClientID()
```
    Gets the Oauth2 client id. This property is supported by server release 17.1 and later; ignored for earlier releases.
    
    Returns:
    
    Oauth2 client id required for Single sign-on/ Multi-factor authentication.
  - setOauth2ClientSecret
```
public void setOauth2ClientSecret(java.lang.String oauth2ClientSecret)
```
    Sets the Oauth2 client secret. This property is supported by server release 17.1 and later; ignored for earlier releases.
    
    Parameters:
    
    oauth2ClientSecret - the Oauth2 secret required for Single sign-on/ Multi-factor authentication.
  - setSecondaryDirectoryServiceHost
```
public void setSecondaryDirectoryServiceHost(java.lang.String host)
```
    Sets the Directory Service host address, if Directory Service is enabled. This property is supported by server release 16.4 and later; ignored for earlier releases.
    
    Parameters:
    
    host - the host name or IP Address of the Directory Service host.
  - getSecondaryDirectoryServicePort
```
public int getSecondaryDirectoryServicePort()
```
    Gets the SSL port used by Directory Service, if Directory Service is enabled. This property is supported by server release 16.4 and later; ignored for earlier releases.
    
    Returns:
    
    the Directory Service SSL port. This property is supported by server release 16.4 and later; ignored for earlier releases.
  - setSecondaryDirectoryServicePort
```
public void setSecondaryDirectoryServicePort(int port)
```
    Sets the Directory Service SSL port, if Directory Service is enabled. This property is supported by server release 16.4 and later; ignored for earlier releases.
    
    Parameters:
    
    port - the SSL port used by the Directory Service.
  - getSecondaryDirectoryServiceSecurityType
```
public ServerConfiguration.DirectoryServiceSecurityType getSecondaryDirectoryServiceSecurityType()
```
    Returns:
    
    the security type for connecting to Directory services.
  - setUsingSecondarySecureDirectoryService
```
public void setUsingSecondarySecureDirectoryService(ServerConfiguration.DirectoryServiceSecurityType directoryServiceSecurityType)
```
    Sets the security type for connecting to Directory services. Starting 16.4, the Starteam server supports TLS for directory services in addition to SSL.
    
    Parameters:
    
    directoryServiceSecurityType -

Class ServerConfiguration

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PROTOCOL_TCP_IP_SOCKETS

Constructor Detail

ServerConfiguration

Method Detail

copy

isEqualTo

getDBType

setDBType

getDBServerName

setDBServerName

getDBPooledConnections

setDBPooledConnections

getDBTransactionsEnabled

setDBTransactionsEnabled

getServerGUID

setServerGUID

getCipher

setCipher

getLogFile

setLogFile

getRepositoryPath

setRepositoryPath

getDBPort

setDBPort

getDBServiceName

setDBServiceName

getDBSid

getTNSNames

setDBSid

setTNSNames

getEnableDiagnostics

setEnableDiagnostics

getLogonTimeout

setLogonTimeout

getInactivityTimeout

setInactivityTimeout

getReconnectTimeout

setReconnectTimeout

getNoTimeoutNamedLicenses

setNoTimeoutNamedLicenses

getVaultDirectory

setVaultDirectory

getCacheDirectory

setCacheDirectory

getArchiveDirectory

setArchiveDirectory

getMultiPartDirectory

setMultiPartDirectory

getVaultLockTimeLimit

setVaultLockTimeLimit

getVaultCacheMaxSize

setVaultCacheMaxSize

getVaultCacheRefreshInterval

setVaultCacheRefreshInterval

getFileStatusAutoPurgeDays

setFileStatusAutoPurgeDays

getDBVerifyOnStartup

setDBVerifyOnStartup

getDBAutoRecovery

setDBAutoRecovery

getStopServerOnErrors

setStopServerOnErrors

getAttachmentDirectory

setAttachmentDirectory

getMailEnabled

setMailEnabled

getSMTPAddress

setSMTPAddress

getSMTPHostName

setSMTPHostName

getSMTPCertificateName

setSMTPCertificateName

getSMTPLoginName