org.ow2.joram.shell.mom.commands

Class MOMCommandsImpl

java.lang.Object

org.ow2.joram.shell.mom.commands.MOMCommandsImpl

All Implemented Interfaces:

MOMCommands

public class MOMCommandsImpl
extends Object
implements MOMCommands

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	MOMCommandsImpl.QueueNotFoundException
private class	MOMCommandsImpl.SubscriptionNotFoundException
private class	MOMCommandsImpl.TopicNotFoundException
private class	MOMCommandsImpl.UserNotFoundException

Field Summary

Fields

Modifier and Type	Field and Description
private static org.osgi.util.tracker.ServiceTracker	adminTracker
private static org.osgi.framework.BundleContext	bundleContext
private static org.osgi.util.tracker.ServiceTracker	clientSubTracker
static String[]	COMMANDS Commands list
private static org.osgi.util.tracker.ServiceTracker	destinationTracker
private static MOMCommandsImpl	INSTANCE
static String	NAMESPACE
private static org.osgi.util.tracker.ServiceTracker	queueTracker
private static int	TIMEOUT
private static org.osgi.util.tracker.ServiceTracker	topicTracker
private static org.osgi.util.tracker.ServiceTracker	userTracker

Constructor Summary

Constructors

Constructor and Description
MOMCommandsImpl()

Method Summary

Modifier and Type	Method and Description
void	clear(String[] args) Deletes all pending messages from a subscription or a queue.
void	create(String[] args) Creates a destination or a user Usage: [joram:mom:]create [option...]
private void	createDestination(String[] args)
private void	createUser(String[] args) Add a new user to the servers
void	delete(String[] args) Delete a destination or a user Usage: [joram:mom:]delete (topic|queue|user)
void	deleteMsg(String[] args) Delete a pending message from a queue or subscription Usage: [joram:mom:]deleteMsg queue [joram:mom:]deleteMsg subscription
private void	deleteMsgQueue(String queueName, String msgId)
private void	deleteMsgSub(String userName, String subName, String msgId)
private org.objectweb.joram.mom.dest.AdminTopicMBean	findAdminTopic()
private org.objectweb.joram.mom.proxies.ClientSubscriptionMBean	findClientSubscription(String userName, String subName)
private org.objectweb.joram.mom.dest.QueueMBean	findQueue(String name)
private org.objectweb.joram.mom.dest.TopicMBean	findTopic(String name)
private org.objectweb.joram.mom.proxies.UserAgentMBean	findUser(String userName)
static MOMCommandsImpl	getInstance()
private List<org.objectweb.joram.mom.messages.MessageView>	getMessageRange(List<org.objectweb.joram.mom.messages.MessageView> msgs, int start, int end)
private org.objectweb.joram.mom.messages.MessageView	getQueueMessage(String queueName, String msgId)
private List<org.objectweb.joram.mom.messages.MessageView>	getQueueMessages(String queueName)
private org.objectweb.joram.mom.messages.MessageView	getSubscriptionMessage(String userName, String subName, String msgId)
private List<org.objectweb.joram.mom.messages.MessageView>	getSubscriptionMessages(String userName, String subscriptionName)
static void	help() Prints all MOM commands
static void	help(String command) Prints the description of the given command Usage: [joram:mom:]help
void	info(String[] args) Show information about a destination Usage: [joram:mom:]info (queue|topic) [joram:mom:]info subscription
void	infoMsg(String[] args)
private void	infoQueue(String name)
private void	infoSubscription(String userName, String subName)
private void	infoTopic(String name)
static void	init(org.osgi.framework.BundleContext context)
void	list(String[] args) Lists all queues, topics, both or users with useful informations Usage: [joram:mom:]list [username] Possible categories: destination, topic, queue, user, subscription NB: For the subscription category, you must provide the user name.
private void	listDestination()
private void	listQueue()
private void	listSubscription(String userName)
private void	listTopic()
private void	listUser()
void	lsMsg(String[] args) Displays pending messages from a destination Usage: [joram:mom:]lsMsg queue [[first msg idx]:[last msg idx]] [joram:mom:]lsMsg subscription [[first msg idx]:[last msg idx]]
static void	main(String[] args)
void	ping() Checks whether Joram works Usage: [joram:mom:]ping
void	queueLoad(String[] args) Shows the pending message count Usage: [joram:mom:]queueLoad
void	receiveMsg(String[] args) Deprecated.
void	sendMsg(String[] args) Deprecated.
void	setFreeRead(String[] args)
void	setFreeWrite(String[] args)
void	subscriptionLoad(String[] args) Shows the pending message count of the subscription Usage: [joram:mom:]subscriptionLoad

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

