|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface MuleSession
MuleSession
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 MuleEventContext
which is obtainable via the
UMOManager
or by implementing
org.mule.api.lifecycle.Callable
.
Method Summary | |
---|---|
MuleEvent |
createOutboundEvent(MuleMessage message,
OutboundEndpoint endpoint,
MuleEvent previousEvent)
Creates an outbound event for this session |
void |
dispatchEvent(MuleEvent event)
Depending on the session state this methods either Passes an event asynchronously to the next available Mule component in the pool or via the endpoint configured for the event |
void |
dispatchEvent(MuleMessage message)
This will dispatch an event asynchronously via the configured outbound endpoint on the service for this session |
void |
dispatchEvent(MuleMessage message,
OutboundEndpoint endpoint)
Depending on the session state this methods either Passes an event asynchronously to the next available Mule component in the pool or via the endpoint configured for the event |
void |
dispatchEvent(MuleMessage message,
String endpointName)
Depending on the session state this methods either Passes an event asynchronously to the next available Mule component in the pool or via the endpoint configured for the event |
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 |
SecurityContext |
getSecurityContext()
The security context for this session. |
Service |
getService()
Returns the Service associated with the session in its current execution |
boolean |
isValid()
Determines if this session is valid. |
Object |
removeProperty(Object key)
Will retrieve a session level property and remove it from the session |
MuleMessage |
requestEvent(InboundEndpoint endpoint,
long timeout)
Requests a synchronous receive of an event on the service |
MuleMessage |
requestEvent(String endpointName,
long timeout)
Requests a synchronous receive of an event on the service |
MuleMessage |
sendEvent(MuleEvent event)
Depending on the session state this methods either Passes an event synchronously to the next available Mule component in the pool or via the endpoint configured for the event |
MuleMessage |
sendEvent(MuleMessage message)
This will send an event via the configured outbound endpoint on the service for this session |
MuleMessage |
sendEvent(MuleMessage message,
OutboundEndpoint endpoint)
Depending on the session state this methods either Passes an event synchronously to the next available Mule component in the pool or via the endpoint configured for the event |
MuleMessage |
sendEvent(MuleMessage message,
String endpointName)
Depending on the session state this methods either Passes an event synchronously to the next available Mule component 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(SecurityContext context)
The security context for this session. |
void |
setValid(boolean value)
Determines if this session is valid. |
Method Detail |
---|
Service getService()
Service
MuleMessage sendEvent(MuleMessage message) throws MuleException
message
- the message to send
MuleException
- if there is no outbound endpoint configured
on the service or the events fails during dispatchMuleMessage sendEvent(MuleEvent event) throws MuleException
event
- the event to process
MuleException
- if the event fails to be processed by the service or
the transport for the endpointMuleMessage sendEvent(MuleMessage message, OutboundEndpoint endpoint) throws MuleException
message
- the event message payload to sendendpoint
- The endpoint to disptch the event through
MuleException
- if the event fails to be processed by the service or
the transport for the endpointMuleMessage sendEvent(MuleMessage message, String endpointName) throws MuleException
message
- the event message payload to sendendpointName
- The endpoint name to disptch the event through. This will
be looked up first on the service configuration and then on the
mule manager configuration
MuleException
- if the event fails to be processed by the service or
the transport for the endpointvoid dispatchEvent(MuleMessage message) throws MuleException
message
- the message to send
MuleException
- if there is no outbound endpoint configured on the
service or the events fails during dispatchvoid dispatchEvent(MuleEvent event) throws MuleException
event
- the event message payload to send first on the service
configuration and then on the mule manager configuration
MuleException
- if the event fails to be processed by the service or
the transport for the endpointvoid dispatchEvent(MuleMessage message, OutboundEndpoint endpoint) throws MuleException
message
- the event message payload to sendendpoint
- The endpoint name to disptch the event through
MuleException
- if the event fails to be processed by the service or
the transport for the endpointvoid dispatchEvent(MuleMessage message, String endpointName) throws MuleException
message
- the event message payload to sendendpointName
- The endpoint name to disptch the event through. This will
be looked up first on the service configuration and then on the
mule manager configuration
MuleException
- if the event fails to be processed by the service or
the transport for the endpointMuleMessage requestEvent(InboundEndpoint endpoint, long timeout) throws MuleException
endpoint
- the endpoint identifing the endpointUri on ewhich the event
will be receivedtimeout
- time in milliseconds before the request timesout
MuleException
- if the request operation failsMuleMessage requestEvent(String endpointName, long timeout) throws MuleException
endpointName
- the endpoint name identifing the endpointUri on ewhich the
event will be receivedtimeout
- time in milliseconds before the request timesout
MuleException
- if the request operation failsboolean isValid()
void setValid(boolean value)
value
- true if the service is functioning properly, false otherwiseMuleEvent createOutboundEvent(MuleMessage message, OutboundEndpoint endpoint, MuleEvent previousEvent) throws MuleException
message
- the event messgae payloadendpoint
- the endpoint to send/dispatch throughpreviousEvent
- the previous event (if any) on this session
MuleException
- if the evnet cannot be createdString getId()
void setSecurityContext(SecurityContext context)
context
- the context for this session or null if the request is not
secure.SecurityContext getSecurityContext()
void setProperty(Object key, Object value)
key
- the key for the object data being stored on the sessionvalue
- the value of the session dataObject getProperty(Object key)
key
- the key for the object data being stored on the session
Object removeProperty(Object key)
key
- the key for the object data being stored on the session
Iterator getPropertyNames()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |