org.openanzo.services
Class NotificationProperties

java.lang.Object
  org.openanzo.services.NotificationProperties

public class NotificationProperties
extends java.lang.Object

Configuration properties for the INotificationService.

Author:

Generated Source from org.openanzo.utils.properties.jet

Field Summary

static java.lang.String	KEY_NOTIFICATION_CLASS Key for property "org.openanzo.notification.notificationClass" Class name for implementation of INotificationService Server:The class name for the implementation of INotificationService that the server services will use in order to connect to the notification server. Client:The class name for the implementation of INotificationService that the client will use in order to connect to the notification server. Embedded:See client Examples: org.openanzo.services.impl.JMSNotificationService
static java.lang.String	KEY_NOTIFICATION_CONTROLQUEUE Key for property "org.openanzo.notification.controlQueue" Queue name that control messages are passed over.
static java.lang.String	KEY_NOTIFICATION_ENABLED Key for property "org.openanzo.notification.enabled" Should the notification the notification service be enabled Server:Should services be able to use notification messages to keep in synch. Client:Should the client connect to the notification server in order to retrieve update messages. Embedded:Should the client connect to the notification server in order to retrieve update messages.Note: A notification server will need to be running in order for an embedded client to connect to it, it does not provide its own notification server. Examples: Server:Should be true in most cases Client:true if the client is going to be using notifications Embedded:true if the client is going to be using notifications and there is notification server running
static java.lang.String	KEY_NOTIFICATION_HOST Key for property "org.openanzo.notification.host" Hostname/IP Address or connection URL for the notification/jms server Server:The hostname/IP address or connection URL of the notification server for which the server services will use in order to connect to the notification server. Client:The hostname/IP Address or connection URL of the notification server for which the client will use in order to connect to the notification server. Embedded:See client Examples: Server:localhost,tcp://localhost or if running in the same JVM as the JMS server, vm://localhost Client:localhost or tcp://localhost Embedded:localhost or tcp://localhost
static java.lang.String	KEY_NOTIFICATION_JNDI_CONNECTIONFACTORY Key for property "org.openanzo.notification.jndi.connectionFactoryName" JNDI lookup name for JMS connection factory.Note: Not currently used.
static java.lang.String	KEY_NOTIFICATION_JNDI_CONTROLQUEUE Key for property "org.openanzo.notification.jndi.controlQueueName" JNDI lookup name for controlQueue.
static java.lang.String	KEY_NOTIFICATION_JNDI_UPDATEQUEUE Key for property "org.openanzo.notification.jndi.updateQueueName" JNDI lookup name for updateQueue.Note: Not currently used.
static java.lang.String	KEY_NOTIFICATION_PASSWORD Key for property "org.openanzo.notification.password" Password for notification/jms server.
static java.lang.String	KEY_NOTIFICATION_PORT Key for property "org.openanzo.notification.port" Port for notification/jms server Server:The notification server's listening port that the server services will use in order to connect to the notification server. Client:The notification server's listening port that the client will use in order to connect to the notification server. Embedded:See client Examples: 61616
static java.lang.String	KEY_NOTIFICATION_PROVIDER_CLASS Key for property "org.openanzo.notification.jmsProviderClass" The Class name of the underlying JMS provider implementation that will be used to connect to the notification server.
static java.lang.String	KEY_NOTIFICATION_UPDATESQUEUE Key for property "org.openanzo.notification.updatesQueue" Queue name that is used to update messages within the notification server.
static java.lang.String	KEY_NOTIFICATION_USER Key for property "org.openanzo.notification.user" Login id for notification/jms server.

Constructor Summary

NotificationProperties()

Method Summary

