Errai 3.0.1-SNAPSHOT

org.jboss.errai.bus.server.cluster
Enum ClusterCommands

java.lang.Object
  extended by java.lang.Enum<ClusterCommands>
      extended by org.jboss.errai.bus.server.cluster.ClusterCommands
All Implemented Interfaces:
Serializable, Comparable<ClusterCommands>

public enum ClusterCommands
extends Enum<ClusterCommands>

Author:
Mike Brock

Enum Constant Summary
InvalidRoute
          The InvalidRoute verb is used in a point-to-point message to indicate that the bus was forwarded a message which it is not or no longer responsible for.
MessageForward
          The MessageForward verb is used in a point-to-point or global message which encapsulates a message payload to be forwarded to specific or all buses.
NotifyOwner
          The NotifyOwner verb is sent in response to a WhoHandles broadcast on a point-to-point basis, directly back to the sender of the WhoHandles to notify that the bus is responsible for handling the request session.
WhoHandles
          The WhoHandles verb is a broadcast message to the cluster that asks all buses who is responsible for handling the specified session.
 
Method Summary
static ClusterCommands valueOf(String name)
          Returns the enum constant of this type with the specified name.
static ClusterCommands[] 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

WhoHandles

public static final ClusterCommands WhoHandles
The WhoHandles verb is a broadcast message to the cluster that asks all buses who is responsible for handling the specified session.


NotifyOwner

public static final ClusterCommands NotifyOwner
The NotifyOwner verb is sent in response to a WhoHandles broadcast on a point-to-point basis, directly back to the sender of the WhoHandles to notify that the bus is responsible for handling the request session.


MessageForward

public static final ClusterCommands MessageForward
The MessageForward verb is used in a point-to-point or global message which encapsulates a message payload to be forwarded to specific or all buses.


InvalidRoute

public static final ClusterCommands InvalidRoute
The InvalidRoute verb is used in a point-to-point message to indicate that the bus was forwarded a message which it is not or no longer responsible for.

Method Detail

values

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

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

valueOf

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

Errai 3.0.1-SNAPSHOT

Copyright © 2013-2014 JBoss, a division of Red Hat. All Rights Reserved.