com.starteam
Class HiveInfo

java.lang.Object
  com.starteam.HiveInfo

public final class HiveInfo
extends java.lang.Object

Describes a vault hive on the server.

Nested Class Summary

static class

HiveInfo.HiveType Constants identifying the type of archive files stored in a vault hive.

Constructor Summary

HiveInfo(HiveInfo.HiveType hiveType)
Create a new HiveInfo object

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

HiveInfo(int ID, int hiveType, java.lang.String name, java.lang.String rootDirectory, java.lang.String cacheDirectory, java.lang.String archiveDirectory, java.lang.String rootCacheAgentArchiveDirectory, boolean bAllowNewArchives, int storageLimitThreshold, long maxCacheSize, int cacheCleanupInterval)
Constructor for the case when we already know the hive object's ID.

Method Summary

HiveInfo	copy() return a copy of this HiveInfo instance
boolean	getAllowNewArchives() Indicates whether new archive files can be added to the hive.
java.lang.String	getArchiveDirectory() Path to the hive's Archive directory.
int	getCacheCleanupInterval() Seconds between cache cleanup operations.
java.lang.String	getCacheDirectory() Path to the hive's Cache directory.
int	getID() The number assigned by StarTeam to identify the hive.
long	getMaxCacheSize() Maximum number of megabytes of hard disk space that the cache can use.
java.lang.String	getName() The name of the hive.
java.lang.String	getRootCacheAgentArchiveDirectory() Same folder path as for ArchiveDirectory but from the perspective of the computer on which the Root Cache Agent is installed.
java.lang.String	getRootDirectory() Shortcut to creating path to Cache and Archive directories; when set, CacheDirectory and ArchiveDirectory do not need to be set.
int	getStorageLimitThreshold() Percentage of total disk space allowed for hive.
HiveInfo.HiveType	getType() The HiveType assigned by StarTeam to identify the the type of archive files stored in the hive:
boolean	isEqualTo(HiveInfo other) returns true if the Object passed in is a HiveInfo instance, with the same set of values as this HiveInfo instance
void	setAllowNewArchives(boolean bAllowNewArchives) Set whether new archive files can be added to the hive.
void	setArchiveDirectory(java.lang.String archiveDirectory) Set the path to the hiv's Archive directory.
void	setCacheCleanupInterval(int cacheCleanupInterval) Set the number of seconds between cache cleanup operations.
void	setCacheDirectory(java.lang.String cacheDirectory) Set the path to the hive's Cache directory.
void	setMaxCacheSize(long maxCacheSize) Set the maximum number of megabytes of hard disk space that the cache can use.
void	setName(java.lang.String name) Set the name of the hive.
void	setRootCacheAgentArchiveDirectory(java.lang.String rootCacheAgentArchiveDirectory) Set the Root Cache Agent Archive Directory.
void	setRootDirectory(java.lang.String rootDirectory) Set the shortcut for paths to the Cache and Archive directories; when set, CacheDirectory and ArchiveDirectory do not need to be set.
void	setStorageLimitThreshold(int storageLimitThreshold) Set the percentage of total disk space allowed for the hive.
java.lang.String	toString() Return a string representation of the HiveInfo object.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

HiveInfo

public HiveInfo(HiveInfo.HiveType hiveType)

Create a new HiveInfo object

Parameters:

hiveType - One of the HiveType values described above

See Also:

HiveInfo.HiveType

HiveInfo

public HiveInfo(int ID,
                int hiveType,
                java.lang.String name,
                java.lang.String rootDirectory,
                java.lang.String cacheDirectory,
                java.lang.String archiveDirectory,
                java.lang.String rootCacheAgentArchiveDirectory,
                boolean bAllowNewArchives,
                int storageLimitThreshold,
                long maxCacheSize,
                int cacheCleanupInterval)

Constructor for the case when we already know the hive object's ID.

Parameters:

ID - The ID of this hive object.

hiveType - One of the HiveType values described above.

