org.openhubframework.openhub.api.route

Class AbstractBasicRoute

java.lang.Object

org.apache.camel.builder.BuilderSupport

org.apache.camel.builder.RouteBuilder

org.apache.camel.spring.SpringRouteBuilder

org.openhubframework.openhub.api.route.AbstractBasicRoute

All Implemented Interfaces:

org.apache.camel.RoutesBuilder, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

Direct Known Subclasses:

AbstractExtRoute, AsyncHelloRoute, AsynchInMessageRoute, AsynchMessageRoute, ContextCallRoute, DirectCallWsRoute, ExceptionTranslationRoute, PingRoute, SyncHelloRoute, VersionRoute

public abstract class AbstractBasicRoute
extends org.apache.camel.spring.SpringRouteBuilder

Parent route definition that defines common route rules, e.g. exception policy, error handling etc.

Author:

Petr Juza

Field Summary

Fields

Modifier and Type	Field and Description
static String	EXTERNAL_ROUTE_SUFFIX Suffix for outbound routes with external systems.
static String	IN_ROUTE_SUFFIX Suffix for asynchronous incoming routes.
static String	OUT_ROUTE_SUFFIX Suffix for asynchronous outbound routes.
static String	ROUTE_ID_DELIMITER Delimiter in generated route id for service and operation name.
static String	ROUTE_SUFFIX Suffix for synchronous routes.

Fields inherited from class org.apache.camel.builder.RouteBuilder

log

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractBasicRoute()

Method Summary

