org.openhubframework.openhub.component.externalcall

Class ExternalCallComponent

java.lang.Object

org.openhubframework.openhub.component.externalcall.ExternalCallComponent

All Implemented Interfaces:

org.apache.camel.CamelContextAware, org.apache.camel.Component

public class ExternalCallComponent
extends Object
implements org.apache.camel.Component

Apache Camel Component for wrapping external calls with checks for duplicate and outdated calls.

The URI format is the following: extcall:[keyType]:[targetURI] where keyType can be one of:

1. message - to generate a key based on message source system and correlation ID, effectively providing duplicate call protection, but not obsolete call protection
2. entity - to generate a key based on message objectId property, providing both duplicate call protection and obsolete call protection
3. custom - to use a custom key provided in the ExtCallComponentParams.EXTERNAL_CALL_KEY exchange property

In the first two cases (message and entity), if the ExtCallComponentParams.EXTERNAL_CALL_KEY exchange property is provided, it will be appended to the generated key.

By default, the targetURI is used as the operation. This can be changed by providing an optional ExtCallComponentParams.EXTERNAL_CALL_OPERATION exchange property. The targetURI will still be the URI that is called, if the external call is not skipped, but the duplicate/obsolete protection logic will use the ExtCallComponentParams.EXTERNAL_CALL_OPERATION value for checking, if the call should be made or skipped.

Constructor Summary

Constructors

Constructor and Description
ExternalCallComponent()

Method Summary

Modifier and Type	Method and Description
org.apache.camel.ComponentConfiguration	createComponentConfiguration()
org.apache.camel.EndpointConfiguration	createConfiguration(String uri)
org.apache.camel.Endpoint	createEndpoint(String uri)
org.apache.camel.CamelContext	getCamelContext()
void	setCamelContext(org.apache.camel.CamelContext camelContext)
boolean	useRawUri()

Methods inherited from class java.lang.Object

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

Constructor Detail

ExternalCallComponent

public ExternalCallComponent()

Method Detail

createEndpoint

public org.apache.camel.Endpoint createEndpoint(String uri)
                                         throws Exception

Specified by:

createEndpoint in interface org.apache.camel.Component

Throws:

Exception

useRawUri

public boolean useRawUri()

Specified by:

useRawUri in interface org.apache.camel.Component

createConfiguration

public org.apache.camel.EndpointConfiguration createConfiguration(String uri)
                                                           throws Exception

Specified by:

createConfiguration in interface org.apache.camel.Component

Throws:

Exception

createComponentConfiguration

public org.apache.camel.ComponentConfiguration createComponentConfiguration()

Specified by:

createComponentConfiguration in interface org.apache.camel.Component

setCamelContext

public void setCamelContext(org.apache.camel.CamelContext camelContext)

Specified by:

setCamelContext in interface org.apache.camel.CamelContextAware

getCamelContext

public org.apache.camel.CamelContext getCamelContext()

Specified by:

getCamelContext in interface org.apache.camel.CamelContextAware