com.pega.pegarules.pub.session

Class PassivationKey

java.lang.Object

com.pega.pegarules.pub.session.PassivationKey

All Implemented Interfaces:

java.io.Serializable

public final class PassivationKey
extends java.lang.Object
implements java.io.Serializable

A four part key used both to uniquely identify PassivationRecords and to query for records with certain key values. Implementers of CustomPassivationMechanism are free to serialize instances of this class, but must pay careful attention to the serialVersionUID if using Java Serialization. Two keys are considered to be equal when all of their fields are equal. A less strict equality operation is defined in the matches(PassivationKey) method.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PassivationKey.Type Keys come in one of four types: PassivationKey.Type.REQUESTOR: This key represents a requestor, or a query for requestor objects.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT
static long	serialVersionUID
static java.lang.String	VERSION

Constructor Summary

Constructors

Constructor and Description
PassivationKey() Deserialization constructor.
PassivationKey(PassivationKey.Type aType, java.lang.String aRequestorId, java.lang.String aThreadName, java.lang.String aPageName) Create a new key.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getPageName()
java.lang.String	getRequestorId()
java.lang.String	getThreadName()
PassivationKey.Type	getType()
int	hashCode()
boolean	matches(PassivationKey aPartialKey) Returns true if this key matches the provided partial key.
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

VERSION

public static final java.lang.String VERSION

COPYRIGHT

public static final java.lang.String COPYRIGHT

See Also:

Constant Field Values

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

PassivationKey

public PassivationKey(PassivationKey.Type aType,
              java.lang.String aRequestorId,
              java.lang.String aThreadName,
              java.lang.String aPageName)

Create a new key.

Parameters:

aType - The type for this key

aRequestorId - The requestor ID

aThreadName - The thread name

aPageName - The page name

Throws:

java.lang.IllegalArgumentException - If the key constraints described in PassivationKey.Type are not held.

PassivationKey

public PassivationKey()

Deserialization constructor.

Method Detail

getRequestorId

public java.lang.String getRequestorId()

getThreadName

public java.lang.String getThreadName()

getPageName

public java.lang.String getPageName()

getType

public PassivationKey.Type getType()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

matches

public boolean matches(PassivationKey aPartialKey)

Returns true if this key matches the provided partial key. A partial key is a PassivationKey object that has unspecified values for some or all of its fields. This method determines matching by applying the following algorithm:

• If aPartialKey.getType() != ANY, it's type must exactly match this key's type.
• If aPartialKey.getRequestor() != null, it's requestor id must exactly match this key's requestor id.
• If aPartialKey.getThreadName() != null, it's thread name must exactly match this key's thread name.
• If aPartialKey.getPageName() != null, it's page name must exactly match this key's page name.

For example, if this is a key for a thread with a requestor ID of H7F8AF0BFDCFD32398D34D13C94E9010A and a name of MyWorkThread, this method would return true for:

• aPartialKey with type THREAD and null requestor ID, thread name, and page name
• aPartialKey with type THREAD and requestor ID of H7F8AF0BFDCFD32398D34D13C94E9010A, a null thread name, and a null page name
• aPartialKey with type THREAD and requestor ID of H7F8AF0BFDCFD32398D34D13C94E9010A, a thread name of MyWorkThread, and a null page name
• aPartialKey with type ANY and null requestor ID, thread name, and page name
• aPartialKey with type ANY and requestor ID of H7F8AF0BFDCFD32398D34D13C94E9010A, a null thread name, and a null page name
• aPartialKey with type ANY and requestor ID of H7F8AF0BFDCFD32398D34D13C94E9010A, a thread name of MyWorkThread, and a null page name

Note that due to the fact that the values of aPartialKey dictate which comparisons are performed, this method is not commutative.

Parameters:

aPartialKey -

Returns:

True if this key matches aPartialKey, false otherwise.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object