Modifier and Type	Method and Description
protected void	addEventNotifier(org.apache.camel.spi.EventNotifier eventNotifier) Adds new event notifier.
void	configure()
protected abstract void	doConfigure() Defines routes and route specific configuration.
protected void	doErrorHandling() Defines global (better to say semi-global because it's scoped for one route builder) exception policy and common error handling.
String	exceptionHandling(Exception ex, Boolean asynch) Handles specified exception.
protected <T> T	getBean(Class<T> type) Returns bean by its type from registry.
static String	getExternalRouteId(ExternalSystemExtEnum system, String operationName) Gets route ID for routes which communicates with external systems.
static String	getInRouteId(ServiceExtEnum service, String operationName) Gets route ID for asynchronous incoming routes.
protected String	getInWsUri(QName qName) Gets "from" URI for handling incoming WS messages with default '' bean.
protected String	getInWsUri(QName qName, String params) Gets "from" URI for handling incoming WS messages with default '' bean.
static String	getOutRouteId(ServiceExtEnum service, String operationName) Gets route ID for asynchronous outbound routes.
protected String	getOutWsSoap12Uri(String connectionUri, String messageSenderRef) Shorthand for getOutWsSoap12Uri(String, String, String).
protected String	getOutWsSoap12Uri(String connectionUri, String messageSenderRef, String soapAction) Constructs a "to" URI for sending WS messages to external systems, i.e., Camel Web Service Endpoint URI for contacting an external system via SOAP 1.2.
protected String	getOutWsUri(String connectionUri, String messageSenderRef) Shorthand for getOutWsUri(String, String, String).
protected String	getOutWsUri(String connectionUri, String messageSenderRef, String soapAction) Constructs a "to" URI for sending WS messages to external systems, i.e., Camel Web Service Endpoint URI for contacting an external system via SOAP 1.1.
static String	getRouteId(ServiceExtEnum service, String operationName) Gets route ID for synchronous routes.
boolean	isAsynch(Boolean asynch)
void	printMessageHistory(org.apache.camel.Exchange exchange)
String	toString() Returns class name of the route implementation class.

Methods inherited from class org.apache.camel.spring.SpringRouteBuilder

getApplicationContext, lookup, lookup, setApplicationContext, transactionErrorHandler, transactionErrorHandler, transactionErrorHandler, transactionErrorHandler

Methods inherited from class org.apache.camel.builder.RouteBuilder

addRoutes, addRoutesToCamelContext, checkInitialized, configureRest, configureRests, configureRoute, configureRoutes, createContainer, errorHandler, from, from, from, from, fromF, getContext, getRestCollection, getRestConfigurations, getRouteCollection, includeRoutes, intercept, interceptFrom, interceptFrom, interceptSendToEndpoint, onCompletion, onException, onException, populateRests, populateRoutes, rest, rest, restConfiguration, restConfiguration, setErrorHandlerBuilder, setRestCollection, setRouteCollection

Methods inherited from class org.apache.camel.builder.BuilderSupport

bean, bean, bean, bean, body, body, bodyAs, constant, createErrorHandlerBuilder, deadLetterChannel, deadLetterChannel, defaultErrorHandler, endpoint, endpoint, endpoints, endpoints, exceptionMessage, exchangeProperty, faultBody, faultBodyAs, getErrorHandlerBuilder, header, language, loggingErrorHandler, loggingErrorHandler, loggingErrorHandler, loggingErrorHandler, method, method, method, method, noErrorHandler, outBody, outBody, property, regexReplaceAll, regexReplaceAll, sendTo, setContext, setContext, simple, simple, simpleF, simpleF, systemProperty, systemProperty, xpath, xpath

Methods inherited from class java.lang.Object

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

Field Detail

ROUTE_SUFFIX

public static final String ROUTE_SUFFIX

Suffix for synchronous routes.

See Also:

Constant Field Values

IN_ROUTE_SUFFIX

public static final String IN_ROUTE_SUFFIX

Suffix for asynchronous incoming routes.

See Also:

Constant Field Values

OUT_ROUTE_SUFFIX

public static final String OUT_ROUTE_SUFFIX

Suffix for asynchronous outbound routes.

See Also:

Constant Field Values

EXTERNAL_ROUTE_SUFFIX

public static final String EXTERNAL_ROUTE_SUFFIX

Suffix for outbound routes with external systems.

See Also:

Constant Field Values

ROUTE_ID_DELIMITER

public static final String ROUTE_ID_DELIMITER

Delimiter in generated route id for service and operation name.

See Also:

getRouteId(ServiceExtEnum, String), getInRouteId(ServiceExtEnum, String), getOutRouteId(ServiceExtEnum, String), getExternalRouteId(ExternalSystemExtEnum, String), Constant Field Values

Constructor Detail

AbstractBasicRoute

protected AbstractBasicRoute()

Method Detail

configure

public final void configure()
                     throws Exception

Specified by:

configure in class org.apache.camel.builder.RouteBuilder

Throws:

Exception

doErrorHandling

protected void doErrorHandling()
                        throws Exception

Defines global (better to say semi-global because it's scoped for one route builder) exception policy and common error handling.

Default implementation catches common Exception and if it's synchronous message (see AsynchConstants.ASYNCH_MSG_HEADER) then redirect to AsynchConstants.URI_EX_TRANSLATION. If it's asynchronous message then determines according to exception's type if redirect to AsynchConstants.URI_ERROR_FATAL or AsynchConstants.URI_ERROR_HANDLING route URI.

Throws:

Exception - can be thrown during configuration

printMessageHistory

@Handler
public void printMessageHistory(org.apache.camel.Exchange exchange)

isAsynch

@Handler
public boolean isAsynch(@Header(value="asynchMsgProcessing")
                                 Boolean asynch)

exceptionHandling

@Handler
public String exceptionHandling(Exception ex,
                                         @Header(value="asynchMsgProcessing")
                                         Boolean asynch)

Handles specified exception.

Parameters:

ex - the thrown exception

asynch - true if it's asynchronous message processing otherwise synchronous processing

Returns:

next route URI

doConfigure

protected abstract void doConfigure()
                             throws Exception

Defines routes and route specific configuration.

Throws:

Exception - can be thrown during configuration

getOutWsUri

protected String getOutWsUri(String connectionUri,
                             String messageSenderRef,
                             String soapAction)

Constructs a "to" URI for sending WS messages to external systems, i.e., Camel Web Service Endpoint URI for contacting an external system via SOAP 1.1.

Parameters:

connectionUri - the URI to connect to the external system, e.g.: http://localhost:8080/vfmock/ws/mm7

messageSenderRef - the message sender ref (bean id/name in Spring context)

soapAction - the SOAP action to be invoked, can be null for implicit handling of SOAP messages by the external system

Returns:

the Camel Endpoint URI for producing (sending via To) SOAP messages to external system

getOutWsUri

protected String getOutWsUri(String connectionUri,
                             String messageSenderRef)

Shorthand for getOutWsUri(String, String, String).

Parameters:

connectionUri - the URI connection

messageSenderRef - the reference of message sender

Returns:

URI of WS compliant with SOAP 1.1 version

getOutWsSoap12Uri

protected String getOutWsSoap12Uri(String connectionUri,
                                   String messageSenderRef)

Shorthand for getOutWsSoap12Uri(String, String, String).

Parameters:

connectionUri - the URI connection

messageSenderRef - the reference of message sender

Returns:

URI of WS compliant with SOAP 1.2 version

getOutWsSoap12Uri

protected String getOutWsSoap12Uri(String connectionUri,
                                   String messageSenderRef,
                                   String soapAction)

Constructs a "to" URI for sending WS messages to external systems, i.e., Camel Web Service Endpoint URI for contacting an external system via SOAP 1.2.

Parameters:

connectionUri - the URI to connect to the external system, e.g.: http://localhost:8080/vfmock/ws/mm7

messageSenderRef - the message sender ref (bean id/name in Spring context)

soapAction - the SOAP action to be invoked, can be null for implicit handling of SOAP messages by the external system

Returns:

the Camel Endpoint URI for producing (sending via To) SOAP messages to external system

getInWsUri

protected String getInWsUri(QName qName)

Gets "from" URI for handling incoming WS messages with default '' bean.

Parameters:

qName - the operation QName (namespace + local part)

Returns:

from URI

getInWsUri

protected String getInWsUri(QName qName,
                            @Nullable
                            String params)

Gets "from" URI for handling incoming WS messages with default '' bean.

Parameters:

qName - the operation QName (namespace + local part)

params - the endpoint URI parameters (without leading signs ? or &)

Returns:

from URI

getRouteId

public static String getRouteId(ServiceExtEnum service,
                                String operationName)

Gets route ID for synchronous routes.

Parameters:

service - the service name

operationName - the operation name

Returns:

route ID

See Also:

getInRouteId(ServiceExtEnum, String), getOutRouteId(ServiceExtEnum, String), getExternalRouteId(ExternalSystemExtEnum, String)

getInRouteId

public static String getInRouteId(ServiceExtEnum service,
                                  String operationName)

Gets route ID for asynchronous incoming routes.

Parameters:

service - the service name

operationName - the operation name

Returns:

route ID

See Also:

getOutRouteId(ServiceExtEnum, String)

getOutRouteId

public static String getOutRouteId(ServiceExtEnum service,
                                   String operationName)

Gets route ID for asynchronous outbound routes.

Parameters:

service - the service name

operationName - the operation name

Returns:

route ID

See Also:

getInRouteId(ServiceExtEnum, String)

getExternalRouteId

public static String getExternalRouteId(ExternalSystemExtEnum system,
                                        String operationName)

Gets route ID for routes which communicates with external systems.

Parameters:

system - the external system

operationName - the operation name

Returns:

route ID

See Also:

getRouteId(ServiceExtEnum, String)

addEventNotifier

protected final void addEventNotifier(org.apache.camel.spi.EventNotifier eventNotifier)

Adds new event notifier.

Use manual adding via this method or use EventNotifier annotation for automatic registration. Don't use both.

Parameters:

eventNotifier - the event notifier

getBean

protected final <T> T getBean(Class<T> type)

Returns bean by its type from registry.

Type Parameters:

T - as class of type

Parameters:

type - the type of the registered bean

Returns:

bean of specified type

toString

public String toString()

Returns class name of the route implementation class.

This is because of using bean(this, "createResponseForGetCounterData") - if there is no toString() method then StackOverflowError is thrown.

Overrides:

toString in class org.apache.camel.builder.RouteBuilder

Returns:

class name