static java.lang.String	getControlQueue(java.util.Properties properties, java.lang.String defaultValue) Get KEY_NOTIFICATION_CONTROLQUEUE property from properties
static boolean	getEnabled(java.util.Properties properties, boolean defaultValue) Get KEY_NOTIFICATION_ENABLED property from properties
static java.lang.String	getHost(java.util.Properties properties, java.lang.String defaultValue) Get KEY_NOTIFICATION_HOST property from properties
static java.lang.String	getJmsProviderClass(java.util.Properties properties, java.lang.String defaultValue) Get KEY_NOTIFICATION_PROVIDER_CLASS property from properties
static java.lang.String	getJndiConnectionFactoryName(java.util.Properties properties, java.lang.String defaultValue) Get KEY_NOTIFICATION_JNDI_CONNECTIONFACTORY property from properties
static java.lang.String	getJndiControlQueueName(java.util.Properties properties, java.lang.String defaultValue) Get KEY_NOTIFICATION_JNDI_CONTROLQUEUE property from properties
static java.lang.String	getJndiUpdateQueueName(java.util.Properties properties, java.lang.String defaultValue) Get KEY_NOTIFICATION_JNDI_UPDATEQUEUE property from properties
static java.lang.String	getNotificationClass(java.util.Properties properties, java.lang.String defaultValue) Get KEY_NOTIFICATION_CLASS property from properties
static java.lang.String	getPassword(java.util.Properties properties, java.lang.String defaultValue) Get KEY_NOTIFICATION_PASSWORD property from properties
static java.lang.String	getPort(java.util.Properties properties, java.lang.String defaultValue) Get KEY_NOTIFICATION_PORT property from properties
static java.lang.String	getUpdatesQueue(java.util.Properties properties, java.lang.String defaultValue) Get KEY_NOTIFICATION_UPDATESQUEUE property from properties
static java.lang.String	getUser(java.util.Properties properties, java.lang.String defaultValue) Get KEY_NOTIFICATION_USER property from properties
static void	setControlQueue(java.util.Properties properties, java.lang.String controlQueue) Set KEY_NOTIFICATION_CONTROLQUEUE property to controlQueue in properties
static void	setEnabled(java.util.Properties properties, boolean enabled) Set KEY_NOTIFICATION_ENABLED property to enabled in properties
static void	setHost(java.util.Properties properties, java.lang.String host) Set KEY_NOTIFICATION_HOST property to host in properties
static void	setJmsProviderClass(java.util.Properties properties, java.lang.String jmsProviderClass) Set KEY_NOTIFICATION_PROVIDER_CLASS property to jmsProviderClass in properties
static void	setJndiConnectionFactoryName(java.util.Properties properties, java.lang.String jndiConnectionFactoryName) Set KEY_NOTIFICATION_JNDI_CONNECTIONFACTORY property to jndi.connectionFactoryName in properties
static void	setJndiControlQueueName(java.util.Properties properties, java.lang.String jndiControlQueueName) Set KEY_NOTIFICATION_JNDI_CONTROLQUEUE property to jndi.controlQueueName in properties
static void	setJndiUpdateQueueName(java.util.Properties properties, java.lang.String jndiUpdateQueueName) Set KEY_NOTIFICATION_JNDI_UPDATEQUEUE property to jndi.updateQueueName in properties
static void	setNotificationClass(java.util.Properties properties, java.lang.String notificationClass) Set KEY_NOTIFICATION_CLASS property to notificationClass in properties
static void	setPassword(java.util.Properties properties, java.lang.String password) Set KEY_NOTIFICATION_PASSWORD property to password in properties
static void	setPort(java.util.Properties properties, java.lang.String port) Set KEY_NOTIFICATION_PORT property to port in properties
static void	setUpdatesQueue(java.util.Properties properties, java.lang.String updatesQueue) Set KEY_NOTIFICATION_UPDATESQUEUE property to updatesQueue in properties
static void	setUser(java.util.Properties properties, java.lang.String user) Set KEY_NOTIFICATION_USER property to user in properties

Methods inherited from class java.lang.Object

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

Field Detail

KEY_NOTIFICATION_ENABLED

public static final java.lang.String KEY_NOTIFICATION_ENABLED

Key for property "org.openanzo.notification.enabled" Should the notification the notification service be enabled

Server:Should services be able to use notification messages to keep in synch.

Client:Should the client connect to the notification server in order to retrieve update messages.

Embedded:Should the client connect to the notification server in order to retrieve update messages.Note: A notification server will need to be running in order for an embedded client to connect to it, it does not provide its own notification server.

Examples:

Server:Should be true in most cases

Client:true if the client is going to be using notifications

Embedded:true if the client is going to be using notifications and there is notification server running

See Also:

Constant Field Values

KEY_NOTIFICATION_PROVIDER_CLASS

public static final java.lang.String KEY_NOTIFICATION_PROVIDER_CLASS

