com.ibm.websphere.CorrelationSphere
Class CorrelationControler
- java.lang.Object
com.ibm.websphere.CorrelationSphere.CorrelationControler
- public class CorrelationControler
- extends java.lang.Object
Field Summary
Modifier and Type | Field and Description |
---|---|
|
DELIM
|
|
ESCAPE
|
Constructor Summary
Constructor and Description |
---|
CorrelationControler()
Constructor.
|
Method Summary
Modifier and Type | Method and Description |
---|---|
|
endCorrelationSphere(java.lang.String id)
Ends the current correlation sphere and its associated
(nested) workarea.
|
|
getContext()
Gets a context for use with JNDI lookups.
|
|
getCurrentSphereID()
Return the current correlation sphere identifier.
|
|
getParentSphereID()
Return the previous correlation sphere identifier.
|
|
getProperty(java.lang.String key)
Get the property with the specified key from the correlation context
|
|
openNewCorrelationSphere(java.lang.String id)
Associate a new instance of a correlation sphere with the
current thread.
|
|
removeProperty(java.lang.String key)
Removes the property with the specified key from the correlation context
|
|
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
- public static final java.lang.String DELIM
See Also:
ESCAPE
- public static final java.lang.String ESCAPE
See Also:
Constructor Detail
CorrelationControler
- public CorrelationControler()
Constructor.
Method Detail
openNewCorrelationSphere
- public void openNewCorrelationSphere( java.lang.String id)
- throws com.ibm.websphere.CorrelationSphere.InvalidParameterException
- 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
- public void endCorrelationSphere( java.lang.String id)
- 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
- 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
- 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
- public static javax.naming.Context getContext( )
- 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
- public void setProperty(java.lang.String key,
- java.io.Serializable value)
- throws com.ibm.websphere.CorrelationSphere.ReadonlyPropertyException
- 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
- public java.io.Serializable getProperty( java.lang.String key)
- 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
- public void removeProperty(java.lang.String key)
- throws com.ibm.websphere.CorrelationSphere.InvalidParameterException
- 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