name - Name of the hive.

rootDirectory - Root directory of the hive.

cacheDirectory - Cache directory of the hive.

archiveDirectory - Archive directory of the hive.

rootCacheAgentArchiveDirectory - Directory for the root cache agent of the hive.

bAllowNewArchives - true = allow new archives, false = do not allow.

storageLimitThreshold - Hive's storage limit threshold.

maxCacheSize - 64-bit value specifying the hive's maximum cache size.

cacheCleanupInterval - Timespan between cache refresh operations.

HiveInfo

public HiveInfo(HiveInfo source)

construct a new HiveInfo from the source

Parameters:

source - HiveInfo the HiveInfo to copy

Method Detail

copy

public HiveInfo copy()

return a copy of this HiveInfo instance

Returns:

HiveInfo a copy of this HiveInfo instance

isEqualTo

public boolean isEqualTo(HiveInfo other)

returns true if the Object passed in is a HiveInfo instance, with the same set of values as this HiveInfo instance

Parameters:

other - Object another instance of a HiveInfo object

Returns:

boolean true if the HiveInfo parameter has the same set of values as this one

getID

public int getID()

The number assigned by StarTeam to identify the hive.

Returns:

The number assigned by StarTeam to identify the hive

getType

public HiveInfo.HiveType getType()

The HiveType assigned by StarTeam to identify the the type of archive files stored in the hive:

Returns:

The HiveType assigned by StarTeam to identify the the type of archive files stored in the hive:

getName

public java.lang.String getName()

The name of the hive. Note that on UNIX-based systems the name should not include any spaces.

Returns:

The name of the hive. Note that on UNIX-based systems the name should not include any spaces.

setName

public void setName(java.lang.String name)

Set the name of the hive. Note that on UNIX-based systems the name should not include any spaces.

Parameters:

name - The new hive name. Note that on UNIX-based systems the name should not include any spaces.

getRootDirectory

public java.lang.String getRootDirectory()

Shortcut to creating path to Cache and Archive directories; when set, CacheDirectory and ArchiveDirectory do not need to be set. The default is [repository_path]\DefaultHive.

Returns:

The shortcut to creating path to Cache and Archive directories. When set, CacheDirectory and ArchiveDirectory do not need to be set. The default is [repository_path]\DefaultHive.

setRootDirectory

public void setRootDirectory(java.lang.String rootDirectory)

Set the shortcut for paths to the Cache and Archive directories; when set, CacheDirectory and ArchiveDirectory do not need to be set. The default is [repository_path]\DefaultHive.

Parameters:

rootDirectory - The new root directory.

getCacheDirectory

public java.lang.String getCacheDirectory()

Path to the hive's Cache directory. When set, it overrides the value of RootDirectory. The default is [repository_path]\DefaultHive\Cache.

Returns:

The path to the hive's Cache directory. When set, it overrides the value of RootDirectory. The default is [repository_path]\DefaultHive\Cache.

setCacheDirectory

public void setCacheDirectory(java.lang.String cacheDirectory)

Set the path to the hive's Cache directory. When set, it overrides the value of RootDirectory. The default is [repository_path]\DefaultHive\Cache.

Parameters:

cacheDirectory - The new path to the hive's Cache directory.

getArchiveDirectory

public java.lang.String getArchiveDirectory()

Path to the hive's Archive directory. When set, it overrides the value of RootDirectory. The default is [repository_path]\DefaultHive\Archives.

Returns:

The path to the hive's Archive directory. When set, it overrides the value of RootDirectory. The default is [repository_path]\DefaultHive\Archives.

setArchiveDirectory

public void setArchiveDirectory(java.lang.String archiveDirectory)

Set the path to the hiv's Archive directory. When set, it overrides the value of RootDirectory. The default is [repository_path]\DefaultHive\Archives.

Parameters:

archiveDirectory - The new path to the hive's Archive directory.

getRootCacheAgentArchiveDirectory

