Showing:

Annotations
Attributes
Diagrams
Facets
Instances
Model
Properties
Used by
Element NotificationJMS
Annotations

https://kb.sos-berlin.com/display/PKB/JobScheduler+Monitoring+Configuration+Reference+-+NotificationJMS

References Notes

JMS Interface to be executed for System Monitor notification.

Diagram
Diagram SystemMonitorNotification_v1_0_xsd_Element_NotificationJMS.tmp#NotificationJMS_client_id SystemMonitorNotification_v1_0_xsd_Element_NotificationJMS.tmp#NotificationJMS_destination SystemMonitorNotification_v1_0_xsd_Element_NotificationJMS.tmp#NotificationJMS_acknowledge_mode SystemMonitorNotification_v1_0_xsd_Element_NotificationJMS.tmp#NotificationJMS_delivery_mode SystemMonitorNotification_v1_0_xsd_Element_NotificationJMS.tmp#NotificationJMS_priority SystemMonitorNotification_v1_0_xsd_Element_NotificationJMS.tmp#NotificationJMS_time_to_live SystemMonitorNotification_v1_0_xsd_Element_NotificationJMS.tmp#NotificationJMS_plugin SystemMonitorNotification_v1_0_xsd_Element_ConnectionFactory.tmp#ConnectionFactory SystemMonitorNotification_v1_0_xsd_Element_ConnectionJNDI.tmp#ConnectionJNDI SystemMonitorNotification_v1_0_xsd_Element_Message.tmp#Message
Properties
content complex
Used by
Model
Instance
<NotificationJMS acknowledge_mode="Session.CLIENT_ACKNOWLEDGE" client_id="" delivery_mode="DeliveryMode.PERSISTENT" destination="Queue" plugin="" priority="4" time_to_live="0">
  <ConnectionFactory java_class="" password="" user_name="">{1,1}</ConnectionFactory>
  <ConnectionJNDI file="" lookup_name="ConnectionFactory">{1,1}</ConnectionJNDI>
  <Message>{1,1}</Message>
</NotificationJMS>
Attributes
QName Type Default Use Annotation
acknowledge_mode restriction of xs:string Session.CLIENT_ACKNOWLEDGE optional

  • Session.AUTO_ACKNOWLEDGE - with this acknowledgment mode, the session automatically acknowledges a client's receipt of a message either when the session has successfully returned from a call to receive or when the message listener the session has called to process the message successfully returns.
  • Session.CLIENT_ACKNOWLEDGE - with this acknowledgment mode, the client acknowledges a consumed message by calling the message's acknowledge method.
  • Session.AUTO_ACKNOWLEDGE - this acknowledgment mode instructs the session to lazily acknowledge the delivery of messages.

client_id optional
The client identifier for this connection.
delivery_mode restriction of xs:string DeliveryMode.PERSISTENT optional

The delivery modes supported by the JMS API are PERSISTENT and NON_PERSISTENT.

  • DeliveryMode.NON_PERSISTENT - this is the lowest-overhead delivery mode because it does not require that the message be logged to stable storage.
  • DeliveryMode.PERSISTENT - this delivery mode instructs the JMS provider to log the message to stable storage as part of the client's send operation.

destination restriction of xs:string Queue optional
  • Queue - creates a Queue object which encapsulates a specified provider-specific queue name.
  • Topic - creates a Topic object which encapsulates a specified provider-specific topic name.
plugin xs:string optional

Java class of the plugin implementation.

Extends com.sos.jitl.notification.plugins.notifier.SystemNotifierCustomPlugin

Default: com.sos.jitl.notification.plugins.notifier.SystemNotifierSendJMSPlugin

priority restriction of xs:integer 4 optional

The JMS API defines ten levels of priority value, with 0 as the lowest priority and 9 as the highest.

Clients should consider priorities 0-4 as gradations of normal priority and priorities 5-9 as gradations of expedited priority.

time_to_live xs:NMTOKEN 0 optional

Sets the default length of time in milliseconds from its dispatch time that a produced message should be retained by the message system.

Time to live is set to zero by default.

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 as separator):

  • e.g.: 1w 1d 1h

Attribute NotificationJMS / @client_id
Annotations
The client identifier for this connection.
Used by
Element NotificationJMS
Attribute NotificationJMS / @destination
Annotations
  • Queue - creates a Queue object which encapsulates a specified provider-specific queue name.
  • Topic - creates a Topic object which encapsulates a specified provider-specific topic name.
Type restriction of xs:string
Properties
default Queue
Facets
minLength 1
enumeration Queue
enumeration Topic
Used by
Element NotificationJMS
Attribute NotificationJMS / @acknowledge_mode
Annotations

  • Session.AUTO_ACKNOWLEDGE - with this acknowledgment mode, the session automatically acknowledges a client's receipt of a message either when the session has successfully returned from a call to receive or when the message listener the session has called to process the message successfully returns.
  • Session.CLIENT_ACKNOWLEDGE - with this acknowledgment mode, the client acknowledges a consumed message by calling the message's acknowledge method.
  • Session.AUTO_ACKNOWLEDGE - this acknowledgment mode instructs the session to lazily acknowledge the delivery of messages.

Type restriction of xs:string
Properties
default Session.CLIENT_ACKNOWLEDGE
Facets
minLength 1
enumeration Session.AUTO_ACKNOWLEDGE
enumeration Session.CLIENT_ACKNOWLEDGE
enumeration Session.DUPS_OK_ACKNOWLEDGE
Used by
Element NotificationJMS
Attribute NotificationJMS / @delivery_mode
Annotations

The delivery modes supported by the JMS API are PERSISTENT and NON_PERSISTENT.

  • DeliveryMode.NON_PERSISTENT - this is the lowest-overhead delivery mode because it does not require that the message be logged to stable storage.
  • DeliveryMode.PERSISTENT - this delivery mode instructs the JMS provider to log the message to stable storage as part of the client's send operation.

Type restriction of xs:string
Properties
default DeliveryMode.PERSISTENT
Facets
minLength 1
enumeration DeliveryMode.NON_PERSISTENT
enumeration DeliveryMode.PERSISTENT
Used by
Element NotificationJMS
Attribute NotificationJMS / @priority
Annotations

The JMS API defines ten levels of priority value, with 0 as the lowest priority and 9 as the highest.

Clients should consider priorities 0-4 as gradations of normal priority and priorities 5-9 as gradations of expedited priority.

Type restriction of xs:integer
Properties
default 4
Facets
enumeration 0
enumeration 1
enumeration 2
enumeration 3
enumeration 4
enumeration 5
enumeration 6
enumeration 7
enumeration 8
enumeration 9
Used by
Element NotificationJMS
Attribute NotificationJMS / @time_to_live
Annotations

Sets the default length of time in milliseconds from its dispatch time that a produced message should be retained by the message system.

Time to live is set to zero by default.

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 as separator):

  • e.g.: 1w 1d 1h

Type xs:NMTOKEN
Properties
default 0
Used by
Element NotificationJMS
Attribute NotificationJMS / @plugin
Annotations

Java class of the plugin implementation.

Extends com.sos.jitl.notification.plugins.notifier.SystemNotifierCustomPlugin

Default: com.sos.jitl.notification.plugins.notifier.SystemNotifierSendJMSPlugin

Type xs:string
Properties
use optional
Used by
Element NotificationJMS