Package org.apache.manifoldcf.crawler.interfaces

Class CacheKeyFactory

java.lang.Object

org.apache.manifoldcf.core.interfaces.CacheKeyFactory

org.apache.manifoldcf.agents.interfaces.CacheKeyFactory

org.apache.manifoldcf.crawler.interfaces.CacheKeyFactory

public class CacheKeyFactory
extends CacheKeyFactory

This class just represents a central place where cache keys are assembled. All methods are static.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	_rcsid

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CacheKeyFactory()

Method Summary

Modifier and Type	Method	Description
static java.lang.String	makeAuthorityConnectionKey(java.lang.String connectionName)	Construct a key which represents an individual authority connection.
static java.lang.String	makeAuthorityConnectionsKey()	Construct a key which represents the general list of authority connectors.
static java.lang.String	makeJobIDKey(java.lang.String jobID)	Construct a key which represents the fixed kind of data for an individual job.
static java.lang.String	makeJobsKey()	Construct a key which represents the general list of jobs - for queries that depend on the fixed kind of job data, not the dynamic data (e.g.
static java.lang.String	makeJobStatusKey()	Construct a key which represents the collective statuses of all jobs.
static java.lang.String	makeNotificationConnectionKey(java.lang.String connectionName)	Construct a key which represents an individual notification connection.
static java.lang.String	makeNotificationConnectionsKey()	Construct a key which represents the general list of notification connectors.
static java.lang.String	makeRepositoryConnectionKey(java.lang.String connectionName)	Construct a key which represents an individual repository connection.
static java.lang.String	makeRepositoryConnectionsKey()	Construct a key which represents the general list of repository connectors.

Methods inherited from class org.apache.manifoldcf.agents.interfaces.CacheKeyFactory

makeOutputConnectionKey, makeOutputConnectionsKey, makeTransformationConnectionKey, makeTransformationConnectionsKey

Methods inherited from class org.apache.manifoldcf.core.interfaces.CacheKeyFactory

makeDatabaseKey, makeDatabaseKey, makeTableKey

Methods inherited from class java.lang.Object

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

Field Detail

_rcsid

public static final java.lang.String _rcsid

See Also:

Constant Field Values

Constructor Detail

CacheKeyFactory

protected CacheKeyFactory()

Method Detail

makeAuthorityConnectionsKey

public static java.lang.String makeAuthorityConnectionsKey()

Construct a key which represents the general list of authority connectors.

Returns:

the cache key.

makeAuthorityConnectionKey

public static java.lang.String makeAuthorityConnectionKey(java.lang.String connectionName)

Construct a key which represents an individual authority connection.

Parameters:

connectionName - is the name of the connection.

Returns:

the cache key.

makeRepositoryConnectionsKey

public static java.lang.String makeRepositoryConnectionsKey()

Construct a key which represents the general list of repository connectors.

Returns:

the cache key.

makeRepositoryConnectionKey

public static java.lang.String makeRepositoryConnectionKey(java.lang.String connectionName)

Construct a key which represents an individual repository connection.

Parameters:

connectionName - is the name of the connector.

Returns:

the cache key.

makeNotificationConnectionsKey

public static java.lang.String makeNotificationConnectionsKey()

Construct a key which represents the general list of notification connectors.

Returns:

the cache key.

makeNotificationConnectionKey

public static java.lang.String makeNotificationConnectionKey(java.lang.String connectionName)

Construct a key which represents an individual notification connection.

Parameters:

connectionName - is the name of the connector.

Returns:

the cache key.

makeJobsKey

public static java.lang.String makeJobsKey()

Construct a key which represents the general list of jobs - for queries that depend on the fixed kind of job data, not the dynamic data (e.g. status)

Returns:

the cache key.

makeJobIDKey

public static java.lang.String makeJobIDKey(java.lang.String jobID)

Construct a key which represents the fixed kind of data for an individual job.

Parameters:

jobID - is the job identifier.

Returns:

the cache key.

makeJobStatusKey

public static java.lang.String makeJobStatusKey()

Construct a key which represents the collective statuses of all jobs.

Returns:

the cache key.