com.starteam
Class ArtifactCacheManager.Client

java.lang.Object
  com.starteam.ArtifactCacheManager.Client

Enclosing class:

ArtifactCacheManager

public static final class ArtifactCacheManager.Client
extends java.lang.Object

Establish the context of a Client Application. If interested, each Client Application must provide a unique context uniqueness defined by Application Name, e.g. Caliber, Topaz, Zuma, SCTM, etc A client application will create and retain a single context instance per server. Alternately, a client application may choose to allow the ArtifactCacheManager to hold onto its context (keyed by name). An application should register its Client Context with the ArtifactCacheManager immediately after starting up the Manager, and before requesting baselines. Subsequent baseline registrations will cache the set of types defined by the client

Method Summary

void	register(ViewMember.Type.WebCacheViewMemberType type) Register a type that the client application is interested in Any/all baseline(s) opened after this registration will automatically cause the registered type for this client application to be cached in the WebServer.
void	register(ViewMember.Type.WebCacheViewMemberType[] types) Register a set of types that the client application is interested in.
void	unregister(ViewMember.Type.WebCacheViewMemberType type) Unregister a type that the client application may have lost interest in.
void	unregister(ViewMember.Type.WebCacheViewMemberType[] types) Unregister a set of types that the client application may have lost interest in.

Methods inherited from class java.lang.Object

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

Method Detail

register

public void register(ViewMember.Type.WebCacheViewMemberType[] types)

Register a set of types that the client application is interested in. Any/all baseline(s) opened after this registration will automatically cause the registered types for this client application to be cached in the WebServer. This is equivalent to an application specifically invoking the api ArtifactCache.cacheViewMembers(com.starteam.ViewMember.Type[]) Additionally, if the client has registered for Item events, then the client will be notified accordingly, but only for registered types Note also that a client may register more types over the lifetime of the web application via this api. Back to back calls to this api aggregate types

Parameters:

types - the Types of interest

register

public void register(ViewMember.Type.WebCacheViewMemberType type)

Register a type that the client application is interested in Any/all baseline(s) opened after this registration will automatically cause the registered type for this client application to be cached in the WebServer. This is equivalent to an application specifically invoking the api ArtifactCache.cacheViewMembers(com.starteam.ViewMember.Type[]) Additionally, if the client has registered for Item events, then the client will be notified accrodinngly, but only for registered types Note also that a client may register more types over the lifetime of the web application via this api. Back to back calls to this api aggregate types

Parameters:

type - the Type of interest

unregister

public void unregister(ViewMember.Type.WebCacheViewMemberType[] types)

Unregister a set of types that the client application may have lost interest in. Any/all baseline(s) opened after this will not cache types that were dropped by virtue of this un-registration. Existing baselines in memory will not be affected by unregistering types post-facto.

Parameters:

types - the Types of interest

unregister

public void unregister(ViewMember.Type.WebCacheViewMemberType type)

Unregister a type that the client application may have lost interest in. Any/all baseline(s) opened after this will not cache types that were dropped by virtue of this un-registration. Existing baselines in memory will not be affected by unregistering types post-facto.

Parameters:

type - the Type of interest