站内搜索: 请输入搜索关键词
当前页面: 在线文档首页 > JBoss 3.2.7 messaging API Documentation 英文版文档

JMSDestinationManager (JBoss Messaging API) - JBoss 3.2.7 messaging API Documentation 英文版文档


org.jboss.mq.server
Class JMSDestinationManager

java.lang.Object
  extended byorg.jboss.mq.server.JMSServerInterceptorSupport
      extended byorg.jboss.mq.server.JMSDestinationManager
All Implemented Interfaces:
JMSServerInterceptor

public class JMSDestinationManager
extends JMSServerInterceptorSupport

This class implements the JMS provider

Version:
$Revision: 1.2.2.20 $
Author:
Norbert Lataille (Norbert.Lataille@m4x.org), Hiram Chirino (Cojonudo14@hotmail.com), David Maplesden (David.Maplesden@orion.co.nz), Peter Antman

Field Summary
 Map closingDestinations
          Destinations being closed SpyDestination -> JMSDestination
 Map destinations
          Destinations SpyDestination -> JMSDestination
static String JBOSS_VESION
          Description of the Field
 ThreadGroup threadGroup
          Thread group
 
Fields inherited from class org.jboss.mq.server.JMSServerInterceptorSupport
nextInterceptor
 
Constructor Summary
JMSDestinationManager(BasicQueueParameters parameters)
          Constructor for the JMSServer object
 
Method Summary
 void acknowledge(ConnectionToken dc, AcknowledgementRequest item)
          #Description of the Method
 void acknowledge(ConnectionToken dc, AcknowledgementRequest item, Tx txId)
          #Description of the Method
 void addDestination(JMSDestination destination)
          Adds a feature to the Destination attribute of the JMSServer object
 void addMessage(ConnectionToken dc, SpyMessage val)
          Adds a feature to the Message attribute of the JMSServer object
 void addMessage(ConnectionToken dc, SpyMessage val, Tx txId)
          Adds a feature to the Message attribute of the JMSServer object
 String authenticate(String id, String password)
          authenticate user and return a session id.
 SpyMessage[] browse(ConnectionToken dc, javax.jms.Destination dest, String selector)
          #Description of the Method
 void checkID(String ID)
          Check a clienID set by the client.
 String checkUser(String userName, String password)
          #Description of the Method
 void closeDestination(SpyDestination dest)
          Closed a destination that was opened previously
 void connectionClosing(ConnectionToken dc)
          #Description of the Method
 void connectionFailure(ConnectionToken dc)
          #Description of the Method
 javax.jms.Queue createQueue(ConnectionToken dc, String name)
          #Description of the Method
 javax.jms.Topic createTopic(ConnectionToken dc, String name)
          #Description of the Method
protected  void deleteTemporaryDestination(ConnectionToken dc, JMSDestination destination)
           
 void deleteTemporaryDestination(ConnectionToken dc, SpyDestination dest)
          #Description of the Method
 void destroySubscription(ConnectionToken dc, DurableSubscriptionID id)
          #Description of the Method
 ClientConsumer getClientConsumer(ConnectionToken dc)
          Gets the ClientConsumer attribute of the JMSServer object
 int getClientCount()
           
 HashMap getClients()
          Obtain a copy of the current clients
 SpyTopic getDurableTopic(DurableSubscriptionID sub)
          Get the topic the durable subscription is on.
 String getID()
          Gets the ID attribute of the JMSServer object
 JMSDestination getJMSDestination(SpyDestination dest)
          Gets the JMSDestination attribute of the JMSServer object
 MessageCache getMessageCache()
          Gets the messageCache
 MessageCounter[] getMessageCounter()
          Gets message counters of all configured destinations
 PersistenceManager getPersistenceManager()
          Gets the PersistenceManager attribute of the JMSServer object
