org.adroitlogic.ultraesb.api.interceptor

Class AbstractInterceptor<T extends Event>

java.lang.Object

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

Direct Known Subclasses:

AbstractArtifactInterceptor, AbstractMessageInterceptor, AbstractServerInterceptor

public abstract class AbstractInterceptor<T extends Event>
extends Object

The root class for all the interceptors.

Since:

2.0.0

Author:

Ruwan

Field Summary

Fields

Modifier and Type	Field and Description
protected InterceptorMetricsReporter	metrics

Constructor Summary

Constructors

Constructor and Description
AbstractInterceptor()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract boolean	intercept(T event) Intercepts messages, server lifecycle and artifact lifecycle at the point defined by the interceptor annotations
boolean	interceptWithMetricsAndErrorHandling(T event) Internal method that is used by the ESB to invoke the interceptor, which in-turn will call the #intercept(T) method providing error handling capabilities to the intercept method invocation exceptions
protected abstract boolean	onUnhandledException(T event, Exception e) Invoke on unhandled exceptions to define the default behavior of the error handling in the respective event types
void	setErrorHandler(InterceptorErrorHandler<T> errorHandler) Sets the error handler for the interceptor
void	setMetricsReporter(InterceptorMetricsReporter metricsReporter) Sets the metrics reporter for the interceptor

Methods inherited from class java.lang.Object

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

Field Detail

metrics

protected InterceptorMetricsReporter metrics

Constructor Detail

AbstractInterceptor

public AbstractInterceptor()

Method Detail

intercept

protected abstract boolean intercept(T event)

Intercepts messages, server lifecycle and artifact lifecycle at the point defined by the interceptor annotations

Parameters:

event - the event describing the state for the interception

Returns:

boolean true if the server can continue this action false to stop the action

onUnhandledException

protected abstract boolean onUnhandledException(T event,
                           Exception e)

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

Parameters:

event - the event being handled

e - the exception causing this method to be called

Returns:

whether to continue the flow or not

interceptWithMetricsAndErrorHandling

public boolean interceptWithMetricsAndErrorHandling(T event)

Internal method that is used by the ESB to invoke the interceptor, which in-turn will call the #intercept(T) method providing error handling capabilities to the intercept method invocation exceptions

Parameters:

event - the event which is intercepted

Returns:

whether to continue the action or flow

setErrorHandler

public void setErrorHandler(InterceptorErrorHandler<T> errorHandler)

Sets the error handler for the interceptor

Parameters:

errorHandler - the error handler for handling interception errors

setMetricsReporter

public void setMetricsReporter(InterceptorMetricsReporter metricsReporter)

Sets the metrics reporter for the interceptor

Parameters:

metricsReporter - the metrics reporting implementation to be used