Novell Doc: Identity Manager 3.6.1 Driver for JMS Implementation Guide

A.1 Driver Configuration

In iManager:

Click to display the Identity Manager Administration page.
Open the driver set that contains the driver whose properties you want to edit:
1. In the Administration list, click Identity Manager Overview.
2. If the driver set is not listed on the Driver Sets tab, use the Search In field to search for and display the driver set.
3. Click the driver set to open the Driver Set Overview page.
Locate the driver icon, then click the upper right corner of the driver icon to display the Actions menu.
Click Edit Properties to display the driver’s properties page.

In Designer:

Open a project in the Modeler, then right-click the driver line and click Properties > Driver Configuration.

The Driver Configuration options are divided into the following sections:

A.1.1 Driver Module

The driver module changes the driver from running locally to running remotely or the reverse.

Table A-1 Driver Modules

Option	Description
Java	Used to specify the name of the Java class that is instantiated for the shim component of the driver. This class can be located in the classes directory as a class file, or in the lib directory as a .jar file. If this option is selected, the driver is running locally. The name of the Java class is: com.novell.idm.driver.jms.JMSDriverShim
Native	This option is not used with the driver.
Connect to Remote Loader	Used when the driver is connecting remotely to the connected system. Designer includes two suboptions: Driver Object Password: Specifies a password for the Driver object. If you are using the Remote Loader, you must enter a password on this page. Otherwise, the remote driver does not run. The Remote Loader uses this password to authenticate itself to the remote driver shim. Remote Loader Client Configuration for Documentation: Includes information on the Remote Loader client configuration when Designer generates documentation for the Delimited Text driver.

Option

Description

Java

Used to specify the name of the Java class that is instantiated for the shim component of the driver. This class can be located in the classes directory as a class file, or in the lib directory as a .jar file. If this option is selected, the driver is running locally.

The name of the Java class is:

com.novell.idm.driver.jms.JMSDriverShim

Native

This option is not used with the driver.

Connect to Remote Loader

Used when the driver is connecting remotely to the connected system. Designer includes two suboptions:

Driver Object Password: Specifies a password for the Driver object. If you are using the Remote Loader, you must enter a password on this page. Otherwise, the remote driver does not run. The Remote Loader uses this password to authenticate itself to the remote driver shim.
Remote Loader Client Configuration for Documentation: Includes information on the Remote Loader client configuration when Designer generates documentation for the Delimited Text driver.

A.1.2 Driver Object Password (iManager Only)

Table A-2 Driver Object Password

Option	Description
Driver Object Password	Use this option to set a password for the driver object. If you are using the Remote Loader, you must enter a password on this page or the remote driver does not run. This password is used by the Remote Loader to authenticate itself to the remote driver shim.

A.1.3 Authentication

The Authentication section stores the information required to authenticate to the connected system.

Table A-3 Authentication

Option	Description
Authentication ID or User ID	Specify a user application ID. This ID is used to pass Identity Vault subscription information to the application. Example: Administrator
Authentication Context or Connection Information	Specify the IP address or name of the server the application shim should communicate with.
Remote Loader Connection Parameters or Host name Port KMO Other parameters	Used only if the driver is connecting to the application through the remote loader. The parameter to enter is hostname=xxx.xxx.xxx.xxx port=xxxx kmo=certificatename, when the host name is the IP address of the application server running the Remote Loader server and the port is the port the remote loader is listening on. The default port for the Remote Loader is 8090. The kmo entry is optional. It is only used when there is an SSL connection between the Remote Loader and the Metadirectory engine. Example: hostname=10.0.0.1 port=8090 kmo=IDMCertificate
Driver Cache Limit (kilobytes) or Cache limit (KB)	Specify the maximum event cache file size (in KB). If it is set to zero, the file size is unlimited. Click Unlimited to set the file size to unlimited in Designer.
Application Password or Set Password	Specify the password for the user object listed in the Authentication ID field.
Remote Loader Password or Set Password	Used only if the driver is connecting to the application through the Remote Loader. The password is used to control access to the Remote Loader instance. It must be the same password specified during the configuration of the Remote Loader on the connected system.