protected  JMSDestination getPossiblyClosingJMSDestination(SpyDestination dest)
          Gets the JMSDestination attribute of the JMSServer object which might be being closed
 StateManager getStateManager()
          Gets the StateManager attribute of the JMSServer object
 Subscription getSubscription(ConnectionToken dc, int subscriberId)
          Get the subscription that match the id.
 javax.jms.TemporaryQueue getTemporaryQueue(ConnectionToken dc)
          Gets the TemporaryQueue attribute of the JMSServer object
 javax.jms.TemporaryTopic getTemporaryTopic(ConnectionToken dc)
          Gets the TemporaryTopic attribute of the JMSServer object
 ThreadGroup getThreadGroup()
          Get the thread group of the server.
 boolean isStopped()
          Returns false if the JMS server is currently running and handling requests, true otherwise.
 void ping(ConnectionToken dc, long clientTime)
          #Description of the Method
 SpyMessage receive(ConnectionToken dc, int subscriberId, long wait)
          #Description of the Method
 void resetMessageCounter()
          Resets message counters of all configured destinations
 void setEnabled(ConnectionToken dc, boolean enabled)
          Sets the Enabled attribute of the JMSServer object
 void setMessageCache(MessageCache messageCache)
          Sets the messageCache
 void setPersistenceManager(PersistenceManager newPersistenceManager)
          Sets the PersistenceManager attribute of the JMSServer object
 void setStateManager(StateManager newStateManager)
          Sets the StateManager attribute of the JMSServer object
 void startServer()
          #Description of the Method
 void stopServer()
          #Description of the Method
 void subscribe(ConnectionToken dc, Subscription sub)
          #Description of the Method
 String toString()
          #Description of the Method
 void transact(ConnectionToken dc, TransactionRequest t)
          The following function performs a Unit Of Work.
 void unsubscribe(ConnectionToken dc, int subscriptionId)
          #Description of the Method
 
Methods inherited from class org.jboss.mq.server.JMSServerInterceptorSupport
getNext, setNext
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

JBOSS_VESION

public static final String JBOSS_VESION
Description of the Field

See Also:
Constant Field Values

destinations

public Map destinations
Destinations SpyDestination -> JMSDestination


closingDestinations

public Map closingDestinations
Destinations being closed SpyDestination -> JMSDestination


threadGroup

public ThreadGroup threadGroup
Thread group

Constructor Detail

JMSDestinationManager

public JMSDestinationManager(BasicQueueParameters parameters)
Constructor for the JMSServer object

Method Detail

setEnabled

public void setEnabled(ConnectionToken dc,
                       boolean enabled)
                throws javax.jms.JMSException
Sets the Enabled attribute of the JMSServer object

Specified by:
setEnabled in interface JMSServerInterceptor
Overrides:
setEnabled in class JMSServerInterceptorSupport
Parameters:
dc - The new Enabled value
enabled - The new Enabled value
Throws:
javax.jms.JMSException - Description of Exception

setStateManager

public void setStateManager(StateManager newStateManager)
Sets the StateManager attribute of the JMSServer object

Parameters:
newStateManager - The new StateManager value

setPersistenceManager

public void setPersistenceManager(PersistenceManager newPersistenceManager)
Sets the PersistenceManager attribute of the JMSServer object

Parameters:
newPersistenceManager - The new PersistenceManager value

isStopped

public boolean isStopped()
Returns false if the JMS server is currently running and handling requests, true otherwise.

Returns:
false if the JMS server is currently running and handling requests, true otherwise.

getClientCount

public int getClientCount()
Returns:
the current client count

getClients

public HashMap getClients()
Obtain a copy of the current clients

Returns:
a HashMap of current clients

getThreadGroup

public ThreadGroup getThreadGroup()
Description copied from class: JMSServerInterceptorSupport
Get the thread group of the server.

Specified by:
getThreadGroup in interface JMSServerInterceptor
Overrides:
getThreadGroup in class JMSServerInterceptorSupport

getID

public String getID()
Gets the ID attribute of the JMSServer object

Specified by:
getID in interface JMSServerInterceptor
Overrides:
getID in class JMSServerInterceptorSupport
Returns:
The ID value

getTemporaryTopic

