com.ibm.websphere.CorrelationSphere

Class CorrelationControler

  1. java.lang.Object
  2. extended bycom.ibm.websphere.CorrelationSphere.CorrelationControler

  1. public class CorrelationControler
  2. extends java.lang.Object

Field Summary

Modifier and Type Field and Description
  1. static
  2. java.lang.String
DELIM
  1. static
  2. java.lang.String
ESCAPE

Constructor Summary

Constructor and Description
CorrelationControler()
Constructor.

Method Summary

Modifier and Type Method and Description
  1. void
endCorrelationSphere(java.lang.String id)
Ends the current correlation sphere and its associated (nested) workarea.
  1. static
  2. javax.naming.Context
getContext()
Gets a context for use with JNDI lookups.
  1. java.lang.String
getCurrentSphereID()
Return the current correlation sphere identifier.
  1. java.lang.String
getParentSphereID()
Return the previous correlation sphere identifier.
  1. java.io.Serializable
getProperty(java.lang.String key)
Get the property with the specified key from the correlation context
  1. void
openNewCorrelationSphere(java.lang.String id)
Associate a new instance of a correlation sphere with the current thread.
  1. void
removeProperty(java.lang.String key)
Removes the property with the specified key from the correlation context
  1. void
setProperty(java.lang.String key,java.io.Serializable value)
Sets the property in the correlation context using the specified key and value
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DELIM

  1. public static final java.lang.String DELIM
See Also:

ESCAPE

  1. public static final java.lang.String ESCAPE
See Also:

Constructor Detail

CorrelationControler

  1. public CorrelationControler()
Constructor.

Method Detail

openNewCorrelationSphere

  1. public void openNewCorrelationSphere( java.lang.String id)
  2. throws com.ibm.websphere.CorrelationSphere.InvalidParameterException
  3. com.ibm.websphere.CorrelationSphere.NoActiveContextException
Associate a new instance of a correlation sphere with the current thread. This action creates a nested workarea if necesary.
Parameters:
id - The identifier for this new correlation sphere.
Throws:
InvalidParameterException
NoActiveContextException

endCorrelationSphere

  1. public void endCorrelationSphere( java.lang.String id)
  2. throws com.ibm.websphere.CorrelationSphere.InvalidParameterException
Ends the current correlation sphere and its associated (nested) workarea.
Parameters:
id - The identifier for this correlation sphere.
Throws:
InvalidParameterException

getCurrentSphereID

  1. public java.lang.String getCurrentSphereID( )
Return the current correlation sphere identifier. If no event correlation sphere instance is associated with the thread, a null is returned.
Returns:
The identification of the current sphere

getParentSphereID

  1. public java.lang.String getParentSphereID( )
Return the previous correlation sphere identifier. If no event correlation sphere instance is associated with the thread, a null is returned.
Returns:
The identifier of the parent correlation sphere (or null if none)

getContext

  1. public static javax.naming.Context getContext( )
  2. throws com.ibm.websphere.CorrelationSphere.NoContextException
Gets a context for use with JNDI lookups. Separated into method to aid unit-testing
Returns:
Context for use with JNDI lookups
Throws:
NoContextException

setProperty

  1. public void setProperty(java.lang.String key,
  2. java.io.Serializable value)
  3. throws com.ibm.websphere.CorrelationSphere.ReadonlyPropertyException
  4. com.ibm.websphere.CorrelationSphere.NoActiveContextException
Sets the property in the correlation context using the specified key and value
Parameters:
key - A string that identifies the property
value - The non-null serializable value of the property
Throws:
ReadonlyPropertyException
NoActiveContextException

getProperty

  1. public java.io.Serializable getProperty( java.lang.String key)
  2. throws com.ibm.websphere.CorrelationSphere.InvalidParameterException
Get the property with the specified key from the correlation context
Parameters:
key - Identifies the property whose value is requested.
Returns:
The value of the property (null if key does not exist)
Throws:
InvalidParameterException

removeProperty

  1. public void removeProperty(java.lang.String key)
  2. throws com.ibm.websphere.CorrelationSphere.InvalidParameterException
  3. com.ibm.websphere.CorrelationSphere.FixedPropertyException
Removes the property with the specified key from the correlation context
Parameters:
key - Identifies the property whose value is requested.
Throws:
InvalidParameterException
FixedPropertyException