|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
UMOSession
is the context in which a request is executed. The
session manages the marshalling of events to and from components This object is
not usually referenced by client code directly. If needed Components should manage
events via the UMOEventContext
which is obtainable via the
UMOManager
or by implementing
org.mule.umo.lifecycle.Callable
.
Method Summary | |
UMOEvent |
createOutboundEvent(UMOMessage message,
UMOImmutableEndpoint endpoint,
UMOEvent previousEvent)
Creates an outbound event for this session |
void |
dispatchEvent(UMOEvent event)
Depending on the session state this methods either Passes an event asynchronously to the next available Mule UMO in the pool or via the endpoint configured for the event |
void |
dispatchEvent(UMOMessage message)
This will dispatch an event asynchronously via the configured outbound endpoint on the component for this session |
void |
dispatchEvent(UMOMessage message,
String endpointName)
Depending on the session state this methods either Passes an event asynchronously to the next available Mule UMO in the pool or via the endpoint configured for the event |
void |
dispatchEvent(UMOMessage message,
UMOImmutableEndpoint endpoint)
Depending on the session state this methods either Passes an event asynchronously to the next available Mule UMO in the pool or via the endpoint configured for the event |
UMOComponent |
getComponent()
Returns the UMOComponent associated with the session in its current execution |
String |
getId()
Returns the unique id for this session |
Object |
getProperty(Object key)
Will retrieve a session level property. |
Iterator |
getPropertyNames()
Returns an iterater of property keys for the session properties on this session |
UMOSecurityContext |
getSecurityContext()
The security context for this session. |
boolean |
isValid()
Determines if this session is valid. |
UMOMessage |
receiveEvent(String endpointName,
long timeout)
Requests a synchronous receive of an event on the component |
UMOMessage |
receiveEvent(UMOImmutableEndpoint endpoint,
long timeout)
Requests a synchronous receive of an event on the component |
Object |
removeProperty(Object key)
Will retrieve a session level property and remove it from the session |
UMOMessage |
sendEvent(UMOEvent event)
Depending on the session state this methods either Passes an event synchronously to the next available Mule UMO in the pool or via the endpoint configured for the event |
UMOMessage |
sendEvent(UMOMessage message)
This will send an event via the configured outbound endpoint on the component for this session |
UMOMessage |
sendEvent(UMOMessage message,
String endpointName)
Depending on the session state this methods either Passes an event synchronously to the next available Mule UMO in the pool or via the endpoint configured for the event |
UMOMessage |
sendEvent(UMOMessage message,
UMOImmutableEndpoint endpoint)
Depending on the session state this methods either Passes an event synchronously to the next available Mule UMO in the pool or via the endpoint configured for the event |
void |
setProperty(Object key,
Object value)
Will set a session level property. |
void |
setSecurityContext(UMOSecurityContext context)
The security context for this session. |
void |
setValid(boolean value)
Determines if this session is valid. |
Method Detail |
public UMOComponent getComponent()
UMOComponent
public UMOMessage sendEvent(UMOMessage message) throws UMOException
message
- the message to send
UMOException
- if there is no outbound endpoint configured
on the component or the events fails during dispatchpublic UMOMessage sendEvent(UMOEvent event) throws UMOException
event
- the event to process
UMOException
- if the event fails to be processed by the component or
the transport for the endpointpublic UMOMessage sendEvent(UMOMessage message, UMOImmutableEndpoint endpoint) throws UMOException
message
- the event message payload to sendendpoint
- The endpoint to disptch the event through
UMOException
- if the event fails to be processed by the component or
the transport for the endpointpublic UMOMessage sendEvent(UMOMessage message, String endpointName) throws UMOException
message
- the event message payload to sendendpointName
- The endpoint name to disptch the event through. This will
be looked up first on the component configuration and then on the
mule manager configuration
UMOException
- if the event fails to be processed by the component or
the transport for the endpointpublic void dispatchEvent(UMOMessage message) throws UMOException
message
- the message to send
UMOException
- if there is no outbound endpoint configured on the
component or the events fails during dispatchpublic void dispatchEvent(UMOEvent event) throws UMOException
event
- the event message payload to send first on the component
configuration and then on the mule manager configuration
UMOException
- if the event fails to be processed by the component or
the transport for the endpointpublic void dispatchEvent(UMOMessage message, UMOImmutableEndpoint endpoint) throws UMOException
message
- the event message payload to sendendpoint
- The endpoint name to disptch the event through
UMOException
- if the event fails to be processed by the component or
the transport for the endpointpublic void dispatchEvent(UMOMessage message, String endpointName) throws UMOException
message
- the event message payload to sendendpointName
- The endpoint name to disptch the event through. This will
be looked up first on the component configuration and then on the
mule manager configuration
UMOException
- if the event fails to be processed by the component or
the transport for the endpointpublic UMOMessage receiveEvent(UMOImmutableEndpoint endpoint, long timeout) throws UMOException
endpoint
- the endpoint identifing the endpointUri on ewhich the event
will be receivedtimeout
- time in milliseconds before the request timesout
UMOException
- if the request operation failspublic UMOMessage receiveEvent(String endpointName, long timeout) throws UMOException
endpointName
- the endpoint name identifing the endpointUri on ewhich the
event will be receivedtimeout
- time in milliseconds before the request timesout
UMOException
- if the request operation failspublic boolean isValid()
public void setValid(boolean value)
value
- true if the component is functioning properly, false otherwisepublic UMOEvent createOutboundEvent(UMOMessage message, UMOImmutableEndpoint endpoint, UMOEvent previousEvent) throws UMOException
message
- the event messgae payloadendpoint
- the endpoint to send/dispatch throughpreviousEvent
- the previous event (if any) on this session
UMOException
- if the evnet cannot be createdpublic String getId()
public void setSecurityContext(UMOSecurityContext context)
context
- the context for this session or null if the request is not
secure.public UMOSecurityContext getSecurityContext()
public void setProperty(Object key, Object value)
key
- the key for the object data being stored on the sessionvalue
- the value of the session datapublic Object getProperty(Object key)
key
- the key for the object data being stored on the session
public Object removeProperty(Object key)
key
- the key for the object data being stored on the session
public Iterator getPropertyNames()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |