org.adroitlogic.ultraesb.api.interceptor.message

Class AbstractMessageInterceptor

java.lang.Object

org.adroitlogic.ultraesb.api.interceptor.AbstractInterceptor<MessageEvent>

org.adroitlogic.ultraesb.api.interceptor.message.AbstractMessageInterceptor

public abstract class AbstractMessageInterceptor
extends AbstractInterceptor<MessageEvent>

Extend this class and annotate your class with one or more of the following annotations to write any interceptors for the UltraESB message processing flows. If the interceptors AbstractInterceptor.intercept(org.adroitlogic.ultraesb.api.interceptor.Event) method returns false the engine will discard the message and will not either be further intercepted nor processed.

The available annotations are;

• OnRequest - on a request received event in the message flow
• OnResponse - on a response received event in the message flow
• BeforeSequence - before starting the processing of a sequence in the message flow
• AfterSequence - after finishing the processing of a sequence in the message flow
• BeforeEndpoint - before starting the processing of an endpoint in the message flow
• AfterEndpoint - after finishing the processing of an endpoint in the message flow

Since:

2.0.0

Author:

Ruwan

Field Summary

Fields inherited from class org.adroitlogic.ultraesb.api.interceptor.AbstractInterceptor

metrics

Constructor Summary

Constructors

Constructor and Description
AbstractMessageInterceptor()

Method Summary

Methods

Modifier and Type	Method and Description
void	init()
protected boolean	onUnhandledException(MessageEvent event, Exception e) Invoke on unhandled exceptions to define the default behavior of the error handling in the respective event types
void	sendResponse(int code, String content, Message message, Map<String,String> headers) Sends the response back to the client and it is expected to drop the message and hence the interceptor logic should return false if this method is invoked by the interceptor.

Methods inherited from class org.adroitlogic.ultraesb.api.interceptor.AbstractInterceptor

intercept, interceptWithMetricsAndErrorHandling, setErrorHandler, setMetricsReporter

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractMessageInterceptor

public AbstractMessageInterceptor()

Method Detail

onUnhandledException

protected boolean onUnhandledException(MessageEvent event,
                           Exception e)

Description copied from class: AbstractInterceptor

Invoke on unhandled exceptions to define the default behavior of the error handling in the respective event types

Specified by:

onUnhandledException in class AbstractInterceptor<MessageEvent>

Parameters:

event - the event being handled

e - the exception causing this method to be called

Returns:

whether to continue the flow or not

init

public void init()

sendResponse

public void sendResponse(int code,
                String content,
                Message message,
                Map<String,String> headers)

Sends the response back to the client and it is expected to drop the message and hence the interceptor logic should return false if this method is invoked by the interceptor. This method creates a new response message to be sent back if the current message is a request message. If it is a response message it uses the same message to deliver the response back to the client

Parameters:

code - status code of the response, in the case of HTTP the HTTP_SC, for example 500, 404, 200, 401 etc..

content - the message body content

message - current message received by the interceptor in the MessageEvent

headers - the transport level headers to be attached to the response