Package org.objectweb.joram.mom.util

Class JoramHelper

java.lang.Object

org.objectweb.joram.mom.util.JoramHelper

public class JoramHelper
extends Object

Administration stuff for internal use.

The functions use the AdminTopic to perform the operations. The AdminTopic agent is called directly from the calling agent, so special care should be taken to ensure consistency. JoramHelper functions should be called from an agent reaction, and they should save the state of the AdminTopic agent so that the new state is committed with the current reaction.

Field Summary

Fields

Modifier and Type	Field	Description
static int	CLIENT_CONTEXT_CLASS_ID
static int	CLIENT_MESSAGES_CLASS_ID
static int	CLIENT_SUBSCRIPTION_CLASS_ID
private static boolean	DEBUG
static int	ENCODABLE_CLASS_ID_AREA
static String	JNDI_HOST
static String	JNDI_INITIAL
static String	JNDI_PORT
private static Logger	logger	class specific logger
static int	MESSAGE_CLASS_ID
static int	MESSAGE_ID_LIST_IMPL_CLASS_ID
static int	QUEUE_ARRIVAL_STATE_CLASS_ID
static int	QUEUE_CLASS_ID
static int	QUEUE_DELIVERY_TABLE_CLASS_ID
static int	TOPIC_FWD_NOT_CLASS_ID
static int	USER_AGENT_ARRIVAL_STATE_CLASS_ID
static int	USER_AGENT_CLASS_ID

Constructor Summary

Constructors

Constructor	Description
JoramHelper()

Method Summary

Modifier and Type	Method	Description
static boolean	clearQueue(String queueName)	Clears all pending message of a queue
static boolean	clearSubscription(String userName, String subName)	Clears all pending message of a subscription
static AgentId	createDestination(String destName, AgentId adminId, String destClassName, byte type, Properties properties, boolean freerw)	Instantiating the destination class or retrieving the destination.
static AgentId	createDestination(String destName, AgentId adminId, String destClassName, byte type, Properties properties, boolean freeReading, boolean freeWriting)	Instantiating the destination class or retrieving the destination.
static void	createUser(String userName, String userPass)	Create user.
static boolean	deleteQueueMessage(String queueName, String msgId)	Delete a message in a queue
static boolean	deleteSubMessage(String userName, String subName, String msgId)	Deletes a message in a subscription

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

class specific logger

DEBUG

private static final boolean DEBUG

JNDI_INITIAL

public static final String JNDI_INITIAL

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

ENCODABLE_CLASS_ID_AREA

public static final int ENCODABLE_CLASS_ID_AREA

See Also:

Constant Field Values

MESSAGE_CLASS_ID

public static final int MESSAGE_CLASS_ID

See Also:

Constant Field Values

QUEUE_CLASS_ID

public static final int QUEUE_CLASS_ID

See Also:

Constant Field Values

USER_AGENT_CLASS_ID

public static final int USER_AGENT_CLASS_ID

See Also:

Constant Field Values

CLIENT_SUBSCRIPTION_CLASS_ID

public static final int CLIENT_SUBSCRIPTION_CLASS_ID

See Also:

Constant Field Values

CLIENT_CONTEXT_CLASS_ID

public static final int CLIENT_CONTEXT_CLASS_ID

See Also:

Constant Field Values

MESSAGE_ID_LIST_IMPL_CLASS_ID

public static final int MESSAGE_ID_LIST_IMPL_CLASS_ID

See Also:

Constant Field Values

USER_AGENT_ARRIVAL_STATE_CLASS_ID

public static final int USER_AGENT_ARRIVAL_STATE_CLASS_ID

See Also:

Constant Field Values

QUEUE_DELIVERY_TABLE_CLASS_ID

public static final int QUEUE_DELIVERY_TABLE_CLASS_ID

See Also:

Constant Field Values

QUEUE_ARRIVAL_STATE_CLASS_ID

public static final int QUEUE_ARRIVAL_STATE_CLASS_ID

See Also:

Constant Field Values

TOPIC_FWD_NOT_CLASS_ID

public static final int TOPIC_FWD_NOT_CLASS_ID

See Also:

Constant Field Values

CLIENT_MESSAGES_CLASS_ID

public static final int CLIENT_MESSAGES_CLASS_ID

See Also:

Constant Field Values

Constructor Detail

JoramHelper

public JoramHelper()

Method Detail

createUser

public static final void createUser(String userName,
                                    String userPass)

Create user.

Parameters:

userName - user name

userPass - user password

createDestination

public static final AgentId createDestination(String destName,
                                              AgentId adminId,
                                              String destClassName,
                                              byte type,
                                              Properties properties,
                                              boolean freerw)
                                       throws Exception

Instantiating the destination class or retrieving the destination.

Parameters:

destName - destination name

adminId - Agent Id. of the administrator (null for TopicAdmin)

destClassName - destination class name

type - destination type

properties - destination properties

freerw - if true rights all users can read and write the destination.

Returns:

destination AgentId

Throws:

Exception

createDestination

public static final AgentId createDestination(String destName,
                                              AgentId adminId,
                                              String destClassName,
                                              byte type,
                                              Properties properties,
                                              boolean freeReading,
                                              boolean freeWriting)
                                       throws Exception

Instantiating the destination class or retrieving the destination.

Parameters:

destName - destination name

adminId - Agent Id. of the administrator (null for TopicAdmin)

destClassName - destination class name

type - destination type

properties - destination properties

freeReading - if true rights all users can read and write the destination.

freeWriting - if true rights all users can read and write the destination.

Returns:

destination AgentId

Throws:

Exception

deleteQueueMessage

public static final boolean deleteQueueMessage(String queueName,
                                               String msgId)

Delete a message in a queue

Parameters:

queueName - Name of the queue

msgId - ID of the message to be deleted

Returns:

deleteSubMessage

public static final boolean deleteSubMessage(String userName,
                                             String subName,
                                             String msgId)

Deletes a message in a subscription

Parameters:

userName - Subscriber's name

subName - Subscription name

msgId - ID of the message to be deleted

Returns:

clearQueue

public static final boolean clearQueue(String queueName)

Clears all pending message of a queue

Parameters:

queueName - Name of the queue

Returns:

clearSubscription

public static final boolean clearSubscription(String userName,
                                              String subName)

Clears all pending message of a subscription

Parameters:

userName - Subscriber's name

subName - Subscription name

Returns: