org.mule.sdk.api.annotation.source

Enum SourceClusterSupport

java.lang.Object

java.lang.Enum<SourceClusterSupport>

org.mule.sdk.api.annotation.source.SourceClusterSupport

All Implemented Interfaces:

Serializable, Comparable<SourceClusterSupport>

public enum SourceClusterSupport
extends Enum<SourceClusterSupport>

Describes the operation modes that a Source can have when running in cluster mode.

Since:

1.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEFAULT_ALL_NODES Runs on all the cluster nodes by default, but the user can choose to only run on the primary one
DEFAULT_PRIMARY_NODE_ONLY Only runs on the primary node by default, but the user can choose to run on all the nodes
NOT_SUPPORTED The source doesn't support cluster mode and hence only runs on the primary node.

Method Summary

Modifier and Type	Method and Description
static SourceClusterSupport	valueOf(String name) Returns the enum constant of this type with the specified name.
static SourceClusterSupport[]	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

NOT_SUPPORTED

public static final SourceClusterSupport NOT_SUPPORTED

The source doesn't support cluster mode and hence only runs on the primary node.

DEFAULT_ALL_NODES

public static final SourceClusterSupport DEFAULT_ALL_NODES

Runs on all the cluster nodes by default, but the user can choose to only run on the primary one

DEFAULT_PRIMARY_NODE_ONLY

public static final SourceClusterSupport DEFAULT_PRIMARY_NODE_ONLY

Only runs on the primary node by default, but the user can choose to run on all the nodes

Method Detail

values

public static SourceClusterSupport[] 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 (SourceClusterSupport c : SourceClusterSupport.values())
    System.out.println(c);

Returns:

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

valueOf

public static SourceClusterSupport 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