de.hawhamburg.reachability.util

Class ConnectionUtil

java.lang.Object

de.hawhamburg.reachability.util.ConnectionUtil

public final class ConnectionUtil
extends java.lang.Object

Utility functions related to Active MQ connections.

This utility class provides some fancy utility methods related to the Active MQ message interaction.

Version:

"2013.42"

Author:

"Malte Kantak <malte.kantak@hotmail.de>"

Field Summary

Fields

Modifier and Type	Field and Description
private static long	AMQ_READ_TIMEOUT The timeout after which the ActiveMQ topic will be freed on read.
private static de.hawhamburg.livingplace.messaging.activemq.wrapper.ConnectionSettings	conSettings Holds the connection settings.
private static long	WAIT_BEFORE_RECONNECT Waiting time before reconnect in milliseconds.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	ConnectionUtil() Prevent instances of this utility class.

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.String	getMessageOnTopic(de.hawhamburg.livingplace.messaging.activemq.wrapper.LPSubscriber topic) Checks if there is a message on the topic of the LPSubscriber object and returns it as String on success (null instead).
static de.hawhamburg.livingplace.messaging.activemq.wrapper.LPPublisher	getPublisher(java.lang.String topic, StopableObject obj) Returns an LPPublisher object related to a certain topic.
static de.hawhamburg.livingplace.messaging.activemq.wrapper.LPSubscriber	getSubscriber(java.lang.String topic, StopableObject obj) Returns an LPSubscriber object related to a certain topic.
static void	setMessageOnTopic(de.hawhamburg.livingplace.messaging.activemq.wrapper.LPPublisher topic, java.lang.Object jsonMsg) Tries to send a JSON message object on a certain topic using an LPPublisher object.

Methods inherited from class java.lang.Object

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

Field Detail

WAIT_BEFORE_RECONNECT

private static final long WAIT_BEFORE_RECONNECT

Waiting time before reconnect in milliseconds.

See Also:

Constant Field Values

AMQ_READ_TIMEOUT

private static final long AMQ_READ_TIMEOUT

The timeout after which the ActiveMQ topic will be freed on read.

See Also:

Constant Field Values

conSettings

private static de.hawhamburg.livingplace.messaging.activemq.wrapper.ConnectionSettings conSettings

Holds the connection settings. Will be loaded only once in a programs lifetime. For changes, the program needs to be restarted.

Constructor Detail

ConnectionUtil

private ConnectionUtil()

Prevent instances of this utility class.

Method Detail

getSubscriber

public static de.hawhamburg.livingplace.messaging.activemq.wrapper.LPSubscriber getSubscriber(java.lang.String topic,
                                                                              StopableObject obj)

Returns an LPSubscriber object related to a certain topic. The second parameter should be the calling object, if it is kind of StopableObject. To ensure, that the connection attempt will be stopped, of the calling object was shut down.

Parameters:

topic - The topics name as String.

obj - The calling object, if it's a StopableObject (null instead).

Returns:

An LPSubscriber object to read messages from this topic.

getPublisher

public static de.hawhamburg.livingplace.messaging.activemq.wrapper.LPPublisher getPublisher(java.lang.String topic,
                                                                            StopableObject obj)

Returns an LPPublisher object related to a certain topic. The second parameter should be the calling object, if it is kind of StopableObject. To ensure, that the connection attempt will be stopped, of the calling object was shut down.

Parameters:

topic - The topics name as String.

obj - The calling object, if it's a StopableObject (null instead).

Returns:

An LPPublisher object to set messages on this topic.

getMessageOnTopic

public static java.lang.String getMessageOnTopic(de.hawhamburg.livingplace.messaging.activemq.wrapper.LPSubscriber topic)

Checks if there is a message on the topic of the LPSubscriber object and returns it as String on success (null instead).

Parameters:

topic - An LPSubscriber object, which shall be checked for new messages.

Returns:

A message as String on success, otherwise null.

setMessageOnTopic

public static void setMessageOnTopic(de.hawhamburg.livingplace.messaging.activemq.wrapper.LPPublisher topic,
                     java.lang.Object jsonMsg)

Tries to send a JSON message object on a certain topic using an LPPublisher object.

Parameters:

topic - An LPPublisher object to send on.

jsonMsg - A JSON message object.