|
| |
|
| org.mule.api.MuleEventContext
All known Subclasses: org.mule.DefaultMuleEventContext,
| MuleEventContext | | public interface MuleEventContext (Code) | | MuleEventContext is the context object for the current request.
Using the context, developers can send/dispatch/receive events programmatically as
well as manage transactions.
|
| Method Summary | |
| void | dispatchEvent(MuleMessage message)
| | void | dispatchEvent(Object payload)
| | void | dispatchEvent(MuleMessage message, EndpointURI endpoint)
| | void | dispatchEvent(MuleMessage 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.
Parameters:
message - the event message payload to send
Parameters:
endpointName - The endpoint name to disptch the event through. | | void | dispatchEvent(MuleMessage message, OutboundEndpoint endpoint)
| | Transaction | getCurrentTransaction()
| | String | getEncoding()
Gets the encoding for the current message. | | EndpointURI | getEndpointURI()
| | MuleMessage | getMessage()
| | byte[] | getMessageAsBytes()
Returns the contents of the message as a byte array. | | String | getMessageAsString()
| | String | getMessageAsString(String encoding)
| | MuleContext | getMuleContext()
| | OutputStream | getOutputStream()
An outputstream the can optionally be used write response data to an incoming
message. | | Service | getService()
| | MuleSession | getSession()
| | int | getTimeout()
| | Transaction | getTransaction()
| | boolean | isStopFurtherProcessing()
Determines whether the default processing for this event will be executed. | | boolean | isSynchronous()
| | void | markTransactionForRollback()
| | 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 | requestEvent(EndpointURI endpoint, long timeout)
Requests a synchronous receive of an event on the service. | | MuleMessage | sendEvent(Object message)
| | MuleMessage | sendEvent(MuleMessage message)
| | MuleMessage | sendEvent(MuleMessage message, EndpointURI endpoint)
| | MuleMessage | sendEvent(MuleMessage 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
Parameters:
message - the event message payload to send
Parameters:
endpointName - The endpoint name to disptch the event through. | | MuleMessage | sendEvent(MuleMessage message, OutboundEndpoint 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
Parameters:
message - the event message payload to send
Parameters:
endpoint - The endpoint to disptch the event through. | | FutureMessageResult | sendEventAsync(Object message, int timeout)
sends an event request via the configured outbound router for this service.
This method return immediately, but the result of the event invocation
available from the returned a Future result that can be accessed later by the
the returned FutureMessageResult. | | FutureMessageResult | sendEventAsync(MuleMessage message, int timeout)
sends an event request via the configured outbound router for this service.
This method return immediately, but the result of the event invocation
available from the returned a Future result that can be accessed later by the
the returned FutureMessageResult. | | FutureMessageResult | sendEventAsync(MuleMessage message, EndpointURI endpoint, int timeout)
sends an event request via the configured outbound router for this service.
This method return immediately, but the result of the event invocation
available from the returned a Future result that can be accessed later by the
the returned FutureMessageResult. | | FutureMessageResult | sendEventAsync(MuleMessage message, String endpointName, int timeout)
sends an event request via the configured outbound router for this service.
This method return immediately, but the result of the event invocation
available from the returned a Future result that can be accessed later by the
the returned FutureMessageResult. | | void | setStopFurtherProcessing(boolean stopFurtherProcessing)
Determines whether the default processing for this event will be executed. | | Object | transformMessage()
Returns the message transformed into it's recognised or expected format. | | Object | transformMessage(Class expectedType)
Returns the message transformed into it's recognised or expected format. | | byte[] | transformMessageToBytes()
Returns the message transformed into it's recognised or expected format and
then into an array of bytes. | | String | transformMessageToString()
Returns the message transformed into it's recognised or expected format and
then into a String. |
| dispatchEvent | | void dispatchEvent(MuleMessage message) throws MuleException(Code) | | This will dispatch an event asynchronously via the configured outbound
endpoint on the service for this session
Parameters:
message - the message to send
throws:
MuleException - if there is no outbound endpoint configured on theservice or the events fails during dispatch |
| dispatchEvent | | void dispatchEvent(Object payload) throws MuleException(Code) | | This will dispatch an event asynchronously via the configured outbound
endpoint on the service for this session
Parameters:
payload - the message payloadto send
throws:
MuleException - if there is no outbound endpoint configured on theservice or the events fails during dispatch |
| dispatchEvent | | void dispatchEvent(MuleMessage message, EndpointURI endpoint) throws MuleException(Code) | | 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
Parameters:
message - the event message payload to send
Parameters:
endpoint - the endpointUri to dispatc the event to first on the serviceconfiguration and then on the mule manager configuration
throws:
MuleException - if the event fails to be processed by the service orthe transport for the endpoint |
| dispatchEvent | | void dispatchEvent(MuleMessage message, String endpointName) throws MuleException(Code) | | 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.
Parameters:
message - the event message payload to send
Parameters:
endpointName - The endpoint name to disptch the event through. This willbe looked up first on the service configuration and then on themule manager configuration
throws:
MuleException - if the event fails to be processed by the service orthe transport for the endpoint |
| dispatchEvent | | void dispatchEvent(MuleMessage message, OutboundEndpoint endpoint) throws MuleException(Code) | | 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
Parameters:
message - the event message payload to send
Parameters:
endpoint - The endpoint name to disptch the event through.
throws:
MuleException - if the event fails to be processed by the service orthe transport for the endpoint |
| getCurrentTransaction | | Transaction getCurrentTransaction()(Code) | | Returns the current transaction (if any) for the session
the current transaction for the session or null if there is notransaction in progress |
| getEncoding | | String getEncoding()(Code) | | Gets the encoding for the current message. For potocols that send encoding
Information with the message, this method should be overriden to expose the
transport encoding, otherwise the default encoding in the Mule configuration
will be used
the encoding for this message. This method must never return null |
| getEndpointURI | | EndpointURI getEndpointURI()(Code) | | Returns a reference to the Endpoint Uri for this context This is the endpoint
on which the event was received
the receive endpoint for this event context |
| getMessage | | MuleMessage getMessage()(Code) | | Returns the message payload for this event
the message payload for this event |
| getMessageAsBytes | | byte[] getMessageAsBytes() throws MuleException(Code) | | Returns the contents of the message as a byte array.
the contents of the message as a byte array
throws:
MuleException - if the message cannot be converted into an array of bytes |
| getMessageAsString | | String getMessageAsString() throws MuleException(Code) | | Returns the message contents as a string This method will use the encoding set
on the event
the message contents as a string
throws:
MuleException - if the message cannot be converted into a string |
| getMessageAsString | | String getMessageAsString(String encoding) throws MuleException(Code) | | Returns the message contents as a string
Parameters:
encoding - The encoding to use when transforming the message the message contents as a string
throws:
MuleException - if the message cannot be converted into a string |
| getOutputStream | | OutputStream getOutputStream()(Code) | | An outputstream the can optionally be used write response data to an incoming
message.
an output strem if one has been made available by the message receiverthat received the message |
| getTimeout | | int getTimeout()(Code) | | Get the timeout value associated with the event
the timeout for the event |
| getTransaction | | Transaction getTransaction()(Code) | | Returns the transaction for the current event or null if there is no
transaction in progresss
the transaction for the current event or null if there is notransaction in progresss |
| isStopFurtherProcessing | | boolean isStopFurtherProcessing()(Code) | | Determines whether the default processing for this event will be executed. By
default, the Mule server will route events according to a components
configuration. The user can override this behaviour by obtaining a reference
to the MuleEvent context, either by implementing
org.mule.api.lifecycle.Callable or calling
UMOManager.getEventContext to obtain the MuleEventContext for
the current thread. The user can programmatically control how events are
dispached.
Returns true is the user has set stopFurtherProcessing.
See Also: org.mule.api.context.UMOManager
See Also: MuleEventContext
See Also: org.mule.api.lifecycle.Callable |
| isSynchronous | | boolean isSynchronous()(Code) | | Determines whether the was sent synchrounously or not
true if the event is synchronous |
| requestEvent | | MuleMessage requestEvent(InboundEndpoint endpoint, long timeout) throws MuleException(Code) | | Requests a synchronous receive of an event on the service.
Parameters:
endpoint - the endpoint identifying the endpointUri on which the eventwill be received
Parameters:
timeout - time in milliseconds before the request times out The requested event or null if the request times out
throws:
MuleException - if the request operation fails |
| requestEvent | | MuleMessage requestEvent(String endpointName, long timeout) throws MuleException(Code) | | Requests a synchronous receive of an event on the service.
Parameters:
endpointName - the endpoint identifying the endpointUri on which theevent will be received
Parameters:
timeout - time in milliseconds before the request timesout The requested event or null if the request times out
throws:
MuleException - if the request operation fails |
| requestEvent | | MuleMessage requestEvent(EndpointURI endpoint, long timeout) throws MuleException(Code) | | Requests a synchronous receive of an event on the service.
Parameters:
endpoint - the endpointUri on which the event will be received
Parameters:
timeout - time in milliseconds before the request timesout The requested event or null if the request times out
throws:
MuleException - if the request operation fails |
| sendEvent | | MuleMessage sendEvent(Object message) throws MuleException(Code) | | This will send an event via the configured outbound router on the service
Parameters:
message - the message to send the result of the send if any
throws:
MuleException - if there is no outbound endpoint configured on theservice or the events fails during dispatch |
| sendEvent | | MuleMessage sendEvent(MuleMessage message) throws MuleException(Code) | | 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
Parameters:
message - the message payload to send the return Message from the call or null if there was no result
throws:
MuleException - if the event fails to be processed by the service orthe transport for the endpoint |
| sendEvent | | MuleMessage sendEvent(MuleMessage message, EndpointURI endpoint) throws MuleException(Code) | | 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
Parameters:
message - the event message payload to send
Parameters:
endpoint - The endpointUri to disptch the event through the return Message from the call or null if there was no result
throws:
MuleException - if the event fails to be processed by the service orthe transport for the endpoint |
| sendEvent | | MuleMessage sendEvent(MuleMessage message, String endpointName) throws MuleException(Code) | | 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
Parameters:
message - the event message payload to send
Parameters:
endpointName - The endpoint name to disptch the event through. This willbe looked up first on the service configuration and then on themule manager configuration the return Message from the call or null if there was no result
throws:
MuleException - if the event fails to be processed by the service orthe transport for the endpoint |
| sendEvent | | MuleMessage sendEvent(MuleMessage message, OutboundEndpoint endpoint) throws MuleException(Code) | | 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
Parameters:
message - the event message payload to send
Parameters:
endpoint - The endpoint to disptch the event through. the return Message from the call or null if there was no result
throws:
MuleException - if the event fails to be processed by the service orthe transport for the endpoint |
| sendEventAsync | | FutureMessageResult sendEventAsync(Object message, int timeout) throws MuleException(Code) | | sends an event request via the configured outbound router for this service.
This method return immediately, but the result of the event invocation
available from the returned a Future result that can be accessed later by the
the returned FutureMessageResult. the Future messageResult can be queried at
any time to check that the invocation has completed. A timeout is associated
with the invocation, which is the maximum time in milli-seconds that the
invocation should take to complete
Parameters:
message - the object that is the payload of the event
Parameters:
timeout - how long to block in milliseconds waiting for a result the result message if any of the invocation
throws:
org.mule.api.MuleException - if the dispatch fails or the components ortransfromers cannot be found
See Also: FutureMessageResult |
| sendEventAsync | | FutureMessageResult sendEventAsync(MuleMessage message, int timeout) throws MuleException(Code) | | sends an event request via the configured outbound router for this service.
This method return immediately, but the result of the event invocation
available from the returned a Future result that can be accessed later by the
the returned FutureMessageResult. the Future messageResult can be queried at
any time to check that the invocation has completed. A timeout is associated
with the invocation, which is the maximum time in milli-seconds that the
invocation should take to complete
Parameters:
message - the MuleMessage of the event
Parameters:
timeout - how long to block in milliseconds waiting for a result the result message if any of the invocation
throws:
org.mule.api.MuleException - if the dispatch fails or the components ortransfromers cannot be found
See Also: FutureMessageResult |
| sendEventAsync | | FutureMessageResult sendEventAsync(MuleMessage message, EndpointURI endpoint, int timeout) throws MuleException(Code) | | sends an event request via the configured outbound router for this service.
This method return immediately, but the result of the event invocation
available from the returned a Future result that can be accessed later by the
the returned FutureMessageResult. the Future messageResult can be queried at
any time to check that the invocation has completed. A timeout is associated
with the invocation, which is the maximum time in milli-seconds that the
invocation should take to complete
Parameters:
message - the MuleMessage of the event
Parameters:
endpoint - the endpointUri to dispatch to
Parameters:
timeout - how long to block in milliseconds waiting for a result the result message if any of the invocation
throws:
org.mule.api.MuleException - if the dispatch fails or the components ortransfromers cannot be found
See Also: FutureMessageResult |
| sendEventAsync | | FutureMessageResult sendEventAsync(MuleMessage message, String endpointName, int timeout) throws MuleException(Code) | | sends an event request via the configured outbound router for this service.
This method return immediately, but the result of the event invocation
available from the returned a Future result that can be accessed later by the
the returned FutureMessageResult. the Future messageResult can be queried at
any time to check that the invocation has completed. A timeout is associated
with the invocation, which is the maximum time in milli-seconds that the
invocation should take to complete
Parameters:
message - the MuleMessage of the event
Parameters:
endpointName - The endpoint name to disptch the event through. This willbe looked up first on the service configuration and then on themule manager configuration
Parameters:
timeout - how long to block in milliseconds waiting for a result the result message if any of the invocation
throws:
org.mule.api.MuleException - if the dispatch fails or the components ortransfromers cannot be found
See Also: FutureMessageResult |
| setStopFurtherProcessing | | void setStopFurtherProcessing(boolean stopFurtherProcessing)(Code) | | Determines whether the default processing for this event will be executed. By
default, the Mule server will route events according to a components
configuration. The user can override this behaviour by obtaining a reference
to the MuleEvent context, either by implementing
org.mule.api.lifecycle.Callable or calling
UMOManager.getEventContext to obtain the MuleEventContext for
the current thread. The user can programmatically control how events are
dispached.
Parameters:
stopFurtherProcessing - the value to set. |
| transformMessage | | Object transformMessage(Class expectedType) throws TransformerException(Code) | | Returns the message transformed into it's recognised or expected format. The
transformer used is the one configured on the endpoint through which this
event was received.
Parameters:
expectedType - The class type required for the return object. This paramjust provides a convienient way to manage type casting oftransformed objects the message transformed into it's recognised or expected format.
throws:
org.mule.api.transformer.TransformerException - if a failure occurs orif the return type is not the same as the expected type in thetransformer
See Also: org.mule.api.transformer.Transformer |
| transformMessageToBytes | | byte[] transformMessageToBytes() throws TransformerException(Code) | | Returns the message transformed into it's recognised or expected format and
then into an array of bytes. The transformer used is the one configured on the
endpoint through which this event was received.
the message transformed into it's recognised or expected format as anarray of bytes.
throws:
TransformerException - if a failure occurs in the transformer
See Also: org.mule.api.transformer.Transformer |
| transformMessageToString | | String transformMessageToString() throws TransformerException(Code) | | Returns the message transformed into it's recognised or expected format and
then into a String. The transformer used is the one configured on the endpoint
through which this event was received. This method will use the encoding set
on the event
the message transformed into it's recognised or expected format as aStrings.
throws:
TransformerException - if a failure occurs in the transformer
See Also: org.mule.api.transformer.Transformer |
|
|
|