com.starbase.starteam
Class ServerConfiguration

java.lang.Object
  |
  +--com.starbase.starteam.ServerConfiguration

public class ServerConfiguration

extends java.lang.Object

Field Summary

static int	DBTYPE_DB2 Database type is DB2.
static int	DBTYPE_INFORMIX Database type is Informix.
static int	DBTYPE_MSACCESS Database type is Microsoft Access.
static int	DBTYPE_ORACLE Database type is Oracle.
static int	DBTYPE_SQLSERVER Database type is Microsoft SQL Server.
static int	DBTYPE_SYBASE Database type is Sybase.
static int	DBTYPE_UNKNOWN Database type is unknown.
static int	NOTIFICATION_TYPE_BOTH Notify users both by displaying an icon in the system tray, and sending an email message.
static int	NOTIFICATION_TYPE_EMAIL Notify users by sending an email message.
static int	NOTIFICATION_TYPE_SYSTRAY Notify users by displaying an icon in the system tray.
static int	PROTOCOL_IPX The IPX Protocol.
static int	PROTOCOL_LRPC The LRPC Protocol.
static int	PROTOCOL_NAMED_PIPE The Named Pipe Protocol.
static int	PROTOCOL_NETBIOS The NETBIOS Protocol.
static int	PROTOCOL_TCP_IP_RPC The TCP/IP (RPC) Protocol.
static int	PROTOCOL_TCP_IP_SOCKETS The TCP/IP (Sockets) Protocol.
static int	PROTOCOL_TCP_IP_SOCKETS_XML XML over TCP/IP Protocol.

Constructor Summary

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

Method Summary