private static MOMCommandsImpl INSTANCE

NAMESPACE

public static final String NAMESPACE

See Also:

Constant Field Values

TIMEOUT

private static final int TIMEOUT

See Also:

Constant Field Values

bundleContext

private static org.osgi.framework.BundleContext bundleContext

destinationTracker

private static org.osgi.util.tracker.ServiceTracker destinationTracker

queueTracker

private static org.osgi.util.tracker.ServiceTracker queueTracker

topicTracker

private static org.osgi.util.tracker.ServiceTracker topicTracker

userTracker

private static org.osgi.util.tracker.ServiceTracker userTracker

adminTracker

private static org.osgi.util.tracker.ServiceTracker adminTracker

clientSubTracker

private static org.osgi.util.tracker.ServiceTracker clientSubTracker

COMMANDS

public static String[] COMMANDS

Commands list

Constructor Detail

MOMCommandsImpl

public MOMCommandsImpl()

Method Detail

init

public static void init(org.osgi.framework.BundleContext context)

getInstance

public static MOMCommandsImpl getInstance()
                                   throws Exception

Throws:

Exception

help

public static void help()

Prints all MOM commands

help

public static void help(String command)

Prints the description of the given command
Usage: [joram:mom:]help

Parameters:

command - Name of the command to describe

list

public void list(String[] args)

Lists all queues, topics, both or users with useful informations
Usage: [joram:mom:]list [username]
Possible categories: destination, topic, queue, user, subscription
NB: For the subscription category, you must provide the user name.

Specified by:

list in interface MOMCommands

Parameters:

args - Category of item to list: destination, queue, topic, user

listDestination

private void listDestination()

listQueue

private void listQueue()

listTopic

private void listTopic()

listUser

private void listUser()

listSubscription

private void listSubscription(String userName)

create

public void create(String[] args)

Creates a destination or a user
Usage: [joram:mom:]create [option...]
[joram:mom:]create user []
Options: -sid Specifies on which server the destination is to be created
Default: This server
-ext Specifies which extension class to instanciate
Default: None

Specified by:

create in interface MOMCommands

Parameters:

args - parameters of the command

createDestination

private void createDestination(String[] args)

createUser

private void createUser(String[] args)

Add a new user to the servers

Parameters:

args - parameters of the command

delete

public void delete(String[] args)

Delete a destination or a user
Usage: [joram:mom:]delete (topic|queue|user)

Specified by:

delete in interface MOMCommands

Parameters:

args - {category, name}

setFreeRead

public void setFreeRead(String[] args)

setFreeWrite

public void setFreeWrite(String[] args)

queueLoad

public void queueLoad(String[] args)

Shows the pending message count
Usage: [joram:mom:]queueLoad

Specified by:

queueLoad in interface MOMCommands

Parameters:

args - parameters of the command

findQueue

private org.objectweb.joram.mom.dest.QueueMBean findQueue(String name)
                                                   throws MOMCommandsImpl.QueueNotFoundException

Throws:

MOMCommandsImpl.QueueNotFoundException

findTopic

private org.objectweb.joram.mom.dest.TopicMBean findTopic(String name)
                                                   throws MOMCommandsImpl.TopicNotFoundException

Throws:

MOMCommandsImpl.TopicNotFoundException

findAdminTopic

private org.objectweb.joram.mom.dest.AdminTopicMBean findAdminTopic()

subscriptionLoad

public void subscriptionLoad(String[] args)

Shows the pending message count of the subscription
Usage: [joram:mom:]subscriptionLoad

Specified by:

subscriptionLoad in interface MOMCommands

Parameters:

