Errai 3.0.1-SNAPSHOT

org.jboss.errai.bus.client.protocols
Enum BusCommand

java.lang.Object
  extended by java.lang.Enum<BusCommand>
      extended by org.jboss.errai.bus.client.protocols.BusCommand
All Implemented Interfaces:
Serializable, Comparable<BusCommand>

public enum BusCommand
extends Enum<BusCommand>

Defines the standard protocol commands for interaction between federated MessageBus instances.


Enum Constant Summary
Associate
          The first command sent from a client bus to a remote bus.
Disconnect
           
FinishAssociation
          The command sent from the remote bus back to the client bus to tell it that it should transition to a normal communications mode, as all remote subscription data will have been sent at this point.
Heartbeat
           
RemoteSubscribe
          Notifies the remote bus that a local subscription has been registered.
RemoteUnsubscribe
          Notifies the remote bus that a particular subject is no longer subscribed to locally.
Resend
           
SessionExpired
           
Unknown
           
WebsocketChannelOpen
           
WebsocketChannelVerify
           
WebsocketNegotiationFailed
           
 
Method Summary
static BusCommand valueOf(String name)
          Returns the enum constant of this type with the specified name.
static BusCommand[] 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

Associate

public static final BusCommand Associate
The first command sent from a client bus to a remote bus. This message indicates the bus would like to establish a connection to the queue. There is no authentication associated with this command. Any unauthenticated bus can connect to the bus, as establishing a communication channel is necessary for all communication, including authentication.


FinishAssociation

public static final BusCommand FinishAssociation
The command sent from the remote bus back to the client bus to tell it that it should transition to a normal communications mode, as all remote subscription data will have been sent at this point.


RemoteSubscribe

public static final BusCommand RemoteSubscribe
Notifies the remote bus that a local subscription has been registered. This is an advertisement to the remote bus, so it can update it's routing tables.

Parameters Accepted:

Part Type Description
MessageParts.Subject String The name of the subject being subscribed to


RemoteUnsubscribe

public static final BusCommand RemoteUnsubscribe
Notifies the remote bus that a particular subject is no longer subscribed to locally.

Parameters Accepted:

Part Type Description
MessageParts.Subject String The name of the subject being subscribed to


Heartbeat

public static final BusCommand Heartbeat

Disconnect

public static final BusCommand Disconnect

Resend

public static final BusCommand Resend

SessionExpired

public static final BusCommand SessionExpired

WebsocketChannelVerify

public static final BusCommand WebsocketChannelVerify

WebsocketChannelOpen

public static final BusCommand WebsocketChannelOpen

WebsocketNegotiationFailed

public static final BusCommand WebsocketNegotiationFailed

Unknown

public static final BusCommand Unknown
Method Detail

values

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

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

valueOf

public static BusCommand 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.