org.openhubframework.openhub.component.externalcall

Enum ExternalCallKeyType

java.lang.Object

java.lang.Enum<ExternalCallKeyType>

org.openhubframework.openhub.component.externalcall.ExternalCallKeyType

All Implemented Interfaces:

Serializable, Comparable<ExternalCallKeyType>

public enum ExternalCallKeyType
extends Enum<ExternalCallKeyType>

A type of the key to use. See ExternalCallComponent for usage.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CUSTOM A key will not be generated.
ENTITY A key will be generated based on the message object ID (and possibly entity type, if specified), protecting external call from both duplication and obsolete calls, but also possibly unnecessarily skipping calls, if object ID is specified incorrectly.
MESSAGE A key will be generated based on the message source system and correlation ID, protecting external call from duplication, but not from obsolete calls.

Method Summary

Modifier and Type	Method and Description
org.apache.camel.Expression	getExpression()
static ExternalCallKeyType	valueOf(String name) Returns the enum constant of this type with the specified name.
static ExternalCallKeyType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

MESSAGE

public static final ExternalCallKeyType MESSAGE

A key will be generated based on the message source system and correlation ID, protecting external call from duplication, but not from obsolete calls.

ExtCallComponentParams.EXTERNAL_CALL_KEY property will be appended, if specified.

ENTITY

public static final ExternalCallKeyType ENTITY

A key will be generated based on the message object ID (and possibly entity type, if specified), protecting external call from both duplication and obsolete calls, but also possibly unnecessarily skipping calls, if object ID is specified incorrectly.

ExtCallComponentParams.EXTERNAL_CALL_KEY property will be appended, if specified.

CUSTOM

public static final ExternalCallKeyType CUSTOM

A key will not be generated. Instead it will be taken from ExtCallComponentParams.EXTERNAL_CALL_KEY property as is.

Method Detail

values

public static ExternalCallKeyType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ExternalCallKeyType c : ExternalCallKeyType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ExternalCallKeyType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getExpression

public org.apache.camel.Expression getExpression()

Returns:

the expression that will generate this type of the key from an exchange