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.http
Class HTTPServerIL

    java.lang.Object
      org.jboss.mq.il.http.HTTPServerIL

All Implemented Interfaces:
  Serializable, ServerIL

public class HTTPServerIL
extends Object
implements Serializable, ServerIL

Client proxy to the server. For each request, an HTTP or HTTPS request is created, and posted to the given URL. The URL is supplied in the HTTPServerILService MBean configuration, or automatically generated by as localhost here, but can be overridden on the client side by specifying a property name for the URL value, which will be resolved to a system property on the client side.

Version:
  $Revision: 1.3 $
Author:
  Nathan Phelps (nathan@jboss.org)
See Also:
  Serialized Form

Constructor Summary
`HTTPServerIL(String url)`

Method Summary
`void` | `acknowledge(ConnectionToken dc, AcknowledgementRequest item)` #Description of the Method
`void` | `addMessage(ConnectionToken dc, SpyMessage message)` Adds a message to the destination specifyed in the message.
`String` | `authenticate(String userName, String password)` Authenticate the user.
`SpyMessage[]` | `browse(ConnectionToken dc, javax.jms.Destination dest, String selector)` #Description of the Method
`void` | `checkID(String ID)` Check if clientID is a valid ID.
`String` | `checkUser(String userName, String password)` Get a clientID for a given user/password.
`ServerIL` | `cloneServerIL()` #Description of the Method
`void` | `connectionClosing(ConnectionToken dc)` The client is closing the connection.
`javax.jms.Queue` | `createQueue(ConnectionToken dc, String dest)` #Description of the Method
`javax.jms.Topic` | `createTopic(ConnectionToken dc, String dest)` #Description of the Method
`void` | `deleteTemporaryDestination(ConnectionToken dc, SpyDestination dest)` #Description of the Method
`void` | `destroySubscription(ConnectionToken dc, DurableSubscriptionID id)` Unsubscribe from a durable subscription.
`String` | `getID()` Get a clientID from the server.
`javax.jms.TemporaryQueue` | `getTemporaryQueue(ConnectionToken dc)` Gets the TemporaryQueue attribute of the ServerIL object
`javax.jms.TemporaryTopic` | `getTemporaryTopic(ConnectionToken dc)` Gets the TemporaryTopic attribute of the ServerIL object
`void` | `ping(ConnectionToken dc, long clientTime)` Ping the server.
`SpyMessage` | `receive(ConnectionToken dc, int subscriberId, long wait)` Get a message synchronously.
`void` | `setConnectionToken(ConnectionToken newConnectionToken)`
`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)` Remove a consumer.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

### HTTPServerIL

    public HTTPServerIL(String url)
                 throws Exception

Method Detail

### acknowledge

    public void acknowledge(ConnectionToken dc,
                            AcknowledgementRequest item)
                     throws Exception

  Description copied from interface: `ServerIL`
  #Description of the Method

  Specified by:
    `acknowledge` in interface `ServerIL`
  Parameters:
    `dc` - Description of Parameter
    `item` - Description of Parameter
  Throws:
    `Exception` - Description of Exception

### addMessage

    public void addMessage(ConnectionToken dc,
                           SpyMessage message)
                    throws Exception

  Description copied from interface: `ServerIL`
  Adds a message to the destination specifyed in the message.

  Specified by:
    `addMessage` in interface `ServerIL`
  Parameters:
    `dc` - The feature to be added to the Message attribute
    `message` - The feature to be added to the Message attribute
  Throws:
    `Exception` - Description of Exception

### authenticate

    public String authenticate(String userName,
                               String password)
                        throws Exception

  Description copied from interface: `ServerIL`
  Authenticate the user. If using a securityManager the user will be autenticated by that.

  Specified by:
    `authenticate` in interface `ServerIL`
  Parameters:
    `userName` - a username.
    `password` - a password.
  Returns:
    a sessionid, valid only for the life of this connection.
  Throws:
    `Exception` - Description of Exception

### browse

    public SpyMessage[] browse(ConnectionToken dc,
                               javax.jms.Destination dest,
                               String selector)
                        throws Exception

  Description copied from interface: `ServerIL`
  #Description of the Method

  Specified by:
    `browse` in interface `ServerIL`
  Parameters:
    `dc` - Description of Parameter
    `dest` - Description of Parameter
    `selector` - Description of Parameter
  Returns:
    Description of the Returned Value
  Throws:
    `Exception` - Description of Exception

### checkID

    public void checkID(String ID)
                 throws Exception

  Description copied from interface: `ServerIL`
  Check if clientID is a valid ID. This method should be called when the client tries to set its own clientID. It is up to the server side components to update the ConectionToken if this method returns normaly.

  Specified by:
    `checkID` in interface `ServerIL`
  Parameters:
    `ID` - a clientID set by the client.
  Throws:
    `Exception` - if the clientID was not vallid.

### checkUser

    public String checkUser(String userName,
                            String password)
                     throws Exception

  Description copied from interface: `ServerIL`
  Get a clientID for a given user/password. May also be used for autentication if StateManager is used as authenticator.

  Specified by:
    `checkUser` in interface `ServerIL`
  Parameters:
    `userName` - a valid user name that the StateManager knows about.
    `password` - a password
  Returns:
    a preconfigured clientID or null.
  Throws:
    `Exception` - Description of Exception

### cloneServerIL

    public ServerIL cloneServerIL()
                           throws Exception

  Description copied from interface: `ServerIL`
  #Description of the Method

  Specified by:
    `cloneServerIL` in interface `ServerIL`
  Returns:
    Description of the Returned Value
  Throws:
    `Exception` - Description of Exception

