Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.jboss.mq.il
Interface Invoker

All Known Implementing Classes:
  JMSServerInvoker

public interface Invoker

Defines the methods that can be called by a client on the server.

Version:
  $Revision: 1.3 $
Author:
  Hiram Chirino, Norbert Lataille, Peter Antman

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.
`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
`void` | `setEnabled(ConnectionToken dc, boolean enabled)` Sets the Enabled attribute of the ServerIL object
`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.

Method Detail

### getThreadGroup

    public ThreadGroup getThreadGroup()

  Get the thread group of the server.

### getID

    public String getID()
                 throws javax.jms.JMSException

  Gets a clientID from server.

  Returns:
    The ID value
  Throws:
    `javax.jms.JMSException` - Description of Exception

### getTemporaryTopic

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

  Get a temporary topic.

  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

  Get a temporary queue

  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

  Close connection.

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

### checkID

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

  Check id, must not be taken.

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

### addMessage

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

  Add the message to the destination.

  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

  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.

  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

  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.

  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 of the Method

  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 of the Method

  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

  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 of the Method

  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

  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

  Sets the Enabled attribute of the ServerIL object

  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

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

  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

  Unsubscribe from the durable subscription.

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

### checkUser

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

  Check user for autentication.

  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

  Check user for autentication.

  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

  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

  Ping the server.

  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

  Get the topic the durable subscription is on. Primary for internal use in the server, and not for the IL's.

  Throws:
    `javax.jms.JMSException`

### getSubscription

    public Subscription getSubscription(ConnectionToken dc,
                                        int subscriberId)
                                 throws javax.jms.JMSException

  Get the subscription that match the id.

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

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

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