01: /*
02: * MessageQueueClient: The message queue client library
03: * Copyright (C) 2006 Rift IT Contracting
04: *
05: * This library is free software; you can redistribute it and/or
06: * modify it under the terms of the GNU Lesser General Public
07: * License as published by the Free Software Foundation; either
08: * version 2.1 of the License, or (at your option) any later version.
09: *
10: * This library is distributed in the hope that it will be useful,
11: * but WITHOUT ANY WARRANTY; without even the implied warranty of
12: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13: * Lesser General Public License for more details.
14: *
15: * You should have received a copy of the GNU Lesser General Public
16: * License along with this library; if not, write to the Free Software
17: * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18: *
19: * MessageService.java
20: */
21:
22: // package path
23: package com.rift.coad.daemon.messageservice;
24:
25: // java imports
26: import java.rmi.Remote;
27: import java.rmi.RemoteException;
28: import java.util.List;
29:
30: /**
31: * The management interface for the message service.
32: *
33: * @author Brett Chaldecott
34: */
35: public interface MessageServiceManagerMBean extends Remote {
36:
37: /**
38: * The jndi of the message service.
39: */
40: public final static String JNDI_URL = "message/MessageService";
41:
42: /**
43: * This method returns the thread pool size.
44: *
45: * @return The size of the thread pool.
46: * @exception RemoteException
47: * @exception MessageServiceException
48: */
49: public int getThreadPoolSize() throws RemoteException,
50: MessageServiceException;
51:
52: /**
53: * This method sets the size of the thread pool.
54: *
55: * @param size The new size of the thread pool.
56: * @exception RemoteException
57: * @exception MessageServiceException
58: */
59: public void setThreadPoolSize(int size) throws RemoteException,
60: MessageServiceException;
61:
62: /**
63: * This method lists the named queues.
64: *
65: * @return The list of named queues.
66: * @exception RemoteException
67: * @exception MessageServiceException
68: */
69: public List listNamedQueues() throws RemoteException,
70: MessageServiceException;
71:
72: /**
73: * This method returns the list of messages in the named queue.
74: *
75: * @return The list of messages for this queue.
76: * @param queueName The name of the queue to list messages for.
77: * @exception RemoteException
78: * @exception MessageServiceException
79: */
80: public List listMessagesForNamedQueue(String queueName)
81: throws RemoteException, MessageServiceException;
82:
83: /**
84: * This purges the messages from the named queue
85: *
86: * @param queueName The name of the queue to purge.
87: * @exception RemoteException
88: * @exception MessageServiceException
89: */
90: public void purgeNamedQueue(String queueName)
91: throws RemoteException, MessageServiceException;
92: }
|