args - parameters of the command

findUser

private org.objectweb.joram.mom.proxies.UserAgentMBean findUser(String userName)

findClientSubscription

private org.objectweb.joram.mom.proxies.ClientSubscriptionMBean findClientSubscription(String userName,
                                                                                       String subName)
                                                                                throws MOMCommandsImpl.UserNotFoundException,
                                                                                       MOMCommandsImpl.SubscriptionNotFoundException

Throws:

MOMCommandsImpl.UserNotFoundException

MOMCommandsImpl.SubscriptionNotFoundException

info

public void info(String[] args)

Show information about a destination
Usage: [joram:mom:]info (queue|topic)
[joram:mom:]info subscription

Specified by:

info in interface MOMCommands

Parameters:

args - ???

infoTopic

private void infoTopic(String name)

infoQueue

private void infoQueue(String name)

infoSubscription

private void infoSubscription(String userName,
                              String subName)

lsMsg

public void lsMsg(String[] args)

Displays pending messages from a destination
Usage: [joram:mom:]lsMsg queue [[first msg idx]:[last msg idx]]
[joram:mom:]lsMsg subscription [[first msg idx]:[last msg idx]]

Specified by:

lsMsg in interface MOMCommands

Parameters:

args - {queue name, message range}

infoMsg

public void infoMsg(String[] args)

ping

public void ping()

Checks whether Joram works
Usage: [joram:mom:]ping

Specified by:

ping in interface MOMCommands

deleteMsg

public void deleteMsg(String[] args)

Delete a pending message from a queue or subscription
Usage: [joram:mom:]deleteMsg queue
[joram:mom:]deleteMsg subscription

Specified by:

deleteMsg in interface MOMCommands

deleteMsgQueue

private void deleteMsgQueue(String queueName,
                            String msgId)

deleteMsgSub

private void deleteMsgSub(String userName,
                          String subName,
                          String msgId)

clear

public void clear(String[] args)

Deletes all pending messages from a subscription or a queue.
Usage: [joram:mom:]clear queue
[joram:mom:]clear subscription

Specified by:

clear in interface MOMCommands

sendMsg

public void sendMsg(String[] args)

Deprecated.

Description copied from interface: MOMCommands

Send a new message in a destination

Specified by:

sendMsg in interface MOMCommands

receiveMsg

public void receiveMsg(String[] args)

Deprecated.

Description copied from interface: MOMCommands

Receive (a) message(s) from a destination

Specified by:

receiveMsg in interface MOMCommands

getQueueMessages

private List<org.objectweb.joram.mom.messages.MessageView> getQueueMessages(String queueName)
                                                                     throws MOMCommandsImpl.QueueNotFoundException

Throws:

MOMCommandsImpl.QueueNotFoundException

getQueueMessage

private org.objectweb.joram.mom.messages.MessageView getQueueMessage(String queueName,
                                                                     String msgId)
                                                              throws MOMCommandsImpl.QueueNotFoundException

Throws:

MOMCommandsImpl.QueueNotFoundException

getSubscriptionMessages

private List<org.objectweb.joram.mom.messages.MessageView> getSubscriptionMessages(String userName,
                                                                                   String subscriptionName)
                                                                            throws MOMCommandsImpl.UserNotFoundException,
                                                                                   MOMCommandsImpl.SubscriptionNotFoundException

Throws:

MOMCommandsImpl.UserNotFoundException

MOMCommandsImpl.SubscriptionNotFoundException

getSubscriptionMessage

private org.objectweb.joram.mom.messages.MessageView getSubscriptionMessage(String userName,
                                                                            String subName,
                                                                            String msgId)
                                                                     throws MOMCommandsImpl.UserNotFoundException,
                                                                            MOMCommandsImpl.SubscriptionNotFoundException

Throws:

MOMCommandsImpl.UserNotFoundException

MOMCommandsImpl.SubscriptionNotFoundException

getMessageRange

private List<org.objectweb.joram.mom.messages.MessageView> getMessageRange(List<org.objectweb.joram.mom.messages.MessageView> msgs,
                                                                           int start,
                                                                           int end)

main

public static void main(String[] args)