org.jboss.mq.server
Class JMSServerInterceptorSupport

java.lang.Object
  org.jboss.mq.server.JMSServerInterceptorSupport

All Implemented Interfaces:

Recoverable, JMSServerInterceptor

Direct Known Subclasses:

ClientMonitorInterceptor, JMSDestinationManager, NonPersistentInterceptor, ServerSecurityInterceptor, TracingInterceptor

public class JMSServerInterceptorSupport
extends Object
implements JMSServerInterceptor, Recoverable

A pass through JMSServerInvoker.

Version:

$Revision: 57198 $

Author:

Peter Antman, Adrian Brock

Field Summary

protected org.jboss.logging.Logger	log
protected JMSServerInterceptor	nextInterceptor Next invoker in chain.

Constructor Summary

JMSServerInterceptorSupport()

Method Summary

void	acknowledge(ConnectionToken dc, AcknowledgementRequest item) #Description of the Method
void	addMessage(ConnectionToken dc, SpyMessage message) Add the message to the destination.
String	authenticate(String userName, String password) Check user for autentication.
SpyMessage[]	browse(ConnectionToken dc, javax.jms.Destination dest, String selector) #Description of the Method
void	checkID(String ID) Check id, must not be taken.
String	checkUser(String userName, String password) Check user for autentication.
void	connectionClosing(ConnectionToken dc) Close connection.
javax.jms.Queue	createQueue(ConnectionToken dc, String dest) Create a queue.
javax.jms.Topic	createTopic(ConnectionToken dc, String dest) Create a topic.
void	deleteTemporaryDestination(ConnectionToken dc, SpyDestination dest) #Description of the Method
void	destroySubscription(ConnectionToken dc, DurableSubscriptionID id) Unsubscribe from the durable subscription.
SpyTopic	getDurableTopic(DurableSubscriptionID sub) Get the topic the durable subscription is on.
String	getID() Gets a clientID from server.
JMSServerInterceptor	getNext() Get next invoker in chain to be called.
Subscription	getSubscription(ConnectionToken dc, int subscriberId) Get the subscription that match the id.
javax.jms.TemporaryQueue	getTemporaryQueue(ConnectionToken dc) Get a temporary queue
javax.jms.TemporaryTopic	getTemporaryTopic(ConnectionToken dc) Get a temporary topic.
ThreadGroup	getThreadGroup() Get the thread group of the server.
void	ping(ConnectionToken dc, long clientTime) Ping the server.
SpyMessage	receive(ConnectionToken dc, int subscriberId, long wait) #Description of the Method
Xid[]	recover(ConnectionToken dc, int flags) Recover
void	setEnabled(ConnectionToken dc, boolean enabled) Sets the Enabled attribute of the ServerIL object
void	setNext(JMSServerInterceptor server) Set next Interceptor in chain to be called.
void	subscribe(ConnectionToken dc, Subscription s)
void	transact(ConnectionToken dc, TransactionRequest t) #Description of the Method
void	unsubscribe(ConnectionToken dc, int subscriptionId) Close the server side message consumer.

Methods inherited from class java.lang.Object

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

Field Detail

log

protected org.jboss.logging.Logger log

nextInterceptor

protected JMSServerInterceptor nextInterceptor

Next invoker in chain.

Constructor Detail

JMSServerInterceptorSupport

public JMSServerInterceptorSupport()

Method Detail

setNext

public void setNext(JMSServerInterceptor server)

Description copied from interface: JMSServerInterceptor

Set next Interceptor in chain to be called. Is mot often the real JMSServer

Specified by:

setNext in interface JMSServerInterceptor

getNext

public JMSServerInterceptor getNext()

Description copied from interface: JMSServerInterceptor

Get next invoker in chain to be called. Is mot often the real JMSServer

Specified by:

getNext in interface JMSServerInterceptor

getThreadGroup

public ThreadGroup getThreadGroup()

Description copied from interface: JMSServerInterceptor

Get the thread group of the server.

Specified by:

getThreadGroup in interface JMSServerInterceptor

getID

public String getID()
             throws javax.jms.JMSException

Description copied from interface: JMSServerInterceptor

Gets a clientID from server.

Specified by:

getID in interface JMSServerInterceptor

Returns:

The ID value

Throws:

javax.jms.JMSException - Description of Exception

getTemporaryTopic

public javax.jms.TemporaryTopic getTemporaryTopic(ConnectionToken dc)
                                           throws javax.jms.JMSException

Description copied from interface: JMSServerInterceptor

Get a temporary topic.

Specified by:

getTemporaryTopic in interface JMSServerInterceptor

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

Description copied from interface: JMSServerInterceptor

Get a temporary queue

Specified by:

getTemporaryQueue in interface JMSServerInterceptor

Parameters:

dc - Description of Parameter

Returns:

The TemporaryQueue value

Throws:

javax.jms.JMSException - Description of Exception

connectionClosing

public void connectionClosing(ConnectionToken dc)
                       throws javax.jms.JMSException

Description copied from interface: JMSServerInterceptor

Close connection.

Specified by:

connectionClosing in interface JMSServerInterceptor

Parameters:

dc - Description of Parameter

Throws:

javax.jms.JMSException - Description of Exception

checkID

