ServerIL

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS (src) NEXT CLASS (src)

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.jboss.mq.il
Interface ServerIL

All Known Subinterfaces:: RMIServerILRemote (src)

All Known Implementing Classes:: HTTPServerIL (src) , JVMServerIL (src) , OIL2ServerIL (src) , OILServerIL (src) , RMIServerIL (src) , UILServerIL (src)

public interface ServerIL

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

Method Summary
`void`	`acknowledge(ConnectionToken (src) dc, AcknowledgementRequest (src) item)` #Description of the Method
`void`	`addMessage(ConnectionToken (src) dc, SpyMessage (src) message)` Adds a message to the destination specifyed in the message.
`java.lang.String`	`authenticate(java.lang.String userName, java.lang.String password)` Authenticate the user.
`SpyMessage (src) []`	`browse(ConnectionToken (src) dc, Destination (src) dest, java.lang.String selector)` #Description of the Method
`void`	`checkID(java.lang.String ID)` Check if clientID is a valid ID.
`java.lang.String`	`checkUser(java.lang.String userName, java.lang.String password)` Get a clientID for a given user/password.
`ServerIL (src)`	`cloneServerIL()` #Description of the Method
`void`	`connectionClosing(ConnectionToken (src) dc)` The client is closing the connection.
`Queue (src)`	`createQueue(ConnectionToken (src) dc, java.lang.String dest)` #Description of the Method
`Topic (src)`	`createTopic(ConnectionToken (src) dc, java.lang.String dest)` #Description of the Method
`void`	`deleteTemporaryDestination(ConnectionToken (src) dc, SpyDestination (src) dest)` #Description of the Method
`void`	`destroySubscription(ConnectionToken (src) dc, DurableSubscriptionID (src) id)` Unsubscribe from a durable subscription.
`java.lang.String`	`getID()` Get a clientID from the server.
`TemporaryQueue (src)`	`getTemporaryQueue(ConnectionToken (src) dc)` Gets the TemporaryQueue attribute of the ServerIL object
`TemporaryTopic (src)`	`getTemporaryTopic(ConnectionToken (src) dc)` Gets the TemporaryTopic attribute of the ServerIL object
`void`	`ping(ConnectionToken (src) dc, long clientTime)` Ping the server.
`SpyMessage (src)`	`receive(ConnectionToken (src) dc, int subscriberId, long wait)` Get a message synchronously.
`void`	`setConnectionToken(ConnectionToken (src) newConnectionToken)`
`void`	`setEnabled(ConnectionToken (src) dc, boolean enabled)` Sets the Enabled attribute of the ServerIL object
`void`	`subscribe(ConnectionToken (src) dc, Subscription (src) s)`
`void`	`transact(ConnectionToken (src) dc, TransactionRequest (src) t)` #Description of the Method
`void`	`unsubscribe(ConnectionToken (src) dc, int subscriptionId)` Remove a consumer.

Method Detail

cloneServerIL

public ServerIL (src)  cloneServerIL()
                       throws java.lang.Exception

#Description of the Method

Returns:: Description of the Returned Value
Throws:: java.lang.Exception - Description of Exception

setConnectionToken

public void setConnectionToken(ConnectionToken (src)  newConnectionToken)
                        throws java.lang.Exception

Parameters:: newConnectionToken - org.jboss.mq.ConnectionToken
Throws:: java.lang.Exception - The exception description.

getID

public java.lang.String getID()
                       throws java.lang.Exception

Get a clientID from the server. It is up to the server side components to update the ConectionToken if this method returns normaly.

Returns:: an internally generated clientID.
Throws:: java.lang.Exception - Description of Exception

getTemporaryTopic

public TemporaryTopic (src)  getTemporaryTopic(ConnectionToken (src)  dc)
                                 throws java.lang.Exception

Gets the TemporaryTopic attribute of the ServerIL object

Parameters:: dc - Description of Parameter
Returns:: The TemporaryTopic value
Throws:: java.lang.Exception - Description of Exception

getTemporaryQueue

public TemporaryQueue (src)  getTemporaryQueue(ConnectionToken (src)  dc)
                                 throws java.lang.Exception

Gets the TemporaryQueue attribute of the ServerIL object

Parameters:: dc - Description of Parameter
Returns:: The TemporaryQueue value
Throws:: java.lang.Exception - Description of Exception

connectionClosing

public void connectionClosing(ConnectionToken (src)  dc)
                       throws java.lang.Exception

The client is closing the connection.

Parameters:: dc - Description of Parameter
Throws:: java.lang.Exception - Description of Exception

checkID

public void checkID(java.lang.String ID)
             throws java.lang.Exception

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.

Parameters:: ID - a clientID set by the client.
Throws:: java.lang.Exception - if the clientID was not vallid.

addMessage