public java.lang.String getRootCacheAgentArchiveDirectory()

Same folder path as for ArchiveDirectory but from the perspective of the computer on which the Root Cache Agent is installed. If the Root Cache Agent is installed on the same computer as the StarTeam Server, this can be empty or the same setting as the ArchiveDirectory.

Returns:

The path to the hive's Root Cache Agent Archive directory. This is the same folder path as for ArchiveDirectory but from the perspective of the computer on which the Root Cache Agent is installed. If the Root Cache Agent is installed on the same computer as the StarTeam Server, this can be empty or the same setting as the ArchiveDirectory.

setRootCacheAgentArchiveDirectory

public void setRootCacheAgentArchiveDirectory(java.lang.String rootCacheAgentArchiveDirectory)

Set the Root Cache Agent Archive Directory. Same folder path as for ArchiveDirectory but from the perspective of the computer on which the Root Cache Agent is installed. If the Root Cache Agent is installed on the same computer as the StarTeam Server, this can be empty or the same setting as the ArchiveDirectory.

Parameters:

rootCacheAgentArchiveDirectory - The new path to the Root Cache Agent Archive Directory.

getMaxCacheSize

public long getMaxCacheSize()

Maximum number of megabytes of hard disk space that the cache can use. -1 is the default and represents 20 percent of the available disk space at the time the option is set. The range is -1 to 9,223,372,036,854,775,807.

Returns:

The maximum number of megabytes of hard disk space that the cache can use. -1 is the default and represents 20 percent of the available disk space at the time the option is set. The range is -1 to 9,223,372,036,854,775,807.

setMaxCacheSize

public void setMaxCacheSize(long maxCacheSize)

Set the maximum number of megabytes of hard disk space that the cache can use. -1 is the default and represents 20 percent of the available disk space at the time the option is set. The range is -1 to 9,223,372,036,854,775,807.

Parameters:

maxCacheSize - The new maximum number of megabytes of hard disk space that the cache can use.

getCacheCleanupInterval

public int getCacheCleanupInterval()

Seconds between cache cleanup operations. The default value is 600. The range is 60 (1 minute) to 3153600 (1 year).

Returns:

The number of seconds between cache cleanup operations. The default value is 600. The range is 60 (1 minute) to 3153600 (1 year).

setCacheCleanupInterval

public void setCacheCleanupInterval(int cacheCleanupInterval)

Set the number of seconds between cache cleanup operations. The default value is 600. The range is 60 (1 minute) to 3153600 (1 year).

Parameters:

cacheCleanupInterval - The number of seconds between cache cleanup operations.

getStorageLimitThreshold

public int getStorageLimitThreshold()

Percentage of total disk space allowed for hive. When this percentage of total disk space has been used, no more archives can be added to the hive. -1 is the default and represents 95 percent of total disk space. The range is -1 to 100.

Returns:

The percentage of total disk space allowed for hive. When this percentage of total disk space has been used, no more archives can be added to the hive. -1 is the default and represents 95 percent of total disk space. The range is -1 to 100.

setStorageLimitThreshold

public void setStorageLimitThreshold(int storageLimitThreshold)

Set the percentage of total disk space allowed for the hive. When this percentage of total disk space has been used, no more archives can be added to the hive. The range is -1 (the default, meaning 95 percent of total disk space) to 100.

Parameters:

storageLimitThreshold - The percentage of total disk space allowed for the hive.

getAllowNewArchives

public boolean getAllowNewArchives()

Indicates whether new archive files can be added to the hive. The default is TRUE.

Returns:

Indication of whether new archive files can be added to the hive. The default is TRUE.

setAllowNewArchives

public void setAllowNewArchives(boolean bAllowNewArchives)

Set whether new archive files can be added to the hive. The default is TRUE.

Parameters:

bAllowNewArchives - TRUE if new archives can be added, FALSE if not.

toString

public java.lang.String toString()

Return a string representation of the HiveInfo object.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of the HiveInfo object.