public javax.jms.TemporaryTopic getTemporaryTopic(ConnectionToken dc)
                                           throws javax.jms.JMSException
Gets the TemporaryTopic attribute of the JMSServer object

Specified by:
getTemporaryTopic in interface JMSServerInterceptor
Overrides:
getTemporaryTopic in class JMSServerInterceptorSupport
Parameters:
dc - Description of Parameter
Returns:
The TemporaryTopic value
Throws:
javax.jms.JMSException - Description of Exception

getTemporaryQueue

public javax.jms.TemporaryQueue getTemporaryQueue(ConnectionToken dc)
                                           throws javax.jms.JMSException
Gets the TemporaryQueue attribute of the JMSServer object

Specified by:
getTemporaryQueue in interface JMSServerInterceptor
Overrides:
getTemporaryQueue in class JMSServerInterceptorSupport
Parameters:
dc - Description of Parameter
Returns:
The TemporaryQueue value
Throws:
javax.jms.JMSException - Description of Exception

getClientConsumer

public ClientConsumer getClientConsumer(ConnectionToken dc)
                                 throws javax.jms.JMSException
Gets the ClientConsumer attribute of the JMSServer object

Parameters:
dc - Description of Parameter
Returns:
The ClientConsumer value
Throws:
javax.jms.JMSException - Description of Exception

getJMSDestination

public JMSDestination getJMSDestination(SpyDestination dest)
Gets the JMSDestination attribute of the JMSServer object

Parameters:
dest - Description of Parameter
Returns:
The JMSDestination value

getPossiblyClosingJMSDestination

protected JMSDestination getPossiblyClosingJMSDestination(SpyDestination dest)
Gets the JMSDestination attribute of the JMSServer object which might be being closed

Parameters:
dest - Description of Parameter
Returns:
The JMSDestination value

getStateManager

public StateManager getStateManager()
Gets the StateManager attribute of the JMSServer object

Returns:
The StateManager value

getPersistenceManager

public PersistenceManager getPersistenceManager()
Gets the PersistenceManager attribute of the JMSServer object

Returns:
The PersistenceManager value

startServer

public void startServer()
#Description of the Method


stopServer

public void stopServer()
#Description of the Method


checkID

public void checkID(String ID)
             throws javax.jms.JMSException
Check a clienID set by the client.

Specified by:
checkID in interface JMSServerInterceptor
Overrides:
checkID in class JMSServerInterceptorSupport
Parameters:
ID - Description of Parameter
Throws:
javax.jms.JMSException - Description of Exception

addMessage

public void addMessage(ConnectionToken dc,
                       SpyMessage val)
                throws javax.jms.JMSException
Adds a feature to the Message attribute of the JMSServer object

Specified by:
addMessage in interface JMSServerInterceptor
Overrides:
addMessage in class JMSServerInterceptorSupport
Parameters:
dc - The feature to be added to the Message attribute
val - The feature to be added to the Message attribute
Throws:
javax.jms.JMSException - Description of Exception

addMessage

public void addMessage(ConnectionToken dc,
                       SpyMessage val,
                       Tx txId)
                throws javax.jms.JMSException
Adds a feature to the Message attribute of the JMSServer object

Parameters:
dc - The feature to be added to the Message attribute
val - The feature to be added to the Message attribute
txId - The feature to be added to the Message attribute
Throws:
javax.jms.JMSException - Description of Exception

transact

public void transact(ConnectionToken dc,
                     TransactionRequest t)
              throws javax.jms.JMSException
The following function performs a Unit Of Work.

Specified by:
transact in interface JMSServerInterceptor
Overrides:
transact in class JMSServerInterceptorSupport
Parameters:
dc - Description of Parameter
t - Description of Parameter
Throws:
javax.jms.JMSException - Description of Exception

acknowledge

public void acknowledge(ConnectionToken dc,
                        AcknowledgementRequest item)
                 throws javax.jms.JMSException
#Description of the Method