### connectionClosing

    public void connectionClosing(ConnectionToken dc)
                           throws Exception

  Description copied from interface: `ServerIL`
  The client is closing the connection.

  Specified by:
    `connectionClosing` in interface `ServerIL`
  Parameters:
    `dc` - Description of Parameter
  Throws:
    `Exception` - Description of Exception

### createQueue

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

  Description copied from interface: `ServerIL`
  #Description of the Method

  Specified by:
    `createQueue` in interface `ServerIL`
  Parameters:
    `dc` - Description of Parameter
    `dest` - Description of Parameter
  Returns:
    Description of the Returned Value
  Throws:
    `Exception` - Description of Exception

### createTopic

    public javax.jms.Topic createTopic(ConnectionToken dc,
                                       String dest)
                                throws Exception

  Description copied from interface: `ServerIL`
  #Description of the Method

  Specified by:
    `createTopic` in interface `ServerIL`
  Parameters:
    `dc` - Description of Parameter
    `dest` - Description of Parameter
  Returns:
    Description of the Returned Value
  Throws:
    `Exception` - Description of Exception

### deleteTemporaryDestination

    public void deleteTemporaryDestination(ConnectionToken dc,
                                           SpyDestination dest)
                                    throws Exception

  Description copied from interface: `ServerIL`
  #Description of the Method

  Specified by:
    `deleteTemporaryDestination` in interface `ServerIL`
  Parameters:
    `dc` - Description of Parameter
    `dest` - Description of Parameter
  Throws:
    `Exception` - Description of Exception

### destroySubscription

    public void destroySubscription(ConnectionToken dc,
                                    DurableSubscriptionID id)
                             throws Exception

  Description copied from interface: `ServerIL`
  Unsubscribe from a durable subscription.

  Specified by:
    `destroySubscription` in interface `ServerIL`
  Parameters:
    `id` - Description of Parameter
  Throws:
    `Exception` - Description of Exception

### getID

    public String getID()
                 throws Exception

  Description copied from interface: `ServerIL`
  Get a clientID from the server. It is up to the server side components to update the ConectionToken if this method returns normaly.

  Specified by:
    `getID` in interface `ServerIL`
  Returns:
    an internally generated clientID.
  Throws:
    `Exception` - Description of Exception

### getTemporaryQueue

    public javax.jms.TemporaryQueue getTemporaryQueue(ConnectionToken dc)
                                               throws Exception

  Description copied from interface: `ServerIL`
  Gets the TemporaryQueue attribute of the ServerIL object

  Specified by:
    `getTemporaryQueue` in interface `ServerIL`
  Parameters:
    `dc` - Description of Parameter
  Returns:
    The TemporaryQueue value
  Throws:
    `Exception` - Description of Exception

### getTemporaryTopic

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

  Description copied from interface: `ServerIL`
  Gets the TemporaryTopic attribute of the ServerIL object

  Specified by:
    `getTemporaryTopic` in interface `ServerIL`
  Parameters:
    `dc` - Description of Parameter
  Returns:
    The TemporaryTopic value
  Throws:
    `Exception` - Description of Exception

### ping

    public void ping(ConnectionToken dc,
                     long clientTime)
              throws Exception

  Description copied from interface: `ServerIL`
  Ping the server.

  Specified by:
    `ping` in interface `ServerIL`
  Parameters:
    `dc` - Description of Parameter
    `clientTime` - Description of Parameter
  Throws:
    `Exception` - Description of Exception

### receive

    public SpyMessage receive(ConnectionToken dc,
                              int subscriberId,
                              long wait)
                       throws Exception

  Description copied from interface: `ServerIL`
  Get a message synchronously.

  Specified by:
    `receive` in interface `ServerIL`
  Parameters:
    `dc` - Description of Parameter
    `subscriberId` - Description of Parameter
    `wait` - Description of Parameter
  Returns:
    Description of the Returned Value
  Throws:
    `Exception` - Description of Exception

### setConnectionToken

    public void setConnectionToken(ConnectionToken newConnectionToken)
                            throws Exception

  Specified by:
    `setConnectionToken` in interface `ServerIL`
  Parameters:
    `newConnectionToken` - org.jboss.mq.ConnectionToken
  Throws:
    `Exception` - The exception description.

### setEnabled

    public void setEnabled(ConnectionToken dc,
                           boolean enabled)
                    throws Exception

  Description copied from interface: `ServerIL`
  Sets the Enabled attribute of the ServerIL object

  Specified by:
    `setEnabled` in interface `ServerIL`
  Parameters:
    `dc` - The new Enabled value
    `enabled` - The new Enabled value
  Throws:
    `Exception` - Description of Exception

### subscribe

    public void subscribe(ConnectionToken dc,
                          Subscription s)
                   throws Exception

  Specified by:
    `subscribe` in interface `ServerIL`
  Parameters:
    `dc` - org.jboss.mq.ConnectionToken
    `s` - org.jboss.mq.Subscription
  Throws:
    `Exception` - The exception description.

### transact

    public void transact(ConnectionToken dc,
                         TransactionRequest t)
                  throws Exception

  Description copied from interface: `ServerIL`
  #Description of the Method

  Specified by:
    `transact` in interface `ServerIL`
  Parameters:
    `dc` - Description of Parameter
    `t` - Description of Parameter
  Throws:
    `Exception` - Description of Exception

### unsubscribe

    public void unsubscribe(ConnectionToken dc,
                            int subscriptionId)
                     throws Exception

  Description copied from interface: `ServerIL`
  Remove a consumer. Is NOT the same as the topic session unsubscribe.

  Specified by:
    `unsubscribe` in interface `ServerIL`
  Parameters:
    `dc` - Description of Parameter
    `subscriptionId` - Description of Parameter
  Throws:
    `Exception` - Description of Exception

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.