Package org.objectweb.joram.tools.rest.jms

Class Helper

java.lang.Object

org.objectweb.joram.tools.rest.jms.Helper

All Implemented Interfaces:

HelperMBean

public final class Helper
extends Object
implements HelperMBean

Field Summary

Fields

Modifier and Type	Field	Description
static String	BUNDLE_CF_PROP
static String	BUNDLE_CLEANER_PERIOD_PROP
static String	BUNDLE_CLIENTID_PREFIX_PROPERTY
static String	BUNDLE_IDLE_TIMEOUT_PROP
static String	BUNDLE_JMS_IP_ALLOWED
static String	BUNDLE_JMS_PASS
static String	BUNDLE_JMS_USER
static String	BUNDLE_JNDI_CACHE_UPDATE_PERIOD_PROPERTY
static String	BUNDLE_JNDI_FACTORY_HOST_PROP
static String	BUNDLE_JNDI_FACTORY_INITIAL_PROP
static String	BUNDLE_JNDI_FACTORY_LINGER_PROP
static String	BUNDLE_JNDI_FACTORY_PORT_PROP
static String	BUNDLE_JNDI_FACTORY_REUSE_ADDRESS_PROP
static String	BUNDLE_JNDI_FACTORY_TIMEOUT_PROP
static String	BUNDLE_MAX_NUMBER_OF_CONTEXT_PROPERTY
private static String	BYTES_CLASS_NAME
private Hashtable<String,jakarta.jms.ConnectionFactory>	cfht
private long	cfhtLastUpdate
private String	cfName
private long	cleanerPeriod
static String	CLIENTID_PREFIX_DEFAULT
static String	clientIdPrefix
private static AtomicLong	counter
private static boolean	DEBUG
private Hashtable<String,jakarta.jms.Destination>	destht
private long	desthtLastUpdate
static int	DFLT_CLEANER_PERIOD
private long	globalIdleTimeout
private static Helper	helper
private InitialContext	ictx
private String	IPAllowed
private IPFilter	ipfilter
static int	JNDI_CACHE_UPDATE_PERIOD_DEFAULT
private Properties	jndiProps
private static int	jndiUpdatePeriod	JNDI cache update period in ms.
private long	lastCleanTime
private static Logger	logger
static int	MAX_NUMBER_OF_CONTEXT_DEFAULT
static int	maxNumberOfContext
private Random	rand	This random generator is used to built random identifiers of producer and consumer.
private Map<String,RestClientContext>	restClientCtxs
private String	restPass
private String	restUser
private Map<String,SessionContext>	sessionCtxs

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Helper()

Method Summary

Modifier and Type	Method	Description
void	acknowledgeAllMsg(String consName)
void	acknowledgeMsg(String consName, long id)
boolean	authenticationRequired()
boolean	checkIPAddress(String addr)	Check if the addr is authorized (all local address is authorized).
void	close(String clientId)
void	closeAll()	Should only be called in stop.
void	closeSessionCtx(String ctxName)
void	commit(String name)
jakarta.jms.Message	consume(String consName, long timeout, boolean noLocal, boolean durable, boolean shared, String name, long msgId)
String	createClientId()
String	createConsumer(String userName, String password, String clientId, String consName, jakarta.jms.Destination dest, int sessionMode, String messageSelector, boolean noLocal, boolean durable, boolean shared, String name, String destName, boolean isQueue, long idleTimeout)	Create a consumer
String	createConsumerId()
String	createProducer(String userName, String password, String clientId, String prodName, jakarta.jms.Destination dest, int sessionMode, int deliveryMode, long deliveryDelay, String correlationID, int priority, long timeToLive, String destName, boolean isQueue, long idleTimeout)	Create a producer
String	createProducerId()
String	dumpContexts()
String	dumpSessions()
long	getCleanerPeriod()
RestClientContext	getClientContext(String id)	Returns the context corresponding to the specified identifier.
long	getDefaultIdleTimeout()
static Helper	getInstance()
String	getIPAllowed()
private jakarta.jms.ConnectionFactory	getJNDIcf(String cfName)	Returns the value in cache, cleans the cache if needed.
private jakarta.jms.Destination	getJNDIdest(String destName)	Returns the value in cache, cleans the cache if needed.
String	getLastCleanTime()
int	getNbContexts()
(package private) Map<String,RestClientContext>	getRestClientCtxs()	Only used by CleanerTask to remove unused contexts.
String	getRestPass()
String	getRestUser()
SessionContext	getSessionCtx(String name)
(package private) static Object	getValue(Map map, String key)
private Object	lookup(String name)	Retrieves ConnectionFactory and Destination objects from JNDI.
jakarta.jms.ConnectionFactory	lookupConnectionFactory(String cfName)	Lookup the ConnectionFactory
jakarta.jms.Destination	lookupDestination(String destName)	Lookup the destination
void	rollback(String name)
long	send(String prodName, String type, Map<String,Object> jmsHeaders, Map<String,Object> jmsProps, Object jmsBody, int deliveryMode, long deliveryDelay, int priority, long timeToLive, String correlationID)
void	setCleanerPeriod(long cleanerPeriod)
void	setConnectionFactoryName(String cfName)
void	setGlobalProperties(org.osgi.framework.BundleContext bundleContext)
void	setLastCleanTime()
(package private) static void	setMapMessage(Map<String,Object> jsonMap, jakarta.jms.MapMessage msg)

