com.starteam

Class CacheAgent

java.lang.Object

com.starteam.CacheAgent

public final class CacheAgent
extends java.lang.Object

Describes the features of a Cache Agent, including the type of content it caches, the projects supported, and whether or not it caches object property content.

Method Summary

Modifier and Type	Method and Description
boolean	cachesFileContent() returns true if this cache agent caches file content
boolean	cachesObjectPropertyContent() returns true if this cache agent caches object property content
boolean	cachesProject(Project project) Indicate if the Cache Agent is caching content for the given StarTeam server project.
boolean	cachesType(Item.Type type) Indicate if the object type is cached by the Cache Agent.
java.lang.String	getHostName() Gets the host address of this cache agent.
int	getPort() returns the port number at which this cache agent is located
java.lang.String	getVersion() returns version information for this Cache Agent
boolean	isRoot() returns true if this a a Root Cache Agent

Methods inherited from class java.lang.Object

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

Method Detail

getPort

public int getPort()

returns the port number at which this cache agent is located

Returns:

int the port number at which this cache agent is located

getHostName

public java.lang.String getHostName()

Gets the host address of this cache agent.

Returns:

The host address of this cache agent.

getVersion

public java.lang.String getVersion()

returns version information for this Cache Agent

Returns:

String version information for this Cache Agent

cachesFileContent

public boolean cachesFileContent()

returns true if this cache agent caches file content

Returns:

boolean true if this cache agent caches file content

cachesObjectPropertyContent

public boolean cachesObjectPropertyContent()

returns true if this cache agent caches object property content

Returns:

boolean true if this cache agent caches object property content

isRoot

public boolean isRoot()

returns true if this a a Root Cache Agent

Returns:

boolean true if this a a Root Cache Agent

cachesType

public boolean cachesType(Item.Type type)

Indicate if the object type is cached by the Cache Agent.

Parameters:

type - Object type (e.g., ChangeRequest).

Returns:

boolean True if the Cache Agent is caching all object types or the specified type.

cachesProject

public boolean cachesProject(Project project)

Indicate if the Cache Agent is caching content for the given StarTeam server project. The method performs a case-insensitive project name comparison, leveraging the fact that some names cached by the Cache Agent may be patterns with "*" wildcards.

Parameters:

project - A project.

Returns:

boolean