Option

Description

Authentication ID

User ID

Specify a user application ID. This ID is used to pass Identity Vault subscription information to the application.

Example: Administrator

Authentication Context

Connection Information

Specify the IP address or name of the server the application shim should communicate with.

Remote Loader Connection Parameters

Host name

Port

KMO

Other parameters

Used only if the driver is connecting to the application through the remote loader. The parameter to enter is hostname=xxx.xxx.xxx.xxx port=xxxx kmo=certificatename, when the host name is the IP address of the application server running the Remote Loader server and the port is the port the remote loader is listening on. The default port for the Remote Loader is 8090.

The kmo entry is optional. It is only used when there is an SSL connection between the Remote Loader and the Metadirectory engine.

Example: hostname=10.0.0.1 port=8090 kmo=IDMCertificate

Driver Cache Limit (kilobytes)

Cache limit (KB)

Specify the maximum event cache file size (in KB). If it is set to zero, the file size is unlimited.

Click Unlimited to set the file size to unlimited in Designer.

Application Password

Set Password

Specify the password for the user object listed in the Authentication ID field.

Remote Loader Password

Set Password

Used only if the driver is connecting to the application through the Remote Loader. The password is used to control access to the Remote Loader instance. It must be the same password specified during the configuration of the Remote Loader on the connected system.

A.1.4 Startup Option

The Startup Option section allows you to set the driver state when the Identity Manager server is started.

Table A-4 Startup Option

Option	Description
Auto start	The driver starts every time the Identity Manager server is started.
Manual	The driver does not start when the Identity Manager server is started. The driver must be started through Designer or iManager.
Disabled	The driver has a cache file that stores all of the events. When the driver is set to Disabled, this file is deleted and no new events are stored in the file until the driver state is changed to Manual or Auto Start.
Do not automatically synchronize the driver	This option only applies if the driver is deployed and was previously disabled. If this is not selected, the driver re-synchronizes the next time it is started.

A.1.5 Driver Parameters

The Driver Parameters section lets you configure the driver-specific parameters. When you change driver parameters, you tune driver behavior to align with your network environment.

The parameters are presented by category:

Table A-5 Driver Settings

Option	Sub-Option	Description
Default JMS version		Specifies the API version this driver should use when communicating with message brokers. If you are uncertain, 1.0.2 is the more widely adopted standard. This setting is global for all message brokers.
Broker ID		Specifies an identifier for this broker by which it is known in the Identity Manager namespace.
Show connection-related parameters		Displays connection-related parameters such as JNDI connection factory names and usernames or passwords.
	Username	Specifies the username used to authenticate to the message broker.
	Password	The password used to authenticate to the message broker. After entering the password, you need to re-enter it for validation.
	Show queue connection factory options	Specifies the JNDI name of the connection factory used to create connections to queues.
	Show topic connection factory options	Specify the JNDI name of the connection factory used to create connections to topics. Specify the Client ID used to create durable topic subscriptions. NOTE:Changing this value after durable subscriptions have been defined is not recommended. If it is changed, the Publisher is unable to unsubscribe from existing topic subscriptions unless the client ID is set to the same value the subscriptions were created with.
Show standard JNDI context parameters		Displays standard JNDI context properties for this message broker. These properties are primarily used to specify the URL, username, and password used to connect to or authenticate with this broker.
	INITIAL_CONTEXT_ FACTORY	The name that uniquely identifies this JNDI context property.
	Value	The name of the Java class used to create a JNDI context for this message broker.
