Package com.linecorp.centraldogma.server.plugin

Enum Class PluginTarget

java.lang.Object

java.lang.Enum<PluginTarget>

com.linecorp.centraldogma.server.plugin.PluginTarget

All Implemented Interfaces:

Serializable, Comparable<PluginTarget>, Constable

public enum PluginTarget
extends Enum<PluginTarget>

Targets that a Plugin is applied to which replica.

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
ALL_REPLICAS	Run the Plugin on the all replicas.
LEADER_ONLY	Run the Plugin on the leader replica.
ZONE_LEADER_ONLY	Run the Plugin on the leader replica for a zone specified in CentralDogmaConfig.zone().

Method Summary

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

ALL_REPLICAS

public static final PluginTarget ALL_REPLICAS

Run the Plugin on the all replicas. It would be started after the replica is started and would be stopped before the replica is stopped.

LEADER_ONLY

public static final PluginTarget LEADER_ONLY

Run the Plugin on the leader replica. It would be started after the replica has taken the leadership and would be stopped when the replica is about to release the leadership.

ZONE_LEADER_ONLY

public static final PluginTarget ZONE_LEADER_ONLY

Run the Plugin on the leader replica for a zone specified in CentralDogmaConfig.zone(). It would be started after the replica has taken the zone leadership and would be stopped when the replica is about to release the zone leadership.

Method Details

values

public static PluginTarget[] 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 PluginTarget 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