Key for property "org.openanzo.notification.jmsProviderClass" The Class name of the underlying JMS provider implementation that will be used to connect to the notification server. Examples: org.openanzo.common.jms.ActiveMqProvider

See Also:

Constant Field Values

KEY_NOTIFICATION_HOST

public static final java.lang.String KEY_NOTIFICATION_HOST

Key for property "org.openanzo.notification.host" Hostname/IP Address or connection URL for the notification/jms server

Server:The hostname/IP address or connection URL of the notification server for which the server services will use in order to connect to the notification server.

Client:The hostname/IP Address or connection URL of the notification server for which the client will use in order to connect to the notification server.

Embedded:See client

Examples:

Server:localhost,tcp://localhost or if running in the same JVM as the JMS server, vm://localhost

Client:localhost or tcp://localhost

Embedded:localhost or tcp://localhost

See Also:

Constant Field Values

KEY_NOTIFICATION_PORT

public static final java.lang.String KEY_NOTIFICATION_PORT

Key for property "org.openanzo.notification.port" Port for notification/jms server

Server:The notification server's listening port that the server services will use in order to connect to the notification server.

Client:The notification server's listening port that the client will use in order to connect to the notification server.

Embedded:See client

Examples: 61616

See Also:

Constant Field Values

KEY_NOTIFICATION_USER

public static final java.lang.String KEY_NOTIFICATION_USER

Key for property "org.openanzo.notification.user" Login id for notification/jms server. Notification server usually uses the same login credentials as the server.

Server:The login id that the server services will use in order to connect to the notification server.

Client:The login id that the client will use in order to connect to the notification server.

Embedded:See client

Examples: default

See Also:

Constant Field Values

KEY_NOTIFICATION_PASSWORD

public static final java.lang.String KEY_NOTIFICATION_PASSWORD

Key for property "org.openanzo.notification.password" Password for notification/jms server. Notification server usually uses the same login credentials as the server.

Server:The password that the server services will use in order to connect to the notification server.

Client:The password that the client will use in order to connect to the notification server.

Embedded:See client

Examples: 123

See Also:

Constant Field Values

KEY_NOTIFICATION_CLASS

public static final java.lang.String KEY_NOTIFICATION_CLASS

Key for property "org.openanzo.notification.notificationClass" Class name for implementation of INotificationService

Server:The class name for the implementation of INotificationService that the server services will use in order to connect to the notification server.

Client:The class name for the implementation of INotificationService that the client will use in order to connect to the notification server.

Embedded:See client

Examples: org.openanzo.services.impl.JMSNotificationService

See Also:

Constant Field Values

KEY_NOTIFICATION_CONTROLQUEUE

public static final java.lang.String KEY_NOTIFICATION_CONTROLQUEUE

Key for property "org.openanzo.notification.controlQueue" Queue name that control messages are passed over.

Server:Queue name that is used to send control messages to the notification server. Note: These settings should only be changed if you are changing the default behaviour of the JMS server.

Client:Queue name that is used to send control messages to the notification server. Note: These settings should only be changed if you are changing the default behaviour of the JMS server.

Embedded:Queue name that is used to send control messages to the notification server. Note: These settings should only be changed if you are changing the default behaviour of the JMS server.

Examples: ControlQueue

See Also:

Constant Field Values

KEY_NOTIFICATION_UPDATESQUEUE

public static final java.lang.String KEY_NOTIFICATION_UPDATESQUEUE

Key for property "org.openanzo.notification.updatesQueue" Queue name that is used to update messages within the notification server. Note: These settings should only be changed if you are changing the default behaviour of the JMS server.

Server:Queue name that the update publisher uses to send control messages to the notification server. Note: These settings should only be changed if you are changing the default behaviour of the JMS server.

Client:Not Used

Embedded:Queue name that the update publisher uses to send control messages to the notification server. Note: These settings should only be changed if you are changing the default behaviour of the JMS server.

Examples: UpdateQueue

See Also:

Constant Field Values

KEY_NOTIFICATION_JNDI_CONTROLQUEUE

public static final java.lang.String KEY_NOTIFICATION_JNDI_CONTROLQUEUE

Key for property "org.openanzo.notification.jndi.controlQueueName" JNDI lookup name for controlQueue. Note: Not currently used.

See Also:

Constant Field Values

KEY_NOTIFICATION_JNDI_UPDATEQUEUE

