org.jboss.soa.esb.message
Interface Context

public interface Context

The context is the section of the message containing information such as session management, transaction information, security data etc. Entries in the context may be ordered. This section should never be passed by reference.

Method Summary

void	clearContext() Clear the context.
java.lang.Object	getContext(java.lang.String key) Retrieves the context value.
java.util.Set<java.lang.String>	getContextKeys() Get the keys in the context.
java.lang.Object	removeContext(java.lang.String key) Remove the context value.
java.lang.Object	setContext(java.lang.String key, java.lang.Object value) Set the context value, replacing existing value if present.

Method Detail

setContext

java.lang.Object setContext(java.lang.String key,
                            java.lang.Object value)

Set the context value, replacing existing value if present.

Parameters:

key - The context key.

value - The context value.

Returns:

the previous value of the context or null if not set.

getContext

java.lang.Object getContext(java.lang.String key)

Retrieves the context value.

Parameters:

key - The context key.

Returns:

The value or null if not present.

removeContext

java.lang.Object removeContext(java.lang.String key)

Remove the context value.

Parameters:

key - The context key.

Returns:

The value of the context, or null if not present.

getContextKeys

java.util.Set<java.lang.String> getContextKeys()

Get the keys in the context.

Returns:

the context keys.

clearContext

void clearContext()

Clear the context.