public void checkID(String ID)
             throws javax.jms.JMSException

Description copied from interface: JMSServerInterceptor

Check id, must not be taken.

Specified by:

checkID in interface JMSServerInterceptor

Parameters:

ID - Description of Parameter

Throws:

javax.jms.JMSException - Description of Exception

addMessage

public void addMessage(ConnectionToken dc,
                       SpyMessage message)
                throws javax.jms.JMSException

Description copied from interface: JMSServerInterceptor

Add the message to the destination.

Specified by:

addMessage in interface JMSServerInterceptor

Parameters:

dc - The feature to be added to the Message attribute

message - The feature to be added to the Message attribute

Throws:

javax.jms.JMSException - Description of Exception

createQueue

public javax.jms.Queue createQueue(ConnectionToken dc,
                                   String dest)
                            throws javax.jms.JMSException

Description copied from interface: JMSServerInterceptor

Create a queue. The destination name must be the name of an already existing destination. This method should only be used to skip looking up a destination through JNDI, not to actually create a new destination.

Specified by:

createQueue in interface JMSServerInterceptor

Parameters:

dc - Description of Parameter

dest - 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 dest)
                            throws javax.jms.JMSException

Description copied from interface: JMSServerInterceptor

Create a topic. The destination name must be the name of an already existing destination. This method should only be used to skip looking up a destination through JNDI, not to actually create a new destination.

Specified by:

createTopic in interface JMSServerInterceptor

Parameters:

dc - Description of Parameter

dest - 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 copied from interface: JMSServerInterceptor

#Description of the Method

Specified by:

deleteTemporaryDestination in interface JMSServerInterceptor

Parameters:

dc - Description of Parameter

dest - Description of Parameter

Throws:

javax.jms.JMSException - Description of Exception

transact

public void transact(ConnectionToken dc,
                     TransactionRequest t)
              throws javax.jms.JMSException

Description copied from interface: JMSServerInterceptor

#Description of the Method

Specified by:

transact in interface JMSServerInterceptor

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 copied from interface: JMSServerInterceptor

#Description of the Method

Specified by:

acknowledge in interface JMSServerInterceptor

Parameters:

dc - Description of Parameter

item - 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 copied from interface: JMSServerInterceptor

#Description of the Method

Specified by:

browse in interface JMSServerInterceptor

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 copied from interface: JMSServerInterceptor

#Description of the Method

Specified by:

receive in interface JMSServerInterceptor

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

setEnabled

public void setEnabled(ConnectionToken dc,
                       boolean enabled)
                throws javax.jms.JMSException

Description copied from interface: JMSServerInterceptor

Sets the Enabled attribute of the ServerIL object

Specified by:

setEnabled in interface JMSServerInterceptor

Parameters:

dc - The new Enabled value

enabled - The new Enabled value

Throws:

javax.jms.JMSException - Description of Exception

unsubscribe

public void unsubscribe(ConnectionToken dc,
                        int subscriptionId)
                 throws javax.jms.JMSException

Description copied from interface: JMSServerInterceptor

Close the server side message consumer. Client is no longer available to receive messages.

Specified by:

unsubscribe in interface JMSServerInterceptor

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 copied from interface: JMSServerInterceptor

Unsubscribe from the durable subscription.

Specified by:

destroySubscription in interface JMSServerInterceptor

id - Description of Parameter

Throws:

javax.jms.JMSException - Description of Exception

checkUser

public String checkUser(String userName,
                        String password)
                 throws javax.jms.JMSException

Description copied from interface: JMSServerInterceptor

Check user for autentication.

Specified by:

checkUser in interface JMSServerInterceptor

Parameters:

userName - Description of Parameter

password - Description of Parameter

Returns:

a preconfigured clientId.

Throws:

javax.jms.JMSException - if user was not allowed to login

authenticate

public String authenticate(String userName,
                           String password)
                    throws javax.jms.JMSException

Description copied from interface: JMSServerInterceptor

Check user for autentication.

Specified by:

authenticate in interface JMSServerInterceptor

Parameters:

userName - Description of Parameter

password - Description of Parameter

Returns:

a sessionId.

Throws:

javax.jms.JMSException - if user was not allowed to login

subscribe

public void subscribe(ConnectionToken dc,
                      Subscription s)
               throws javax.jms.JMSException

Specified by:

subscribe in interface JMSServerInterceptor

Parameters:

dc - org.jboss.mq.ConnectionToken

s - org.jboss.mq.Subscription

Throws:

javax.jms.JMSException - The exception description.

ping

public void ping(ConnectionToken dc,
                 long clientTime)
          throws javax.jms.JMSException

Description copied from interface: JMSServerInterceptor

Ping the server.

Specified by:

ping in interface JMSServerInterceptor

Parameters:

dc - Description of Parameter

clientTime - Description of Parameter

Throws:

javax.jms.JMSException - Description of Exception

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

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

Throws:

javax.jms.JMSException - if it can not find the subscription.

recover

public Xid[] recover(ConnectionToken dc,
                     int flags)
              throws Exception

Description copied from interface: Recoverable

Recover

Specified by:

recover in interface Recoverable

Parameters:

dc - the connnection token

flags - the recovery flags

Returns:

the xids

Throws:

Exception - for any error