Package org.ow2.joram.tools.jmscheck

Class JMSCheck

java.lang.Object

org.ow2.joram.tools.jmscheck.JMSCheck

public final class JMSCheck
extends Object

This client regularly tests the state of a JMS connector and publishes the results to JMX.

usage: java -DJNDI_FILE=./jndi.properties -DPERIOD=1 -DTIMEOUT=5000

-DCF=cf -DQUEUE=queue

-jar jmscheck.jar [help]

Options, set by Java environment variable ("-Dproperty=value" in command line):

• JNDI_FILE: Path of JNDI properties file. If not defined, Joram's default are used. "fr.dyade.aaa.jndi2.client.NamingContextFactory" for JNDI Factory, "localhost", and 16400 for host and port.
  These values can be overloaded by specific properties below.
• JNDI_FACTORY: Classname of the JNDI factory (cf java.naming.factory.initial property).
• JNDI_HOST: Hostname ou IP address of JNDI server.
• JNDI_PORT: Listening port of JNDI server.
• PERIOD: Period between 2 checks, by default 60s.
• TIMEOUT: Maximum amount of time to wait connecting and receiving messages, by default 10s.

For each JMS connector to monitor there is 4 properties to define:
• CF: JNDI name of the ConnectionFactory to use.
• QUEUE: Internal name of JMS destination.
• USER: User name for authentication, if no defined uses the ConnectionFactory default.
• PASS: Password for authentication, if no defined uses the ConnectionFactory default.
If there are multiple connectors to monitor, suffix each property with 1, 2, 3, etc.
All these properties can be defined in a file whose name is given by the CONF_FILE property. In this case the other properties defined in the command line are ignored.

Field Summary

Fields

Modifier and Type	Field	Description
static String	CF_NAME
static String	CONF_FILE
static String	GLOBAL_PERIOD
static String	GLOBAL_TIMEOUT
(package private) static JMSStatus	jmsStatus
static String	JNDI_FACTORY
static String	JNDI_FILE
static String	JNDI_HOST
static String	JNDI_PORT
static Logger	logger
static String	PASSWORD
(package private) static int	period
static String	QUEUE_NAME
(package private) static int	timeout
static String	USER_NAME

Constructor Summary

Constructors

Constructor	Description
JMSCheck()

Method Summary

Modifier and Type	Method	Description
private static boolean	createConnector(Properties props, JMSStatus jmsStatus, String suffix, InitialContext ictx)	Adds a new check component using the related properties.
static void	main(String[] args)

Methods inherited from class java.lang.Object

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

Field Detail

logger

public static final Logger logger

GLOBAL_PERIOD

public static final String GLOBAL_PERIOD

See Also:

Constant Field Values

GLOBAL_TIMEOUT

public static final String GLOBAL_TIMEOUT

See Also:

Constant Field Values

JNDI_FILE

public static final String JNDI_FILE

See Also:

Constant Field Values

JNDI_FACTORY

public static final String JNDI_FACTORY

See Also:

Constant Field Values

JNDI_HOST

public static final String JNDI_HOST

See Also:

Constant Field Values

JNDI_PORT

public static final String JNDI_PORT

See Also:

Constant Field Values

CF_NAME

public static final String CF_NAME

See Also:

Constant Field Values

USER_NAME

public static final String USER_NAME

See Also:

Constant Field Values

PASSWORD

public static final String PASSWORD

See Also:

Constant Field Values

QUEUE_NAME

public static final String QUEUE_NAME

See Also:

Constant Field Values

CONF_FILE

public static final String CONF_FILE

See Also:

Constant Field Values

period

static int period

timeout

static int timeout

jmsStatus

static JMSStatus jmsStatus

Constructor Detail

JMSCheck

public JMSCheck()

Method Detail

main

public static void main(String[] args)
                 throws Exception

Throws:

Exception

createConnector

private static boolean createConnector(Properties props,
                                       JMSStatus jmsStatus,
                                       String suffix,
                                       InitialContext ictx)

Adds a new check component using the related properties.

Parameters:

check - The root component.

suffix - The property suffix.

ictx - The InitialContext to use.

Returns:

True if the component is successively created.