Errai 3.0.1-SNAPSHOT

org.jboss.errai.bus.server.service
Enum ErraiConfigAttribs

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

public enum ErraiConfigAttribs
extends Enum<ErraiConfigAttribs>

Author:
Mike Brock

Enum Constant Summary
AUTO_DISCOVER_SERVICES
           
BUS_BUFFER_ALLOCATION_MODE
          Allocation mode ('direct' or 'heap').
BUS_BUFFER_SEGMENT_COUNT
          The number of segments in absolute terms.
BUS_BUFFER_SEGMENT_SIZE
          The segment size in bytes.
BUS_BUFFER_SIZE
          The buffer size in megabytes.
CLUSTER_NAME
           
CLUSTER_PORT
           
CLUSTERING_PROVIDER
           
DO_LONG_POLL
           
ENABLE_CLUSTERING
           
ENABLE_SSE_SUPPORT
           
ENABLE_WEB_SOCKET_SERVER
           
ERRAI_DISPATCHER_IMPLEMENTATION
           
ERRAI_SESSION_PROVIDER_IMPLEMENTATION
           
HOSTED_MODE_TESTING
           
LONG_POLL_TIMEOUT
           
MESSAGE_QUEUE_TIMEOUT_SECS
           
SATURATION_POLICY
           
SSE_TIMEOUT
           
WEB_SOCKET_PORT
           
WEB_SOCKET_URL
           
WEBSOCKET_SERVLET_CONTEXT_PATH
           
WEBSOCKET_SERVLET_ENABLED
           
 
Field Summary
protected  String attributeName
           
protected  String defaultValue
           
 
Method Summary
 String get(ErraiServiceConfigurator configurator)
           
 String getAttributeName()
           
 boolean getBoolean(ErraiServiceConfigurator configurator)
           
 Integer getInt(ErraiServiceConfigurator configurator)
           
 void set(ErraiServiceConfigurator configurator, String value)
           
static ErraiConfigAttribs valueOf(String name)
          Returns the enum constant of this type with the specified name.
static ErraiConfigAttribs[] 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

ERRAI_DISPATCHER_IMPLEMENTATION

public static final ErraiConfigAttribs ERRAI_DISPATCHER_IMPLEMENTATION

ERRAI_SESSION_PROVIDER_IMPLEMENTATION

public static final ErraiConfigAttribs ERRAI_SESSION_PROVIDER_IMPLEMENTATION

BUS_BUFFER_SIZE

public static final ErraiConfigAttribs BUS_BUFFER_SIZE
The buffer size in megabytes. If this attribute is specified along with BUS_BUFFER_SEGMENT_SIZE then the segment count is inferred by the simple calculation BUF_BUFFER_SIZE / BUS_BUFFER_SEGMENT_SIZE. If the BUS_BUFFER_SEGMENT_COUNT is specified, it will be ignored in the presence of this attribute.

Default value: 32


BUS_BUFFER_SEGMENT_SIZE

public static final ErraiConfigAttribs BUS_BUFFER_SEGMENT_SIZE
The segment size in bytes.

Defualt value: 8


BUS_BUFFER_SEGMENT_COUNT

public static final ErraiConfigAttribs BUS_BUFFER_SEGMENT_COUNT
The number of segments in absolute terms. If this attribute is specified in the absense of BUS_BUFFER_SIZE then the buffer size is inferred by the calculation BUS_BUFFER_SEGMENT_SIZE * BUS_BUFFER_SEGMENT_COUNT


BUS_BUFFER_ALLOCATION_MODE

public static final ErraiConfigAttribs BUS_BUFFER_ALLOCATION_MODE
Allocation mode ('direct' or 'heap'). Direct allocation will allocate memory outside of the JVM heap, while heap allocation will be allocated inside the Java heap. For most situations, heap allocation is preferable. However, if the application is data intensive and requires a substantially large buffer, it is preferable to use a direct buffer. From a throughput perspective, you can expect to pay about a 20% performance penalty. However, your application may show better scaling characteristics with direct buffers. Benchmarking may be necessary to properly tune this setting for your use case and expected load.

Default value: 'direct'


HOSTED_MODE_TESTING

public static final ErraiConfigAttribs HOSTED_MODE_TESTING

DO_LONG_POLL

public static final ErraiConfigAttribs DO_LONG_POLL

LONG_POLL_TIMEOUT

public static final ErraiConfigAttribs LONG_POLL_TIMEOUT

ENABLE_SSE_SUPPORT

public static final ErraiConfigAttribs ENABLE_SSE_SUPPORT

SSE_TIMEOUT

public static final ErraiConfigAttribs SSE_TIMEOUT

ENABLE_WEB_SOCKET_SERVER

public static final ErraiConfigAttribs ENABLE_WEB_SOCKET_SERVER

WEB_SOCKET_URL

public static final ErraiConfigAttribs WEB_SOCKET_URL

WEB_SOCKET_PORT

public static final ErraiConfigAttribs WEB_SOCKET_PORT

WEBSOCKET_SERVLET_ENABLED

public static final ErraiConfigAttribs WEBSOCKET_SERVLET_ENABLED

WEBSOCKET_SERVLET_CONTEXT_PATH

public static final ErraiConfigAttribs WEBSOCKET_SERVLET_CONTEXT_PATH

AUTO_DISCOVER_SERVICES

public static final ErraiConfigAttribs AUTO_DISCOVER_SERVICES

CLUSTER_PORT

public static final ErraiConfigAttribs CLUSTER_PORT

CLUSTER_NAME

public static final ErraiConfigAttribs CLUSTER_NAME

ENABLE_CLUSTERING

public static final ErraiConfigAttribs ENABLE_CLUSTERING

CLUSTERING_PROVIDER

public static final ErraiConfigAttribs CLUSTERING_PROVIDER

MESSAGE_QUEUE_TIMEOUT_SECS

public static final ErraiConfigAttribs MESSAGE_QUEUE_TIMEOUT_SECS

SATURATION_POLICY

public static final ErraiConfigAttribs SATURATION_POLICY
Field Detail

attributeName

protected final String attributeName

defaultValue

protected final String defaultValue
Method Detail

values

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

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

valueOf

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

getBoolean

public boolean getBoolean(ErraiServiceConfigurator configurator)

getInt

public Integer getInt(ErraiServiceConfigurator configurator)

get

public String get(ErraiServiceConfigurator configurator)

set

public void set(ErraiServiceConfigurator configurator,
                String value)

getAttributeName

public String getAttributeName()

Errai 3.0.1-SNAPSHOT

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