pl.bristleback.server.bristle.config
Class BristleConstants

java.lang.Object
  pl.bristleback.server.bristle.config.BristleConstants

public final class BristleConstants
extends java.lang.Object

Base Bristleback JWebsocket Plugin constants. Values of those constants are names of plugin settings, plugin token namespace and maybe more in future.

Created on: 2010-10-04 17:21:29

Author:

Wojciech Niemiec

Field Summary

static java.lang.String	ACTION_NAME_TOKEN_VARIABLE Element of token used for dispatching incoming messages.
static java.lang.String	ACTION_PACKAGE_SETTING_NAME Configuration element name for action package location definition.
static java.lang.String	BRISTLE_PLUGIN_NAMESPACE Bristle plugin namespace, used to indicate that token should be processed by Bristle plugin.
static java.lang.String	CONFIG_FILE_LOCATION_CONTEXT_VARIABLE_NAME This settings can be set as one of context parameter in 'web.xml' in web application.
static java.lang.String	CONNECTOR_RIGHTS_SET_VARIABLE_NAME Name of connector rights set token element created when connector is connecting.
static java.lang.String	EXCEPTION_HANDLER_SETTING_KEY_PREFIX Configuration element, prefix of exception handler name setting.
static java.lang.String	MESSAGE_SENDER_SETTING_KEY_PREFIX Configuration element, prefix of message sender name setting.
static java.lang.String	SERVER_STATE_LISTENER_SETTING_KEY_PREFIX Configuration element, prefix of server state listener name setting.
static java.lang.String	SPRING_INTEGRATION_CONTEXT_VARIABLE_NAME This settings can be set as one of context parameter in 'web.xml' in web application.

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

BRISTLE_PLUGIN_NAMESPACE

public static final java.lang.String BRISTLE_PLUGIN_NAMESPACE

Bristle plugin namespace, used to indicate that token should be processed by Bristle plugin.

See Also:

Constant Field Values

ACTION_NAME_TOKEN_VARIABLE

public static final java.lang.String ACTION_NAME_TOKEN_VARIABLE

Element of token used for dispatching incoming messages. Every token has to contain this element.

See Also:

Constant Field Values

MESSAGE_SENDER_SETTING_KEY_PREFIX

public static final java.lang.String MESSAGE_SENDER_SETTING_KEY_PREFIX

Configuration element, prefix of message sender name setting. Used in default implementation of MessageContainerResolver interface. There can be multiple message senders used in the same time. Senders can be obtained in two ways, by creating new instance of sender (message sender class name required) or by retrieving Spring bean (message sender Spring bean reference required). Format of message senders setting key is: bristle.message.sender[index]. Format of the value: 'senderName: senderClassType' or 'senderName: senderSpringBeanName'.

See Also:

Constant Field Values

ACTION_PACKAGE_SETTING_NAME

public static final java.lang.String ACTION_PACKAGE_SETTING_NAME

Configuration element name for action package location definition.

See Also:

Constant Field Values

CONNECTOR_RIGHTS_SET_VARIABLE_NAME

public static final java.lang.String CONNECTOR_RIGHTS_SET_VARIABLE_NAME

Name of connector rights set token element created when connector is connecting.

See Also:

Constant Field Values

SERVER_STATE_LISTENER_SETTING_KEY_PREFIX

public static final java.lang.String SERVER_STATE_LISTENER_SETTING_KEY_PREFIX

Configuration element, prefix of server state listener name setting. Used in ServerStateInspector class. There can be multiple server state listeners used in the same time. Listeners can be obtained in two ways, by creating new instance of listener (then class name is required) or by retrieving Spring bean (Spring bean reference required). Format of message server state listener setting key is: bristle.state.listener[index]. Format of the value: 'listenerName: listenerClassType' or 'listenerName: listenerSpringBeanName'.

See Also:

Constant Field Values

EXCEPTION_HANDLER_SETTING_KEY_PREFIX

public static final java.lang.String EXCEPTION_HANDLER_SETTING_KEY_PREFIX

Configuration element, prefix of exception handler name setting. Used in ExceptionHandlersInitializer class. There can be multiple exception handlers used in the same time. Handlers can be obtained in two ways, by creating new instance of exception handler (then class name is required) or by retrieving Spring bean (Spring bean reference required). Format of exception handler setting key is: bristle.exception.handler[index]. Format of the value: 'handlerName: handlerClassType' or 'handlerName: handlerSpringBeanName'.

See Also:

Constant Field Values

CONFIG_FILE_LOCATION_CONTEXT_VARIABLE_NAME

public static final java.lang.String CONFIG_FILE_LOCATION_CONTEXT_VARIABLE_NAME

This settings can be set as one of context parameter in 'web.xml' in web application. It is a path of the jwebsocket configuration file. If not set, configuration file will be searched in default locations, depending on jWebsocket library version.

See Also:

Constant Field Values

SPRING_INTEGRATION_CONTEXT_VARIABLE_NAME

public static final java.lang.String SPRING_INTEGRATION_CONTEXT_VARIABLE_NAME

This settings can be set as one of context parameter in 'web.xml' in web application. If set to 'true', Spring Framework integration will be enabled.

See Also:

Constant Field Values