Introduction

JS7 - Notification - Configuration is performed from the Configuration->Notification sub-view of the JOC Cockpit and includes setting up the configuration for the JS7 - Monitor Service.
The JMSFragment element is used to integrate with a JMS compatible Java Message Queue product and to parameterize messages from JS7 - Notification - Configuration, Monitor Variables.

JMSFragment

JMSFragment supports the following attributes:

Attribute	Usage	Description
`client_id`	Optional	The client identifier for this connection. See`: Connection.setClientID`
`destination`	Optional	A `Destination` object encapsulates a provider-specific address. Possible values: `Queue` `Topic`. See: Destination Default: `Queue`
`destination_name`	Dependent	The name of either the destination queue or topic according to the setting made for the destination attribute.
`acknowledge_mode`	Optional	Session acknowledgment mode. Possible values: `Session.AUTO_ACKNOWLEDGE` `Session.CLIENT_ACKNOWLEDGE` `Session.AUTO_ACKNOWLEDGE` See: Session Default: `Session.CLIENT_ACKNOWLEDGE`
`delivery_mode`	Optional	Delivery mode. Possible values: `DeliveryMode.NON_PERSISTENT` `DeliveryMode.PERSISTENT` See: MessageProducer.setDeliveryMode DeliveryMode Default: `DeliveryMode.PERSISTENT`
`priority`	Optional	The producer's default priority. See: MessageProducer.setPriority Default: `4`
`time_to_live`	Optional	Sets the default length of time in milliseconds from its dispatch time that a produced message should be retained by the message system. See: MessageProducer.setTimeToLive Possible values: `<n>` - duration in milliseconds e.g.: `60000` `<n>s` - duration in seconds e.g.: `30s` `<n>m` - duration in minutes e.g.: `30m` `<n>h -` duration in hours e.g.: `24h` `<n>d -` duration in days e.g.: `30d` `<n>w -` duration in weeks e.g.: `4w` Combined values (with blank space as separator): e.g.: `1w 1d 1h` Default: `0`

One of the following elements must be available inside a JMSFragment element:

Element	Element description	Description
`ConnectionFactory`	Optional or only once inside the `JMSFragment` element	Specifies use of a JMS ConnectionFactory implementation
`ConnectionJNDI`	Optional or only once inside the `JMSFragment` element	Specifies use of a JNDI properties file to create a JNDI InitialContextFactory

JMS message:

Element	Element description	Description
`Message`	Required, only once inside of `JMSFragment` element	Body of a JMS notification

ConnectionFactory

Specifies use of a JMS ConnectionFactory implementation.

ConnectionFactory supports the following attributes:

Attribute Usage Description

java_class

Required

Java class of the JMS ConnectionFactory

e.g.:org.apache.activemq.ActiveMQConnectionFactory

user_name Optional The caller's user name

password Optional The caller's password

The following element can be nested inside a ConnectionFactory element:

Element	Element description	Description
`ConstructorArguments`	Optional or only once inside of `ConnectionFactory` element

ConstructorArguments

The following elements can be nested inside a ConstructorArguments element:

Element	Element description	Description
`Argument`	Required, repeated use allowed inside the `ConstructorArguments` element	JMS ConnectionFactory constructor argument

Example: ActiveMQConnectionFactory with 1 constructor argument

...
<ConnectionFactory java_class="org.apache.activemq.ActiveMQConnectionFactory">
    <ConstructorArguments>
        <Argument type="java.lang.String"><![CDATA[tcp://localhost:61616]]></Argument>
    </ConstructorArguments>
</ConnectionFactory>
...

Example: ActiveMQConnectionFactory with 3 constructor arguments

...
<ConnectionFactory java_class="org.apache.activemq.ActiveMQConnectionFactory">
    <ConstructorArguments>
        <Argument type="java.lang.String"><![CDATA[my_user_name]]></Argument>
        <Argument type="java.lang.String"><![CDATA[my_password]]></Argument>
        <Argument type="java.lang.String"><![CDATA[tcp://localhost:61616]]></Argument>
    </ConstructorArguments>
</ConnectionFactory>
...

Argument

Argument supports the following attributes:

Attribute

Usage

Description

type

Required

Java type of a constructor argument.

Possible values:

boolean
double
float
int
long
short
java.lang.Boolean
java.lang.Double
java.lang.Float
java.lang.Integer
java.lang.Long
java.lang.Short
java.lang.String

Default:java.lang.String

The value of the constructor argument will be stored as CDATA node.

Example

...
<Argument type="java.lang.String"><![CDATA[tcp://localhost:61616]]></Argument>
...

ConnectionJNDI

Specifies use of a JNDI properties file to create a JNDI InitialContextFactory.

See: Connecting to the JMS Server by Using JNDI

ConnectionJNDI supports the following attributes:

Attribute Usage Description

file Required Path of the JNDI properties file

lookup_name

Optional

Name to lookup JMS connection factory objects

Default: ConnectionFactory

Example: content of the JNDI properties file for ActiveMQ

java.naming.factory.initial=org.apache.activemq.jndi.ActiveMQInitialContextFactory
java.naming.provider.url=tcp://localhost:61616

Message

Body of a JMS notification. Any JS7 - Notification - Configuration, Monitor Variables can be used with the body.

Space shortcuts

Page tree

Introduction

JMSFragment

ConnectionFactory

ConstructorArguments

Argument

ConnectionJNDI

Message

Space shortcuts

Page tree

JS7 - Notification - Configuration Element JMSFragment

Introduction

JMSFragment

ConnectionFactory

ConstructorArguments

Argument

ConnectionJNDI

Message