Methods inherited from class java.lang.Object

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

Field Detail

logger

private static final Logger logger

DEBUG

private static final boolean DEBUG

BYTES_CLASS_NAME

private static final String BYTES_CLASS_NAME

BUNDLE_CF_PROP

public static final String BUNDLE_CF_PROP

See Also:

Constant Field Values

BUNDLE_JNDI_FACTORY_INITIAL_PROP

public static final String BUNDLE_JNDI_FACTORY_INITIAL_PROP

See Also:

Constant Field Values

BUNDLE_JNDI_FACTORY_HOST_PROP

public static final String BUNDLE_JNDI_FACTORY_HOST_PROP

See Also:

Constant Field Values

BUNDLE_JNDI_FACTORY_PORT_PROP

public static final String BUNDLE_JNDI_FACTORY_PORT_PROP

See Also:

Constant Field Values

BUNDLE_IDLE_TIMEOUT_PROP

public static final String BUNDLE_IDLE_TIMEOUT_PROP

See Also:

Constant Field Values

BUNDLE_CLEANER_PERIOD_PROP

public static final String BUNDLE_CLEANER_PERIOD_PROP

See Also:

Constant Field Values

BUNDLE_JMS_USER

public static final String BUNDLE_JMS_USER

See Also:

Constant Field Values

BUNDLE_JMS_PASS

public static final String BUNDLE_JMS_PASS

See Also:

Constant Field Values

BUNDLE_JMS_IP_ALLOWED

public static final String BUNDLE_JMS_IP_ALLOWED

See Also:

Constant Field Values

BUNDLE_JNDI_FACTORY_TIMEOUT_PROP

public static final String BUNDLE_JNDI_FACTORY_TIMEOUT_PROP

See Also:

Constant Field Values

BUNDLE_JNDI_FACTORY_LINGER_PROP

public static final String BUNDLE_JNDI_FACTORY_LINGER_PROP

See Also:

Constant Field Values

BUNDLE_JNDI_FACTORY_REUSE_ADDRESS_PROP

public static final String BUNDLE_JNDI_FACTORY_REUSE_ADDRESS_PROP

See Also:

Constant Field Values

BUNDLE_JNDI_CACHE_UPDATE_PERIOD_PROPERTY

public static final String BUNDLE_JNDI_CACHE_UPDATE_PERIOD_PROPERTY

See Also:

Constant Field Values

JNDI_CACHE_UPDATE_PERIOD_DEFAULT

public static final int JNDI_CACHE_UPDATE_PERIOD_DEFAULT

See Also:

Constant Field Values

BUNDLE_MAX_NUMBER_OF_CONTEXT_PROPERTY

public static final String BUNDLE_MAX_NUMBER_OF_CONTEXT_PROPERTY

See Also:

Constant Field Values

MAX_NUMBER_OF_CONTEXT_DEFAULT

public static final int MAX_NUMBER_OF_CONTEXT_DEFAULT

See Also:

Constant Field Values

maxNumberOfContext

public static int maxNumberOfContext