Specified by:
acknowledge in interface JMSServerInterceptor
Overrides:
acknowledge in class JMSServerInterceptorSupport
Parameters:
dc - Description of Parameter
item - Description of Parameter
Throws:
javax.jms.JMSException - Description of Exception

acknowledge

public void acknowledge(ConnectionToken dc,
                        AcknowledgementRequest item,
                        Tx txId)
                 throws javax.jms.JMSException
#Description of the Method

Parameters:
dc - Description of Parameter
item - Description of Parameter
txId - Description of Parameter
Throws:
javax.jms.JMSException - Description of Exception

connectionClosing

public void connectionClosing(ConnectionToken dc)
                       throws javax.jms.JMSException
#Description of the Method

Specified by:
connectionClosing in interface JMSServerInterceptor
Overrides:
connectionClosing in class JMSServerInterceptorSupport
Parameters:
dc - Description of Parameter
Throws:
javax.jms.JMSException - Description of Exception

connectionFailure

public void connectionFailure(ConnectionToken dc)
                       throws javax.jms.JMSException
#Description of the Method

Parameters:
dc - Description of Parameter
Throws:
javax.jms.JMSException - Description of Exception

subscribe

public void subscribe(ConnectionToken dc,
                      Subscription sub)
               throws javax.jms.JMSException
#Description of the Method

Specified by:
subscribe in interface JMSServerInterceptor
Overrides:
subscribe in class JMSServerInterceptorSupport
Parameters:
dc - Description of Parameter
sub - Description of Parameter
Throws:
javax.jms.JMSException - Description of Exception

unsubscribe

public void unsubscribe(ConnectionToken dc,
                        int subscriptionId)
                 throws javax.jms.JMSException
#Description of the Method

Specified by:
unsubscribe in interface JMSServerInterceptor
Overrides:
unsubscribe in class JMSServerInterceptorSupport
Parameters:
dc - Description of Parameter
subscriptionId - Description of Parameter
Throws:
javax.jms.JMSException - Description of Exception

destroySubscription

public void destroySubscription(ConnectionToken dc,
                                DurableSubscriptionID id)
                         throws javax.jms.JMSException
#Description of the Method

Specified by:
destroySubscription in interface JMSServerInterceptor
Overrides:
destroySubscription in class JMSServerInterceptorSupport
Parameters:
id - Description of Parameter
Throws:
javax.jms.JMSException - Description of Exception

browse

public SpyMessage[] browse(ConnectionToken dc,
                           javax.jms.Destination dest,
                           String selector)
                    throws javax.jms.JMSException
#Description of the Method

Specified by:
browse in interface JMSServerInterceptor
Overrides:
browse in class JMSServerInterceptorSupport
Parameters:
dc - Description of Parameter
dest - Description of Parameter
selector - Description of Parameter
Returns:
Description of the Returned Value
Throws:
javax.jms.JMSException - Description of Exception

receive

public SpyMessage receive(ConnectionToken dc,
                          int subscriberId,
                          long wait)
                   throws javax.jms.JMSException
#Description of the Method

Specified by:
receive in interface JMSServerInterceptor
Overrides:
receive in class JMSServerInterceptorSupport
Parameters:
dc - Description of Parameter
subscriberId - Description of Parameter
wait - Description of Parameter
Returns:
Description of the Returned Value
Throws:
javax.jms.JMSException - Description of Exception

createQueue

public javax.jms.Queue createQueue(ConnectionToken dc,
                                   String name)
                            throws javax.jms.JMSException
#Description of the Method

Specified by:
createQueue in interface JMSServerInterceptor
Overrides:
createQueue in class JMSServerInterceptorSupport
Parameters:
dc - Description of Parameter
name - Description of Parameter
Returns:
Description of the Returned Value
Throws:
javax.jms.JMSException - Description of Exception

createTopic

public javax.jms.Topic createTopic(ConnectionToken dc,
                                   String name)
                            throws javax.jms.JMSException
#Description of the Method