public static final java.lang.String KEY_NOTIFICATION_JNDI_UPDATEQUEUE

Key for property "org.openanzo.notification.jndi.updateQueueName" JNDI lookup name for updateQueue.Note: Not currently used.

See Also:

Constant Field Values

KEY_NOTIFICATION_JNDI_CONNECTIONFACTORY

public static final java.lang.String KEY_NOTIFICATION_JNDI_CONNECTIONFACTORY

Key for property "org.openanzo.notification.jndi.connectionFactoryName" JNDI lookup name for JMS connection factory.Note: Not currently used.

See Also:

Constant Field Values

Constructor Detail

NotificationProperties

public NotificationProperties()

Method Detail

getEnabled

public static boolean getEnabled(java.util.Properties properties,
                                 boolean defaultValue)

Get KEY_NOTIFICATION_ENABLED property from properties

Parameters:

properties - containing configuration data

defaultValue - defaultValue for enabled

Returns:

value of KEY_NOTIFICATION_ENABLEDor defaultValue if not present

setEnabled

public static void setEnabled(java.util.Properties properties,
                              boolean enabled)

Set KEY_NOTIFICATION_ENABLED property to enabled in properties

Parameters:

properties - containing configuration data

enabled - value for enabled

getJmsProviderClass

public static java.lang.String getJmsProviderClass(java.util.Properties properties,
                                                   java.lang.String defaultValue)

Get KEY_NOTIFICATION_PROVIDER_CLASS property from properties

Parameters:

properties - containing configuration data

defaultValue - defaultValue for jmsProviderClass

Returns:

value of KEY_NOTIFICATION_PROVIDER_CLASSor defaultValue if not present

setJmsProviderClass

public static void setJmsProviderClass(java.util.Properties properties,
                                       java.lang.String jmsProviderClass)

Set KEY_NOTIFICATION_PROVIDER_CLASS property to jmsProviderClass in properties

Parameters:

properties - containing configuration data

jmsProviderClass - value for jmsProviderClass

getHost

public static java.lang.String getHost(java.util.Properties properties,
                                       java.lang.String defaultValue)

Get KEY_NOTIFICATION_HOST property from properties

Parameters:

properties - containing configuration data

defaultValue - defaultValue for host

Returns:

value of KEY_NOTIFICATION_HOSTor defaultValue if not present

setHost

public static void setHost(java.util.Properties properties,
                           java.lang.String host)

Set KEY_NOTIFICATION_HOST property to host in properties

Parameters:

properties - containing configuration data

host - value for host

getPort

public static java.lang.String getPort(java.util.Properties properties,
                                       java.lang.String defaultValue)

Get KEY_NOTIFICATION_PORT property from properties

Parameters:

properties - containing configuration data

defaultValue - defaultValue for port

Returns:

value of KEY_NOTIFICATION_PORTor defaultValue if not present

setPort

public static void setPort(java.util.Properties properties,
                           java.lang.String port)

Set KEY_NOTIFICATION_PORT property to port in properties

Parameters:

properties - containing configuration data

port - value for port

getUser

public static java.lang.String getUser(java.util.Properties properties,
                                       java.lang.String defaultValue)

Get KEY_NOTIFICATION_USER property from properties

Parameters:

properties - containing configuration data

defaultValue - defaultValue for user

Returns:

value of KEY_NOTIFICATION_USERor defaultValue if not present

setUser

public static void setUser(java.util.Properties properties,
                           java.lang.String user)

Set KEY_NOTIFICATION_USER property to user in properties

Parameters:

properties - containing configuration data

user - value for user

getPassword

public static java.lang.String getPassword(java.util.Properties properties,
                                           java.lang.String defaultValue)

Get KEY_NOTIFICATION_PASSWORD property from properties

Parameters:

properties - containing configuration data

defaultValue - defaultValue for password

Returns:

value of KEY_NOTIFICATION_PASSWORDor defaultValue if not present

setPassword

public static void setPassword(java.util.Properties properties,
                               java.lang.String password)

Set KEY_NOTIFICATION_PASSWORD property to password in properties

Parameters:

properties - containing configuration data

password - value for password

getNotificationClass

public static java.lang.String getNotificationClass(java.util.Properties properties,
                                                    java.lang.String defaultValue)

Get KEY_NOTIFICATION_CLASS property from properties

