Errai 3.0.1-SNAPSHOT

org.jboss.errai.common.client.protocols
Enum MessageParts

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

public enum MessageParts
extends Enum<MessageParts>

The parts comprising the core messaging protocol used by ErraiBus.

As a general rule, you should avoid using the words reserved by this protocol.


Enum Constant Summary
AdditionalDetails
          Additional details associated with an error message (for instance: stack trace information)
CapabilitiesFlags
          A list of capabilities (comma-seperate string) of the capabilities of the remote bus.
CommandType
          Specifies the specific command within the service that is being requested.
ConnectionSessionKey
          Used mainly for web sockets to negotiate which session the web socket is associated with.
ErrorMessage
          Specifies an error message.
ErrorTo
          Specifies the subject to send error messages to.
MessageText
          Specifies any specific message text to be communicated as part of the command being sent.
PollFrequency
          The frequency with which short-polling clients should poll the remote bus.
PriorityProcessing
          If this attribute is present, the bus should give priority to processing it and not subject it to window matching.
Reason
           
RemoteServices
           
ReplyTo
          Specifies what subject which should be replied-to in response to the message being sent.
SessionID
          A unique identifier for identifying the session with which a message is associated.
StackTrace
          Specifies stack trace data in String form.
Subject
          Specifies a subject being referenced for use in an command.
SubjectsList
          A list of subjects.
Throwable
          The throwable object in case of an error
ToSubject
          Specifies the intended recipient queue for the message.
Value
          Default value payload.
WebSocketToken
           
WebSocketURL
           
 
Method Summary
static MessageParts valueOf(String name)
          Returns the enum constant of this type with the specified name.
static MessageParts[] 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

CommandType

public static final MessageParts CommandType
Specifies the specific command within the service that is being requested. This is an optional element, and is not required for signal-only services. However it's use is encouraged for building multi-command services.


Subject

public static final MessageParts Subject
Specifies a subject being referenced for use in an command. This should not be confused with ToSubject, which is used for message routing.


SubjectsList

public static final MessageParts SubjectsList
A list of subjects.


RemoteServices

public static final MessageParts RemoteServices
Since:
3.0

CapabilitiesFlags

public static final MessageParts CapabilitiesFlags
A list of capabilities (comma-seperate string) of the capabilities of the remote bus.


PollFrequency

public static final MessageParts PollFrequency
The frequency with which short-polling clients should poll the remote bus.


Value

public static final MessageParts Value
Default value payload. Used mostly for higher-level APIs.


SessionID

public static final MessageParts SessionID
A unique identifier for identifying the session with which a message is associated.


MessageText

public static final MessageParts MessageText
Specifies any specific message text to be communicated as part of the command being sent.


ReplyTo

public static final MessageParts ReplyTo
Specifies what subject which should be replied-to in response to the message being sent. Usually handled automatically with conversations.


ToSubject

public static final MessageParts ToSubject
Specifies the intended recipient queue for the message.


ErrorMessage

public static final MessageParts ErrorMessage
Specifies an error message.


AdditionalDetails

public static final MessageParts AdditionalDetails
Additional details associated with an error message (for instance: stack trace information)


ErrorTo

public static final MessageParts ErrorTo
Specifies the subject to send error messages to.


Throwable

public static final MessageParts Throwable
The throwable object in case of an error


StackTrace

public static final MessageParts StackTrace
Specifies stack trace data in String form.


Reason

public static final MessageParts Reason

PriorityProcessing

public static final MessageParts PriorityProcessing
If this attribute is present, the bus should give priority to processing it and not subject it to window matching.


ConnectionSessionKey

public static final MessageParts ConnectionSessionKey
Used mainly for web sockets to negotiate which session the web socket is associated with.


WebSocketURL

public static final MessageParts WebSocketURL

WebSocketToken

public static final MessageParts WebSocketToken
Method Detail

values

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

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

valueOf

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