BUNDLE_CLIENTID_PREFIX_PROPERTY

public static final String BUNDLE_CLIENTID_PREFIX_PROPERTY

See Also:

Constant Field Values

CLIENTID_PREFIX_DEFAULT

public static final String CLIENTID_PREFIX_DEFAULT

See Also:

Constant Field Values

clientIdPrefix

public static String clientIdPrefix

jndiUpdatePeriod

private static int jndiUpdatePeriod

JNDI cache update period in ms. If 0, the cache is not use, if it is less than 0 it is never updated.

DFLT_CLEANER_PERIOD

public static final int DFLT_CLEANER_PERIOD

See Also:

Constant Field Values

rand

private Random rand

This random generator is used to built random identifiers of producer and consumer. May be we should use SecureRandom.

counter

private static final AtomicLong counter

helper

private static Helper helper

ictx

private InitialContext ictx

restClientCtxs

private Map<String,RestClientContext> restClientCtxs

sessionCtxs

private Map<String,SessionContext> sessionCtxs

cfName

private String cfName

globalIdleTimeout

private long globalIdleTimeout

jndiProps

private Properties jndiProps

restUser

private String restUser

restPass

private String restPass

IPAllowed

private String IPAllowed

ipfilter

private IPFilter ipfilter

lastCleanTime

private long lastCleanTime

cleanerPeriod

private long cleanerPeriod

cfhtLastUpdate

private long cfhtLastUpdate

cfht

private Hashtable<String,jakarta.jms.ConnectionFactory> cfht

desthtLastUpdate

private long desthtLastUpdate

destht

private Hashtable<String,jakarta.jms.Destination> destht

Constructor Detail

Helper

private Helper()

Method Detail

getRestClientCtxs

Map<String,RestClientContext> getRestClientCtxs()

Only used by CleanerTask to remove unused contexts.

Returns:

the restClientCtxs

getInstance

public static Helper getInstance()

getRestUser

public String getRestUser()

Specified by:

getRestUser in interface HelperMBean

Returns:

the Rest/Jms user

getRestPass

public String getRestPass()

Returns:

the Rest/Jms password

setGlobalProperties

public void setGlobalProperties(org.osgi.framework.BundleContext bundleContext)
                         throws NamingException

Throws:

NamingException

getIPAllowed

public String getIPAllowed()

Specified by:

getIPAllowed in interface HelperMBean

Returns:

the IPAllowed

checkIPAddress

public boolean checkIPAddress(String addr)

Check if the addr is authorized (all local address is authorized).

Parameters:

addr - The ip address to check

Returns:

true if authorized

Throws:

UnknownHostException

SocketException

authenticationRequired

public boolean authenticationRequired()

setConnectionFactoryName

public void setConnectionFactoryName(String cfName)

Parameters:

cfName - the connection factory name

setCleanerPeriod

public void setCleanerPeriod(long cleanerPeriod)

getCleanerPeriod

public long getCleanerPeriod()

Specified by:

getCleanerPeriod in interface HelperMBean

getDefaultIdleTimeout

public long getDefaultIdleTimeout()

Specified by:

getDefaultIdleTimeout in interface HelperMBean

setLastCleanTime

public void setLastCleanTime()

getLastCleanTime

public String getLastCleanTime()

Specified by:

getLastCleanTime in interface HelperMBean

getNbContexts

public int getNbContexts()

Specified by:

getNbContexts in interface HelperMBean

dumpContexts

public String dumpContexts()

Specified by:

dumpContexts in interface HelperMBean

dumpSessions

public String dumpSessions()

Specified by:

dumpSessions in interface HelperMBean

closeAll

public void closeAll()

Should only be called in stop.

close

public void close(String clientId)

Specified by:

close in interface HelperMBean

Parameters:

clientId - the client id

closeSessionCtx

public void closeSessionCtx(String ctxName)

Parameters:

ctxName - the producer or consumer name

getJNDIcf

private final jakarta.jms.ConnectionFactory getJNDIcf(String cfName)

Returns the value in cache, cleans the cache if needed.

Parameters:

cfName -

Returns:

lookupConnectionFactory

public final jakarta.jms.ConnectionFactory lookupConnectionFactory(String cfName)
                                                            throws NamingException