Parameters:

properties - containing configuration data

defaultValue - defaultValue for notificationClass

Returns:

value of KEY_NOTIFICATION_CLASSor defaultValue if not present

setNotificationClass

public static void setNotificationClass(java.util.Properties properties,
                                        java.lang.String notificationClass)

Set KEY_NOTIFICATION_CLASS property to notificationClass in properties

Parameters:

properties - containing configuration data

notificationClass - value for notificationClass

getControlQueue

public static java.lang.String getControlQueue(java.util.Properties properties,
                                               java.lang.String defaultValue)

Get KEY_NOTIFICATION_CONTROLQUEUE property from properties

Parameters:

properties - containing configuration data

defaultValue - defaultValue for controlQueue

Returns:

value of KEY_NOTIFICATION_CONTROLQUEUEor defaultValue if not present

setControlQueue

public static void setControlQueue(java.util.Properties properties,
                                   java.lang.String controlQueue)

Set KEY_NOTIFICATION_CONTROLQUEUE property to controlQueue in properties

Parameters:

properties - containing configuration data

controlQueue - value for controlQueue

getUpdatesQueue

public static java.lang.String getUpdatesQueue(java.util.Properties properties,
                                               java.lang.String defaultValue)

Get KEY_NOTIFICATION_UPDATESQUEUE property from properties

Parameters:

properties - containing configuration data

defaultValue - defaultValue for updatesQueue

Returns:

value of KEY_NOTIFICATION_UPDATESQUEUEor defaultValue if not present

setUpdatesQueue

public static void setUpdatesQueue(java.util.Properties properties,
                                   java.lang.String updatesQueue)

Set KEY_NOTIFICATION_UPDATESQUEUE property to updatesQueue in properties

Parameters:

properties - containing configuration data

updatesQueue - value for updatesQueue

getJndiControlQueueName

public static java.lang.String getJndiControlQueueName(java.util.Properties properties,
                                                       java.lang.String defaultValue)

Get KEY_NOTIFICATION_JNDI_CONTROLQUEUE property from properties

Parameters:

properties - containing configuration data

defaultValue - defaultValue for jndi.controlQueueName

Returns:

value of KEY_NOTIFICATION_JNDI_CONTROLQUEUEor defaultValue if not present

setJndiControlQueueName

public static void setJndiControlQueueName(java.util.Properties properties,
                                           java.lang.String jndiControlQueueName)

Set KEY_NOTIFICATION_JNDI_CONTROLQUEUE property to jndi.controlQueueName in properties

Parameters:

properties - containing configuration data

jndiControlQueueName - value for jndi.controlQueueName

getJndiUpdateQueueName

public static java.lang.String getJndiUpdateQueueName(java.util.Properties properties,
                                                      java.lang.String defaultValue)

Get KEY_NOTIFICATION_JNDI_UPDATEQUEUE property from properties

Parameters:

properties - containing configuration data

defaultValue - defaultValue for jndi.updateQueueName

Returns:

value of KEY_NOTIFICATION_JNDI_UPDATEQUEUEor defaultValue if not present

setJndiUpdateQueueName

public static void setJndiUpdateQueueName(java.util.Properties properties,
                                          java.lang.String jndiUpdateQueueName)

Set KEY_NOTIFICATION_JNDI_UPDATEQUEUE property to jndi.updateQueueName in properties

Parameters:

properties - containing configuration data

jndiUpdateQueueName - value for jndi.updateQueueName

getJndiConnectionFactoryName

public static java.lang.String getJndiConnectionFactoryName(java.util.Properties properties,
                                                            java.lang.String defaultValue)

Get KEY_NOTIFICATION_JNDI_CONNECTIONFACTORY property from properties

Parameters:

properties - containing configuration data

defaultValue - defaultValue for jndi.connectionFactoryName

Returns:

value of KEY_NOTIFICATION_JNDI_CONNECTIONFACTORYor defaultValue if not present

setJndiConnectionFactoryName

public static void setJndiConnectionFactoryName(java.util.Properties properties,
                                                java.lang.String jndiConnectionFactoryName)

Set KEY_NOTIFICATION_JNDI_CONNECTIONFACTORY property to jndi.connectionFactoryName in properties

Parameters:

properties - containing configuration data

jndiConnectionFactoryName - value for jndi.connectionFactoryName