Module org.mule.runtime.extensions.api

Package org.mule.runtime.extension.api.runtime.parameter

Enum Class OutboundCorrelationStrategy

java.lang.Object

java.lang.Enum<OutboundCorrelationStrategy>

org.mule.runtime.extension.api.runtime.parameter.OutboundCorrelationStrategy

All Implemented Interfaces:

Serializable, Comparable<OutboundCorrelationStrategy>, Constable

@MinMuleVersion("4.1")
public enum OutboundCorrelationStrategy
extends Enum<OutboundCorrelationStrategy>

Lists the possible strategies to determine the correlation id that should be sent on an outbound operation which supports correlation.

Operations should invoke the getOutboundCorrelationId(CorrelationInfo, String) method to obtain the actual value. If empty, then no correlation id should be sent.

Since:

1.1

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALWAYS	This strategy always yields a correlation id, regardless of CorrelationInfo.isOutboundCorrelationEnabled()
AUTO	Whether to send a correlation id or not is defined by checking the CorrelationInfo.isOutboundCorrelationEnabled() method.
NEVER	This strategy always returns Optional.empty()

Method Summary

Modifier and Type	Method	Description
abstract Optional<String>	getOutboundCorrelationId(CorrelationInfo correlationInfo, String customCorrelationId)	Determines the correlation id that should be sent through an outbound operation (if any).
static OutboundCorrelationStrategy	valueOf(String name)	Returns the enum constant of this class with the specified name.
static OutboundCorrelationStrategy[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

AUTO

public static final OutboundCorrelationStrategy AUTO

Whether to send a correlation id or not is defined by checking the CorrelationInfo.isOutboundCorrelationEnabled() method. If that method returns false, then an Optional.empty() value is returned. Otherwise, the same behavior as ALWAYS will be used

ALWAYS

public static final OutboundCorrelationStrategy ALWAYS

This strategy always yields a correlation id, regardless of CorrelationInfo.isOutboundCorrelationEnabled()

NEVER

public static final OutboundCorrelationStrategy NEVER

This strategy always returns Optional.empty()

Method Details

values

public static OutboundCorrelationStrategy[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static OutboundCorrelationStrategy valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getOutboundCorrelationId

public abstract Optional<String> getOutboundCorrelationId(CorrelationInfo correlationInfo,
 String customCorrelationId)

Determines the correlation id that should be sent through an outbound operation (if any).

Depending on each strategy implementation, this method might return a customCorrelationId, the value of CorrelationInfo.getCorrelationId() or an Optional.empty() value.

Parameters:

correlationInfo - the current correlation info

customCorrelationId - a custom correlation id set at the operation level. Use null if no custom value defined

Returns:

an optioanl correlation id value