ServerConfiguration	copy() return a copy of this ServerConfiguration instance
boolean	equals(java.lang.Object source) returns true if this object instance is equal to the source
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.
java.lang.String	getCipher() Returns the server's cipher string.
boolean	getDBAutoRecovery() Indicates whether or not the server automatically recovers from errors.
java.lang.String	getDBDSN() Returns the server data source name.
int	getDBPooledConnections() Returns the number of pooled connections to the server database.
boolean	getDBTransactionsEnabled() Indicates whether or not database transactions are enabled.
int	getDBType() Returns the server database type.
boolean	getDBVerifyOnStartup() Indicates whether or not the server database is verified on startup.
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.
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.
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.
int	getFileStatusAutoPurgeDays() Returns the number of days after which a file's status information will be purged.
int	getForeignRefreshRate() Returns the rate at which files are refreshed from foreign archives.
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.
int	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.
int	getReconnectTimeout() Gets the server's reconnect timeout.
java.lang.String	getRepositoryPath() Returns the path to the server's data repository.
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.
int	getSMTPPort() Gets the SMTP port of the mail server that handles outbound email requests for this StarTeam server.
boolean	getStopServerOnErrors() Indicates whether or not the server automatically stops after an error.
boolean	getTraceExpensiveOperations() Returns whether the server will trace expensive operations.
boolean	getUsingSecureDirectoryService() Gets the server's "Using Secure Directory Service (LDAPS)" value for servers 7.0 and later.
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.
int	hashCode() returns a unique hash for all instances of this type
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	isEnhancedProcessItemsEnabledForAllProjects() Determines whether or not the enhanced process item model is currently enabled for all projects on this server.
boolean	isEnhancedProcessItemsEnabledForNewProjects() Determines whether or not the enhanced process item model is in effect by default for new projects.
boolean	isEqualTo(ServerConfiguration source) returns true if this object instance is equal to the source
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	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	setDBAutoRecovery(boolean recover) Sets whether or not the server automatically recovers from errors.
void	setDBDSN(java.lang.String dsn) Sets the server data source name.
void	setDBPooledConnections(int connections) Sets the number of pooled connections to the server database.
void	setDBTransactionsEnabled(boolean enabled) Sets whether or not database transactions are enabled.
void	setDBType(int 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	setEnhancedProcessItemsEnabledForAllProjects(boolean bEnabled) Enables or disables the enhanced process item model for all projects on this server.
void	setEnhancedProcessItemsEnabledForNewProjects(boolean isEnabled) Enables or disables the enhanced process item model by default for new projects.
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	setForeignRefreshRate(int rate) Sets the rate at which files are refreshed from foreign archives.
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	setNotifyBy(int 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	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	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	setSMTPPort(int port) Sets the SMTP port of the mail server that handles outbound email requests for this StarTeam server.
void	setStopServerOnErrors(boolean stop) Sets whether or not the server automatically stops after an error.
void	setTraceExpensiveOperations(boolean bTrace) Set whether the server will trace expensive operations.
void	setUsingSecureDirectoryService(boolean useSecureDirectoryService) Sets the server's "Using Secure Directory Service (LDAPS)" value for servers 7.0 and later.
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

getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

DBTYPE_UNKNOWN

public static final int DBTYPE_UNKNOWN

Database type is unknown.

See Also:

ServerConfiguration.setDBType(int), Constant Field Values

DBTYPE_MSACCESS

public static final int DBTYPE_MSACCESS

Database type is Microsoft Access.

See Also:

ServerConfiguration.setDBType(int), Constant Field Values

DBTYPE_SQLSERVER

public static final int DBTYPE_SQLSERVER

Database type is Microsoft SQL Server.

See Also:

ServerConfiguration.setDBType(int), Constant Field Values

DBTYPE_ORACLE

public static final int DBTYPE_ORACLE

Database type is Oracle.

See Also:

ServerConfiguration.setDBType(int), Constant Field Values

DBTYPE_SYBASE

public static final int DBTYPE_SYBASE

Database type is Sybase.

See Also:

ServerConfiguration.setDBType(int), Constant Field Values

DBTYPE_INFORMIX

public static final int DBTYPE_INFORMIX

Database type is Informix.

See Also:

ServerConfiguration.setDBType(int), Constant Field Values

DBTYPE_DB2

public static final int DBTYPE_DB2

Database type is DB2.

See Also:

ServerConfiguration.setDBType(int), Constant Field Values

PROTOCOL_LRPC

public static final int PROTOCOL_LRPC

The LRPC Protocol.

See Also:

ServerConfiguration.isProtocolAvailable(int), ServerConfiguration.setEnabled(int, boolean), ServerConfiguration.setEndPoint(int, String), Constant Field Values

PROTOCOL_NETBIOS

public static final int PROTOCOL_NETBIOS

The NETBIOS Protocol.

See Also:

ServerConfiguration.isProtocolAvailable(int), ServerConfiguration.setEnabled(int, boolean), ServerConfiguration.setEndPoint(int, String), Constant Field Values

PROTOCOL_IPX

public static final int PROTOCOL_IPX

The IPX Protocol.

See Also:

ServerConfiguration.isProtocolAvailable(int), ServerConfiguration.setEnabled(int, boolean), ServerConfiguration.setEndPoint(int, String), Constant Field Values

PROTOCOL_NAMED_PIPE

public static final int PROTOCOL_NAMED_PIPE

The Named Pipe Protocol.

See Also:

ServerConfiguration.isProtocolAvailable(int), ServerConfiguration.setEnabled(int, boolean), ServerConfiguration.setEndPoint(int, String), Constant Field Values

PROTOCOL_TCP_IP_RPC

public static final int PROTOCOL_TCP_IP_RPC

The TCP/IP (RPC) Protocol.

See Also:

ServerConfiguration.isProtocolAvailable(int), ServerConfiguration.setEnabled(int, boolean), ServerConfiguration.setEndPoint(int, String), Constant Field Values

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

PROTOCOL_TCP_IP_SOCKETS_XML

public static final int PROTOCOL_TCP_IP_SOCKETS_XML

XML over TCP/IP Protocol.

See Also:

ServerConfiguration.isProtocolAvailable(int), ServerConfiguration.setEnabled(int, boolean), ServerConfiguration.setEndPoint(int, String), Constant Field Values

NOTIFICATION_TYPE_SYSTRAY

public static final int NOTIFICATION_TYPE_SYSTRAY

Notify users by displaying an icon in the system tray.

See Also:

ServerConfiguration.setNotifyBy(int), Constant Field Values

NOTIFICATION_TYPE_EMAIL

public static final int NOTIFICATION_TYPE_EMAIL

Notify users by sending an email message.

See Also:

ServerConfiguration.setNotifyBy(int), Constant Field Values

NOTIFICATION_TYPE_BOTH

public static final int NOTIFICATION_TYPE_BOTH

Notify users both by displaying an icon in the system tray, and sending an email message.

See Also:

ServerConfiguration.setNotifyBy(int), 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

getDBType

public int getDBType()

Returns the server database type.

Returns:

The server database type.

setDBType

public void setDBType(int type)

Sets the server database type.

Parameters:

type - The server database type.

See Also:

ServerConfiguration.DBTYPE_UNKNOWN, ServerConfiguration.DBTYPE_MSACCESS, ServerConfiguration.DBTYPE_SQLSERVER, ServerConfiguration.DBTYPE_ORACLE, ServerConfiguration.DBTYPE_SYBASE, ServerConfiguration.DBTYPE_INFORMIX, ServerConfiguration.DBTYPE_DB2

getDBDSN

public java.lang.String getDBDSN()

Returns the server data source name.

Returns:

The server data source name.

setDBDSN

public void setDBDSN(java.lang.String dsn)

Sets the server data source name.

Parameters:

dsn - The server data source 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.

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.

See Also:

SupportedFeatures.hasReconnect()

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.

See Also:

SupportedFeatures.hasNoTimeoutNamedLicenses()

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.

getForeignRefreshRate

public int getForeignRefreshRate()

Returns the rate at which files are refreshed from foreign archives.

Returns:

The rate at which files are refreshed from foreign archives.

setForeignRefreshRate

public void setForeignRefreshRate(int rate)

Sets the rate at which files are refreshed from foreign archives.

Parameters:

rate - The rate at which files are refreshed from foreign archives.

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.

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.

getNotifyBy

public int 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(int 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.NOTIFICATION_TYPE_SYSTRAY, ServerConfiguration.NOTIFICATION_TYPE_EMAIL, ServerConfiguration.NOTIFICATION_TYPE_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.

getUsingSecureDirectoryService

public boolean getUsingSecureDirectoryService()

Gets the server's "Using Secure Directory Service (LDAPS)" value for servers 7.0 and later. This property is supported by server release 7.0 and later; always false for earlier releases.

Returns:

the server's "Using Secure Directory Service (LDAPS)" value for servers 7.0 and later.

setUsingSecureDirectoryService

public void setUsingSecureDirectoryService(boolean useSecureDirectoryService)

Sets the server's "Using Secure Directory Service (LDAPS)" value for servers 7.0 and later. This property is supported by server release 7.0 and later; ignored for earlier releases.

Parameters:

useSecureDirectoryService - TRUE to use secure directory service, FALSE otherwise.

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.

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.

See Also:

SupportedFeatures.hasDiagnosticStatisticsReporting()

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.

isEnhancedProcessItemsEnabledForNewProjects

public boolean isEnhancedProcessItemsEnabledForNewProjects()

Determines whether or not the enhanced process item model is in effect by default for new projects. In the enhanced model, changed files and folders are linked to process items indirectly, via a view-specific process task.

This method requires StarTeam server version 9.3 or later.

Returns:

true if the enhanced process item model is in effect by default for new projects, and false otherwise.

setEnhancedProcessItemsEnabledForNewProjects

public void setEnhancedProcessItemsEnabledForNewProjects(boolean isEnabled)

Enables or disables the enhanced process item model by default for new projects. In the enhanced model, changed files and folders are linked to process items indirectly, via a view-specific process task.

This method requires StarTeam server version 9.3 or later.

Parameters:

isEnabled - true to enable the enhanced model by default for new projects; false to disable the enhanced model.

See Also:

ServerConfiguration.setEnhancedProcessItemsEnabledForAllProjects(boolean), Project.setEnhancedProcessItemsEnabled(boolean), SupportedFeatures.hasEnhancedProcessItemsNative()

setEnhancedProcessItemsEnabledForAllProjects

public void setEnhancedProcessItemsEnabledForAllProjects(boolean bEnabled)

Enables or disables the enhanced process item model for all projects on this server. In the enhanced model, changed files and folders are linked to process items indirectly, via a view-specific process task.

On StarTeam server versions 9.1 and later, this method disables the enhanced model for every existing project individually, and also disables the enhanced model for new projects.

On earlier servers, the enhanced model can only be enabled or disabled globally. Internally, this is done by enabling or disabling the TASK_USAGE_90 property, as necessary.

See Also:

ServerConfiguration.setEnhancedProcessItemsEnabledForNewProjects(boolean), Project.setEnhancedProcessItemsEnabled(boolean), SupportedFeatures.hasEnhancedProcessItemsNative(), PropertyNames.TASK_USAGE_90

isEnhancedProcessItemsEnabledForAllProjects

public boolean isEnhancedProcessItemsEnabledForAllProjects()

Determines whether or not the enhanced process item model is currently enabled for all projects on this server.

Returns:

true if the enhanced model is enabled for all projects on this server; false otherwise.

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:

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:

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:

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.

See Also:

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

equals

public boolean equals(java.lang.Object source)

returns true if this object instance is equal to the source

Overrides:

equals in class java.lang.Object

Parameters:

source - Object the source to comapre with

Returns:

boolean true if this object is equal to the source

isEqualTo

public boolean isEqualTo(ServerConfiguration source)

returns true if this object instance is equal to the source

Parameters:

source - Object the source to comapre with

Returns:

boolean true if this object is equal to the source

hashCode

public int hashCode()

returns a unique hash for all instances of this type

Overrides:

hashCode in class java.lang.Object

Returns:

int a unique hash for all instances of this type