Lookup the ConnectionFactory

Parameters:

cfName - the ConnectionFactory name

Returns:

the ConnectionFactory if found

Throws:

NamingException

getJNDIdest

private final jakarta.jms.Destination getJNDIdest(String destName)

Returns the value in cache, cleans the cache if needed.

Parameters:

destName -

Returns:

lookupDestination

public final jakarta.jms.Destination lookupDestination(String destName)
                                                throws NamingException

Lookup the destination

Parameters:

destName - the destination name

Returns:

the destination if found

Throws:

NamingException

lookup

private Object lookup(String name)

Retrieves ConnectionFactory and Destination objects from JNDI. This method converts 'old' javax.jms references to the new Jakarta JMS API. TODO (AF): We should replace this code by a call to Helper.retrieveJakartaJMSObjectFromJNDI method (org.ow2.joram.jndi package).

Parameters:

jndiName -

Returns:

Throws:

Exception

createProducer

public String createProducer(String userName,
                             String password,
                             String clientId,
                             String prodName,
                             jakarta.jms.Destination dest,
                             int sessionMode,
                             int deliveryMode,
                             long deliveryDelay,
                             String correlationID,
                             int priority,
                             long timeToLive,
                             String destName,
                             boolean isQueue,
                             long idleTimeout)
                      throws Exception

Create a producer

Parameters:

userName - the user name

password - the password

clientId - the client id

prodName - the producer name

dest - the JMS destination

sessionMode - the session mode

deliveryMode - the delivery mode

deliveryDelay - the delivery delay

correlationID - the correlation id

priority - the priority

timeToLive - the time to live

destName - need for the jms create

isQueue -

idleTimeout -

Returns:

the producer name

Throws:

Exception

createConsumer

public String createConsumer(String userName,
                             String password,
                             String clientId,
                             String consName,
                             jakarta.jms.Destination dest,
                             int sessionMode,
                             String messageSelector,
                             boolean noLocal,
                             boolean durable,
                             boolean shared,
                             String name,
                             String destName,
                             boolean isQueue,
                             long idleTimeout)
                      throws Exception

Create a consumer

Parameters:

userName - the user name

password - the password

clientId - the client id

consName - the consumer name

dest - the JMS destination

sessionMode - the session mode

messageSelector -

noLocal -

durable -

shared -

name -

destName - need for the jms create

isQueue -

idleTimeout -

Returns:

the consumer name

Throws:

Exception

setMapMessage

static final void setMapMessage(Map<String,Object> jsonMap,
                                jakarta.jms.MapMessage msg)
                         throws Exception

Throws:

Exception

getValue

static final Object getValue(Map map,
                             String key)
                      throws Exception

Throws:

Exception

send

public long send(String prodName,
                 String type,
                 Map<String,Object> jmsHeaders,
                 Map<String,Object> jmsProps,
                 Object jmsBody,
                 int deliveryMode,
                 long deliveryDelay,
                 int priority,
                 long timeToLive,
                 String correlationID)
          throws Exception

Parameters:

prodName -

type -

jmsHeaders -

jmsProps -

jmsBody -

deliveryMode -

deliveryDelay -

priority -

timeToLive -

correlationID -

Returns:

Throws:

Exception

consume

public jakarta.jms.Message consume(String consName,
                                   long timeout,
                                   boolean noLocal,
                                   boolean durable,
                                   boolean shared,
                                   String name,
                                   long msgId)
                            throws Exception

Throws:

Exception

createClientId

public String createClientId()

createProducerId

public String createProducerId()

createConsumerId

public String createConsumerId()

getSessionCtx

public SessionContext getSessionCtx(String name)

getClientContext

public RestClientContext getClientContext(String id)

Returns the context corresponding to the specified identifier. If no matching context exists, try to create one. Be careful, if there is too many existing contexts returns null.

Parameters:

id -

Returns:

commit

public void commit(String name)
            throws Exception

Throws:

Exception

rollback

public void rollback(String name)
              throws Exception

Throws:

Exception

acknowledgeAllMsg

public void acknowledgeAllMsg(String consName)
                       throws Exception

Throws:

Exception

acknowledgeMsg

public void acknowledgeMsg(String consName,
                           long id)
                    throws Exception

Throws:

Exception