prov	PROVIDER_URL	The name that uniquely identifies this JNDI context property
	Value	The URL of this message broker. A URL usually contains a protocol, an IP address, and a port number. For example, jnp://140.67.155.9:1099
	SECURITY_ CREDENTIALS	The name that uniquely identifies this JNDI context property.
	Value	The password used to authenticate to this message broker.
	SECURITY_ PRINCIPAL	The name that uniquely identifies this JNDI context property.
	Value	The username used to authenticate to this message broker.
	URL_PKG_PREFIXES	The name that uniquely identifies this JNDI context property.
	Value	The value of this JNDI context property.
	Show remaining standard properties	Displays remaining, less commonly used standard JNDI context properties
	APPLET	The name that uniquely identifies this JNDI context property.
	Value	The value of this JNDI context property.
	AUTHORITATIVE	The name that uniquely identifies this JNDI context property.
	Value	The value of this JNDI context property.
	BATCHSIZE	The name that uniquely identifies this JNDI context property.
	Value	The value of this JNDI context property.
	DNS_URL	The name that uniquely identifies this JNDI context property.
	Value	The value of this JNDI context property.
	LANGUAGE	The name that uniquely identifies this JNDI context property.
	Value	The value of this JNDI context property.
	OBJECT_FACTORIES	The name that uniquely identifies this JNDI context property.
	Value	The value of this JNDI context property.
	REFERRAL	The name that uniquely identifies this JNDI context property.
	Value	The value of this JNDI context property.
	SECURITY_ AUTHENTICATION	The name that uniquely identifies this JNDI context property.
	Value	The value of this JNDI context property.
	SECURITY_ PROTOCOL	The name that uniquely identifies this JNDI context property.
	Value	The value of this JNDI context property.
	STATE_FACTORIES	The name that uniquely identifies this JNDI context property.
	Value	The value of this JNDI context property.
Show vendor-specific JNDI context properties		Displays vendor-specific JNDI context properties.
	Name	The name that uniquely identifies this JNDI context property.
	Value	The value of this JNDI context property.

Table A-6 Subscriber Settings

Option	Sub-Option	Description
Disable subscriber		Select yes to prevent this channel from sending messages to JMS providers.
Show default message options		Displays options that are global to all messages.
	Default message expiration (milliseconds)	How long messages should live after they reach a destination. Specify the time duration in milliseconds. This setting is global for all sent messages. A value of 0 specifies that the message lives indefinitely.
	Default message priority	Specifies the message priority. 0-4 indicates normal delivery 5-9 indicates expedited delivery Specifying expedited delivery can result in “out-of-order” message processing. This setting is global for all sent messages.
	Default message type	Specifies the default message type as text or bytes. This setting is global for all sent messages.
	Show default message properties	Specifies whether to display parameters that show the properties sent with messages. Message properties can be used to prevent message loopback or to pass application-specific information in messages. These properties are global for all sent messages.
	Name	Message property names beginning with “JMS” must match those defined by the JMS specification or third-party providers. Property names fall into three general categories: 1. Standard JMS properties. They usually begin with JMS or JMSX. 2. Provider-specific properties. They usually begin with JMS_. 3. Application-specific. Anything else.
	Value	Message property value.
Show default destination options		Displays options global to all destinations.
	Default destination type	Specifies whether all destinations are queues or topics by default. This setting is global for all destinations.
	Default omit message envelope	Specifies whether the JMS message envelope should be omitted from received messages. This setting is global to all destinations.
	Default receive timeout (seconds)	Specifies how long a channel should wait to receive a response to a sent message. The default value is 10 seconds. Permitted values can range from 1-25. This setting is global to all destinations.
	Default message filter	Specifies how destinations filter received messages. This setting is global to all destinations.
	Default message selector	Specifies a custom message selector to filter received messages. Message selectors are like SQL WHERE clauses, such as JMSCorrelationID LIKE '%01=whatever%'. The % wildcard character can be used to disregard content before or after the part of a header or property value you're interested in filtering on. When used in tandem with a message filter, the message selector is appended to the end of the filter by using an AND operator.