public void addMessage(ConnectionToken (src)  dc,
                       SpyMessage (src)  message)
                throws java.lang.Exception

Adds a message to the destination specifyed in the message.

Parameters:: dc - The feature to be added to the Message attribute; message - The feature to be added to the Message attribute
Throws:: java.lang.Exception - Description of Exception

createQueue

public Queue (src)  createQueue(ConnectionToken (src)  dc,
                         java.lang.String dest)
                  throws java.lang.Exception

#Description of the Method

Parameters:: dc - Description of Parameter; dest - Description of Parameter
Returns:: Description of the Returned Value
Throws:: java.lang.Exception - Description of Exception

createTopic

public Topic (src)  createTopic(ConnectionToken (src)  dc,
                         java.lang.String dest)
                  throws java.lang.Exception

#Description of the Method

Parameters:: dc - Description of Parameter; dest - Description of Parameter
Returns:: Description of the Returned Value
Throws:: java.lang.Exception - Description of Exception

deleteTemporaryDestination

public void deleteTemporaryDestination(ConnectionToken (src)  dc,
                                       SpyDestination (src)  dest)
                                throws java.lang.Exception

#Description of the Method

Parameters:: dc - Description of Parameter; dest - Description of Parameter
Throws:: java.lang.Exception - Description of Exception

transact

public void transact(ConnectionToken (src)  dc,
                     TransactionRequest (src)  t)
              throws java.lang.Exception

#Description of the Method

Parameters:: dc - Description of Parameter; t - Description of Parameter
Throws:: java.lang.Exception - Description of Exception

acknowledge

public void acknowledge(ConnectionToken (src)  dc,
                        AcknowledgementRequest (src)  item)
                 throws java.lang.Exception

#Description of the Method

Parameters:: dc - Description of Parameter; item - Description of Parameter
Throws:: java.lang.Exception - Description of Exception

browse

public SpyMessage (src) [] browse(ConnectionToken (src)  dc,
                           Destination (src)  dest,
                           java.lang.String selector)
                    throws java.lang.Exception

#Description of the Method

Parameters:: dc - Description of Parameter; dest - Description of Parameter; selector - Description of Parameter
Returns:: Description of the Returned Value
Throws:: java.lang.Exception - Description of Exception

receive

public SpyMessage (src)  receive(ConnectionToken (src)  dc,
                          int subscriberId,
                          long wait)
                   throws java.lang.Exception

Get a message synchronously.

Parameters:: dc - Description of Parameter; subscriberId - Description of Parameter; wait - Description of Parameter
Returns:: Description of the Returned Value
Throws:: java.lang.Exception - Description of Exception

setEnabled

public void setEnabled(ConnectionToken (src)  dc,
                       boolean enabled)
                throws java.lang.Exception

Sets the Enabled attribute of the ServerIL object

Parameters:: dc - The new Enabled value; enabled - The new Enabled value
Throws:: java.lang.Exception - Description of Exception

unsubscribe

public void unsubscribe(ConnectionToken (src)  dc,
                        int subscriptionId)
                 throws java.lang.Exception

Remove a consumer. Is NOT the same as the topic session unsubscribe.

Parameters:: dc - Description of Parameter; subscriptionId - Description of Parameter
Throws:: java.lang.Exception - Description of Exception

destroySubscription

public void destroySubscription(ConnectionToken (src)  dc,
                                DurableSubscriptionID (src)  id)
                         throws java.lang.Exception

Unsubscribe from a durable subscription.

Parameters:: id - Description of Parameter
Throws:: java.lang.Exception - Description of Exception

checkUser

public java.lang.String checkUser(java.lang.String userName,
                                  java.lang.String password)
                           throws java.lang.Exception

Get a clientID for a given user/password. May also be used for autentication if StateManager is used as authenticator.

Parameters:: userName - a valid user name that the StateManager knows about.; password - a password
Returns:: a preconfigured clientID or null.
Throws:: java.lang.Exception - Description of Exception

authenticate

public java.lang.String authenticate(java.lang.String userName,
                                     java.lang.String password)
                              throws java.lang.Exception

Authenticate the user. If using a securityManager the user will be autenticated by that.

Parameters:: userName - a username.; password - a password.
Returns:: a sessionid, valid only for the life of this connection.
Throws:: java.lang.Exception - Description of Exception

public void subscribe(ConnectionToken (src)  dc,
                      Subscription (src)  s)
               throws java.lang.Exception

Parameters:: dc - org.jboss.mq.ConnectionToken; s - org.jboss.mq.Subscription
Throws:: java.lang.Exception - The exception description.

ping

public void ping(ConnectionToken (src)  dc,
                 long clientTime)
          throws java.lang.Exception

Ping the server.

Parameters:: dc - Description of Parameter; clientTime - Description of Parameter
Throws:: java.lang.Exception - Description of Exception