org.openhubframework.openhub.api.asynch

Class AsynchRouteBuilder

java.lang.Object

org.openhubframework.openhub.api.asynch.AsynchRouteBuilder

public final class AsynchRouteBuilder
extends Object

Helper class for creating input route for asynch. messages.

Create new instance with calling newInstance(ServiceExtEnum, String, String, AsynchResponseProcessor, DataFormatDefinition) method, sets parameters and finally call build(RouteBuilder) method for creating route definition.

Author:

Petr Juza, Tomas Hanus

Method Summary

Methods

Modifier and Type	Method and Description
org.apache.camel.model.RouteDefinition	build(org.apache.camel.builder.RouteBuilder route) Builds new route definition for processing incoming asynchronous messages.
org.apache.camel.Expression	getFunnelValue()
String	getInUri()
org.apache.camel.Expression	getObjectIdExpr()
String	getOperation()
String	getPolicyRef()
org.apache.camel.model.DataFormatDefinition	getResponseMarshalling()
AsynchResponseProcessor	getResponseProcessor()
String	getRouteId()
ServiceExtEnum	getServiceType()
org.apache.camel.Processor[]	getValidators()
static AsynchRouteBuilder	newInstance(ServiceExtEnum serviceType, String operation, String inUri, AsynchResponseProcessor responseProcessor, org.apache.camel.model.DataFormatDefinition responseMarshalling) Creates new instance with basic mandatory parameters.
String	toString()
AsynchRouteBuilder	withFunnelValue(org.apache.camel.Expression funnelValue) Sets funnel value.
AsynchRouteBuilder	withGuaranteedOrder() Marks the route for processing in guaranteed order by message timestamp.
AsynchRouteBuilder	withGuaranteedOrderWithoutFailed() Marks the route for processing in guaranteed order by message timestamp.
AsynchRouteBuilder	withObjectIdExpr(org.apache.camel.Expression objectIdExpr) Sets expression for evaluating object ID.
AsynchRouteBuilder	withPolicyRef(String policyRef) Sets (Spring bean) reference to policy, e.g.
AsynchRouteBuilder	withResponseProcessor(AsynchResponseProcessor responseProcessor, org.apache.camel.model.DataFormatDefinition responseMarshalling) Sets response processor.
AsynchRouteBuilder	withRouteId(String routeId) Sets route ID.
AsynchRouteBuilder	withValidator(org.apache.camel.Processor... validator) Sets array of validators, for example XPathValidator.

Methods inherited from class java.lang.Object

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

Method Detail

newInstance

public static AsynchRouteBuilder newInstance(ServiceExtEnum serviceType,
                             String operation,
                             String inUri,
                             AsynchResponseProcessor responseProcessor,
                             org.apache.camel.model.DataFormatDefinition responseMarshalling)

Creates new instance with basic mandatory parameters.

Parameters:

serviceType - service type

operation - operation name with processing route

inUri - the from URI of this route

responseProcessor - the response processor

responseMarshalling - the response marshalling

Returns:

new instance

withRouteId

public AsynchRouteBuilder withRouteId(@Nullable
                             String routeId)

Sets route ID. If not defined then it will be created in standard way by calling AbstractBasicRoute.getInRouteId(ServiceExtEnum, String).

Parameters:

routeId - the route ID

withValidator

public AsynchRouteBuilder withValidator(@Nullable
                               org.apache.camel.Processor... validator)

Sets array of validators, for example XPathValidator.

Parameters:

validator - the validator

withObjectIdExpr

public AsynchRouteBuilder withObjectIdExpr(@Nullable
                                  org.apache.camel.Expression objectIdExpr)

Sets expression for evaluating object ID.

Parameters:

objectIdExpr - expression for evaluating object ID

See Also:

Message.getObjectId()

withFunnelValue

public AsynchRouteBuilder withFunnelValue(@Nullable
                                 org.apache.camel.Expression funnelValue)

Sets funnel value.

Parameters:

funnelValue - the funnel value

See Also:

Message.getFunnelValue()

withGuaranteedOrder

public AsynchRouteBuilder withGuaranteedOrder()

Marks the route for processing in guaranteed order by message timestamp.

withGuaranteedOrderWithoutFailed

public AsynchRouteBuilder withGuaranteedOrderWithoutFailed()

Marks the route for processing in guaranteed order by message timestamp.

withResponseProcessor

public AsynchRouteBuilder withResponseProcessor(AsynchResponseProcessor responseProcessor,
                                       org.apache.camel.model.DataFormatDefinition responseMarshalling)

Sets response processor. If not set then general response AsynchResponse will be used.

Parameters:

responseProcessor - the response processor

responseMarshalling - the response marshalling

withPolicyRef

public AsynchRouteBuilder withPolicyRef(@Nullable
                               String policyRef)

Sets (Spring bean) reference to policy, e.g. authorization policy.

Parameters:

policyRef - the reference to policy

getInUri

public String getInUri()

getServiceType

public ServiceExtEnum getServiceType()

getOperation

public String getOperation()

getRouteId

@Nullable
public String getRouteId()

getValidators

@Nullable
public org.apache.camel.Processor[] getValidators()

getObjectIdExpr

@Nullable
public org.apache.camel.Expression getObjectIdExpr()

getFunnelValue

@Nullable
public org.apache.camel.Expression getFunnelValue()

getResponseProcessor

@Nullable
public AsynchResponseProcessor getResponseProcessor()

getResponseMarshalling

@Nullable
public org.apache.camel.model.DataFormatDefinition getResponseMarshalling()

getPolicyRef

@Nullable
public String getPolicyRef()

build

public final org.apache.camel.model.RouteDefinition build(org.apache.camel.builder.RouteBuilder route)

Builds new route definition for processing incoming asynchronous messages.

Parameters:

route - current route builder

Returns:

route definition

toString

public String toString()

Overrides:

toString in class Object