Destination unique id		Specifies the identifier for this destination by which it is known in the Identity Manager namespace. This name is also the durable subscription name for topics. This value must be unique per channel (Subscriber/Publisher).
Show additional destination options		Displays additional options for this selected destination.

	Destination JNDI name	Specifies the identifier for this destination that is known in the JNDI namespace. This might not be the name the destination is known by to the broker. This value does not need to be unique.
	Destination type	Specifies whether this destination is a queue or a topic.
	Destination mode	Specifies whether the destination is used to send or receive messages.
	Message type	Specifies whether messages are sent as text or bytes.
	Show message properties	Specifies whether to display message properties sent with messages. Message properties can be used to prevent message loopback or pass provider or application-specific information along with messages.
	Name	Message property names beginning with JMS must match those defined by the JMS specification or third-party providers. Property names fall into three general categories: Standard JMS properties. They usually begin with JMS or JMSX. Provider-specific properties. They begin with JMS_. Application-specific. Anything else.
	Value	Message property value.
Destination unique id		Specifies the identifier by which this destination is known in the Identity Manager namespace. This name is also the durable subscription name for topics. This value must be unique per channel (Subscriber/Publisher).
Show additional destination options		Displays additional options for this selected destination.
	Destination JNDI name	Specifies the identifier by which this destination is known in the JNDI namespace. This might or might not be the name the destination is known by to the message broker. This value does not need to be unique.
	Destination type	Specifies whether the destination is a queue or a topic.
	Destination mode	Specifies whether the destination is used to send or receive messages.
	Message type	Specifies whether messages should be sent as text or bytes.
	Show message properties	Displays options that specify the message properties sent with messages. Message properties can be used to prevent message loopback or pass provider or application-specific information along with messages.
	Name	Message property names beginning with JMS must match those defined by the JMS specification or third-party providers. Property names fall into three general categories: Standard JMS properties. They usually begin with JMS or JMSX. Provider-specific properties. They begin with JMS_. Application-specific. Anything else.
	Value	Message property value.
	Omit message envelope	Specifies whether the JMS message envelope is omitted from messages received by this destination.
	Receive timeout (seconds)	Specifies how long a channel should wait to receive a response to a sent message. The default value is 10 seconds. Permitted values can range from 1-25.
	Message filter	Specifies how the destination receives filtered messages.
	Message selector	Specifies a custom message selector to filter received messages. Message selectors are like SQL WHERE clauses (for example, JMSCorrelationID = whatever. When used in tandem with a message filter, the message selector is appended to the end of the filter by using an AND operator.
Destination unique id		Specifies the identifier by which this destination is known in the Identity Manager namespace. This name is also the durable subscription name for topics. This value must be unique per channel (Subscriber/Publisher).
Show additional destination options		Displays additional options for this destination.
	Destination JNDI name	Specifies the identifier by which this destination is known in the JNDI namespace. This might or might not be the name the destination is known by to the message broker. This value does not need to be unique.
	Destination type	Specifies whether the destination is a queue or a topic.
	Destination mode	Specifies whether the destination is used to send or receive messages.
	Message type	Specifies whether messages should be sent as text or bytes.
	Show message properties	Displays options that specify the message properties sent with messages. Message properties can be used to prevent message loopback or pass provider/application-specific information along with messages.
	Name	Message property names beginning with JMS must match those defined by the JMS specification or third-party providers. Property names fall into three general categories: Standard JMS properties. They usually begin with JMS or JMSX. Provider-specific properties. They begin with JMS_. Application-specific. Anything else.
	Value	Message property value.

Table A-7 Publisher Settings

Option	Sub-Option	Description
Disable publisher		Select yes to prevent this channel from receiving messages from JMS providers.
Heartbeat interval (minutes)		Specifies how many minutes of inactivity should elapse before this channel sends a heartbeat document. In practice, more than the number of minutes specified can elapse. That is, this parameter defines a lower bound.
Show default message options		Displays options global to all messages.
	Default message expiration (milliseconds)	Specifies how long messages live after they reach a destination. Specify the time duration in milliseconds. 0 means the messages live indefinitely. This setting is global for all sent messages.
	Default message priority	Specifies the message priority.0-4 indicates normal delivery 5-9 indicates expedited deliverySpecifying expedited delivery can result in “out-of-order” message processing. This setting is global for all sent messages.
	Default message type	Specifies whether messages are text or byte. This setting is global for all sent messages.
	Show default message properties	Displays the parameters that specify the properties sent with messages. Message properties can be used to prevent message loopback or pass application-specific information in messages. These properties are global for all sent messages.
	Name	Message property names beginning with JMS must match those defined by the JMS specification or third-party providers. Property names fall into three general categories: Standard JMS properties. They usually begin with JMS or JMSX. Provider-specific properties. They begin with JMS_. Application specific. Anything else.
	Value	Message property value.
Show default session options		Displays options that are global to all sessions.
	Default message acknowledgment threshold	Specifies how many messages are received by a monitored destination before an acknowledgment is sent to the broker.
Show default destination options		Displays options that are global to all destinations.
	Default destination type	Specifies whether destinations are topics or queues by default. This setting is global for all destinations.
	Default omit message envelope	Specifies if the JMS message envelope is omitted from received messages. This setting is global for all destinations.
	Default receive timeout (seconds)	Specifies how long a channel waits to receive a response to a sent message. The default is 10 seconds. Permitted values range from 1-25 seconds. This setting is global for all destinations.
	Default message filter	Specifies how the destination’s filter receives messages. This setting is global for all destinations.
	Default message selector	Specifies a custom message selector to filter received messages. Message selectors are like SQL WHERE clauses, such as, JMSCorrelationID LIKE '%01=whatever%'. The % wildcard character is used to disregard content before or after the part of a header or property value you're interested in filtering on. When used in tandem with a message filter, the message selector is appended to the end of the filter by using an AND operator.
	Default polling interval (milliseconds)	Specifies how often destinations are polled for new messages (in milliseconds.) This setting is global for all destinations.
Destination unique id		Specifies the identifier by which this destination is known in the Identity Manager namespace. This name is also the durable subscription name for topics. This value must be unique per channel (Subscriber/Publisher).
Show additional destination options		Displays parameters for this selected destination.
	Destination JNDI name	Specifies the identifier by which this destination is known in the JNDI namespace. This might not be the name the destination is known by to the broker. This value does not need to be unique.
	Destination type	Specifies whether this destination is a queue or topic.
	Destination mode	Specifies whether this destination sends or receives messages.
	Message type	Specifies whether messages are sent in text or byte format.
	Show message properties	Displays the parameters that specify the properties sent with messages. Message properties can be used to prevent message loopback or pass application-specific information along with messages.
	Name	Message property names beginning with JMS must match those defined by the JMS specification or third-party providers. Property names fall into three general categories: Standard JMS properties. They usually begin with JMS or JMSX. Provider-specific properties. They begin with JMS_. Application-specific. Anything else.
	Value	Message property value.
Destination unique id		Specifies the identifier by which this destination is known in the Identity Manager namespace. This name is also the durable subscription name for topics. This value must be unique per channel (Subscriber/Publisher).
Show additional destination options		Displays parameters for this selected destination.
	Destination JNDI name	Specifies the identifier by which this destination is known in the JNDI namespace. This might or might not be the name the destination is known by to the broker. This value does not need to be unique.
	Destination type	Specifies whether the destination is a queue or a topic.
	Destination mode	Specifies whether this destination sends or receives messages.
	Omit message envelope	Whether the JMS message envelope be omitted from messages received by this destination.
	Receive timeout (seconds)	Specifies how long this channel waits to receive a response from a destination. The default is 10 seconds. Permitted values range from 1-25 seconds.
	Message filter	Specifies how this destination filters messages.
	Message selector	Specifies a custom message selector to filter received messages. Message selectors are like SQL WHERE clauses For example, JMSCorrelationID = whatever. When used in tandem with a message filter, the message selector is appended to the end of the filter by using an AND operator.
	Is durable	Specifies whether messages are cached at the message broker when the driver isn’t running. This setting is only effective for topic destinations; queues are durable by default.
	Subscription name	Specify the name of the durable subscription to create on the broker. NOTE:This resource might need to be cleaned up manually when this driver is deleted unless specific procedures are followed.
	Actively monitor	Specify if you want the channel to periodically monitor this destination for messages.