Specified by:
createTopic in interface JMSServerInterceptor
Overrides:
createTopic in class JMSServerInterceptorSupport
Parameters:
dc - Description of Parameter
name - Description of Parameter
Returns:
Description of the Returned Value
Throws:
javax.jms.JMSException - Description of Exception

deleteTemporaryDestination

public void deleteTemporaryDestination(ConnectionToken dc,
                                       SpyDestination dest)
                                throws javax.jms.JMSException
#Description of the Method

Specified by:
deleteTemporaryDestination in interface JMSServerInterceptor
Overrides:
deleteTemporaryDestination in class JMSServerInterceptorSupport
Parameters:
dc - Description of Parameter
dest - Description of Parameter
Throws:
javax.jms.JMSException - Description of Exception

deleteTemporaryDestination

protected void deleteTemporaryDestination(ConnectionToken dc,
                                          JMSDestination destination)
                                   throws javax.jms.JMSException
Throws:
javax.jms.JMSException

checkUser

public String checkUser(String userName,
                        String password)
                 throws javax.jms.JMSException
#Description of the Method

Specified by:
checkUser in interface JMSServerInterceptor
Overrides:
checkUser in class JMSServerInterceptorSupport
Parameters:
userName - Description of Parameter
password - Description of Parameter
Returns:
Description of the Returned Value
Throws:
javax.jms.JMSException - Description of Exception

authenticate

public String authenticate(String id,
                           String password)
                    throws javax.jms.JMSException
authenticate user and return a session id. Same as checkID.

Specified by:
authenticate in interface JMSServerInterceptor
Overrides:
authenticate in class JMSServerInterceptorSupport
Parameters:
id - Description of Parameter
password - Description of Parameter
Returns:
a sessionId
Throws:
javax.jms.JMSException - Description of Exception

addDestination

public void addDestination(JMSDestination destination)
                    throws javax.jms.JMSException
Adds a feature to the Destination attribute of the JMSServer object

Throws:
javax.jms.JMSException - Description of Exception

closeDestination

public void closeDestination(SpyDestination dest)
                      throws javax.jms.JMSException
Closed a destination that was opened previously

Parameters:
dest - the destionation to close
Throws:
javax.jms.JMSException - Description of Exception

toString

public String toString()
#Description of the Method

Returns:
Description of the Returned Value

ping

public void ping(ConnectionToken dc,
                 long clientTime)
          throws javax.jms.JMSException
#Description of the Method

Specified by:
ping in interface JMSServerInterceptor
Overrides:
ping in class JMSServerInterceptorSupport
Parameters:
dc - Description of Parameter
clientTime - Description of Parameter
Throws:
javax.jms.JMSException - Description of Exception

getMessageCache

public MessageCache getMessageCache()
Gets the messageCache

Returns:
Returns a MessageCache

setMessageCache

public void setMessageCache(MessageCache messageCache)
Sets the messageCache

Parameters:
messageCache - The messageCache to set

getDurableTopic

public SpyTopic getDurableTopic(DurableSubscriptionID sub)
                         throws javax.jms.JMSException
Description copied from interface: JMSServerInterceptor
Get the topic the durable subscription is on. Primary for internal use in the server, and not for the IL's.

Specified by:
getDurableTopic in interface JMSServerInterceptor
Overrides:
getDurableTopic in class JMSServerInterceptorSupport
Throws:
javax.jms.JMSException

getSubscription

public Subscription getSubscription(ConnectionToken dc,
                                    int subscriberId)
                             throws javax.jms.JMSException
Description copied from interface: JMSServerInterceptor
Get the subscription that match the id.

Specified by:
getSubscription in interface JMSServerInterceptor
Overrides:
getSubscription in class JMSServerInterceptorSupport
Throws:
javax.jms.JMSException

getMessageCounter

public MessageCounter[] getMessageCounter()
Gets message counters of all configured destinations

Returns:
MessageCounter[] message counter array sorted by name

resetMessageCounter

public void resetMessageCounter()
Resets message counters of all configured destinations



Copyright © 2002 JBoss Group, LLC. All Rights Reserved.