OIL2ServerIL

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.oil2
Class OIL2ServerIL

java.lang.Object
  org.jboss.mq.il.oil2.OIL2ServerIL

All Implemented Interfaces:: java.lang.Cloneable, org.jboss.mq.il.oil2.OIL2Constants, java.io.Serializable, ServerIL (src)

public final class OIL2ServerIL
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable, ServerIL (src) , org.jboss.mq.il.oil2.OIL2Constants

The JVM implementation of the ServerIL object

See Also:: Serialized Form

Field Summary
`static byte`	`CLIENT_CLOSE`
`static byte`	`CLIENT_DELETE_TEMPORARY_DESTINATION`
`static byte`	`CLIENT_PONG`
`static byte`	`CLIENT_RECEIVE`
`static byte`	`RESULT_EXCEPTION`
`static byte`	`RESULT_OBJECT`
`static byte`	`RESULT_VOID`
`static byte`	`SERVER_ACKNOWLEDGE`
`static byte`	`SERVER_ADD_MESSAGE`
`static byte`	`SERVER_AUTHENTICATE`
`static byte`	`SERVER_BROWSE`
`static byte`	`SERVER_CHECK_ID`
`static byte`	`SERVER_CHECK_USER`
`static byte`	`SERVER_CLOSE`
`static byte`	`SERVER_CONNECTION_CLOSING`
`static byte`	`SERVER_CREATE_QUEUE`
`static byte`	`SERVER_CREATE_TOPIC`
`static byte`	`SERVER_DELETE_TEMPORARY_DESTINATION`
`static byte`	`SERVER_DESTROY_SUBSCRIPTION`
`static byte`	`SERVER_GET_ID`
`static byte`	`SERVER_GET_TEMPORARY_QUEUE`
`static byte`	`SERVER_GET_TEMPORARY_TOPIC`
`static byte`	`SERVER_PING`
`static byte`	`SERVER_RECEIVE`
`static byte`	`SERVER_SET_ENABLED`
`static byte`	`SERVER_SET_SPY_DISTRIBUTED_CONNECTION`
`static byte`	`SERVER_SUBSCRIBE`
`static byte`	`SERVER_TRANSACT`
`static byte`	`SERVER_UNSUBSCRIBE`

Constructor Summary
`OIL2ServerIL(java.lang.String addr, int port, java.lang.String socketFactoryName, boolean enableTcpNoDelay)` Constructor for the OILServerIL object

Method Summary
`void`	`acknowledge(ConnectionToken (src) dc, AcknowledgementRequest (src) item)` #Description of the Method
`void`	`addMessage(ConnectionToken (src) dc, SpyMessage (src) val)` Adds a feature to the Message attribute of the OILServerIL object
`java.lang.String`	`authenticate(java.lang.String userName, java.lang.String password)` #Description of the Method
`SpyMessage (src) []`	`browse(ConnectionToken (src) dc, Destination (src) dest, java.lang.String selector)` #Description of the Method
`void`	`checkID(java.lang.String ID)` #Description of the Method
`java.lang.String`	`checkUser(java.lang.String userName, java.lang.String password)` #Description of the Method
`java.lang.Object`	`clone()` #Description of the Method
`ServerIL (src)`	`cloneServerIL()` Need to clone because there are instance variables tha can get clobbered.
`void`	`close()` Used to close the current connection with the server
`void`	`connect()`
`void`	`connectionClosing(ConnectionToken (src) dc)` #Description of the Method
`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)` #Description of the Method
`java.lang.String`	`getID()` Gets the ID attribute of the OILServerIL object
`TemporaryQueue (src)`	`getTemporaryQueue(ConnectionToken (src) dc)` Gets the TemporaryQueue attribute of the OILServerIL object
`TemporaryTopic (src)`	`getTemporaryTopic(ConnectionToken (src) dc)` Gets the TemporaryTopic attribute of the OILServerIL object
`void`	`ping(ConnectionToken (src) dc, long clientTime)` #Description of the Method
`SpyMessage (src)`	`receive(ConnectionToken (src) dc, int subscriberId, long wait)` #Description of the Method
`void`	`setConnectionToken(ConnectionToken (src) dest)` Sets the ConnectionToken attribute of the OILServerIL object
`void`	`setEnabled(ConnectionToken (src) dc, boolean enabled)` Sets the Enabled attribute of the OILServerIL object
`void`	`subscribe(ConnectionToken (src) dc, Subscription (src) s)` #Description of the Method
`void`	`transact(ConnectionToken (src) dc, TransactionRequest (src) t)` #Description of the Method
`void`	`unsubscribe(ConnectionToken (src) dc, int subscriptionId)` #Description of the Method

Methods inherited from class java.lang.Object

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

Field Detail

RESULT_VOID

public static final byte RESULT_VOID

See Also:: Constant Field Values (src)

RESULT_OBJECT

public static final byte RESULT_OBJECT

See Also:: Constant Field Values (src)

RESULT_EXCEPTION

public static final byte RESULT_EXCEPTION

See Also:: Constant Field Values (src)

CLIENT_RECEIVE

public static final byte CLIENT_RECEIVE

See Also:: Constant Field Values (src)

CLIENT_DELETE_TEMPORARY_DESTINATION

public static final byte CLIENT_DELETE_TEMPORARY_DESTINATION

See Also:: Constant Field Values (src)

CLIENT_CLOSE

public static final byte CLIENT_CLOSE

See Also:: Constant Field Values (src)

CLIENT_PONG

public static final byte CLIENT_PONG

See Also:: Constant Field Values (src)

SERVER_ACKNOWLEDGE

public static final byte SERVER_ACKNOWLEDGE

See Also:: Constant Field Values (src)

SERVER_ADD_MESSAGE

public static final byte SERVER_ADD_MESSAGE

See Also:: Constant Field Values (src)

SERVER_BROWSE

public static final byte SERVER_BROWSE

See Also:: Constant Field Values (src)

SERVER_CHECK_ID

public static final byte SERVER_CHECK_ID

See Also:: Constant Field Values (src)

SERVER_CONNECTION_CLOSING

public static final byte SERVER_CONNECTION_CLOSING

See Also:: Constant Field Values (src)

SERVER_CREATE_QUEUE

public static final byte SERVER_CREATE_QUEUE

See Also:: Constant Field Values (src)

SERVER_CREATE_TOPIC

public static final byte SERVER_CREATE_TOPIC

See Also:: Constant Field Values (src)

SERVER_DELETE_TEMPORARY_DESTINATION

public static final byte SERVER_DELETE_TEMPORARY_DESTINATION

See Also:: Constant Field Values (src)

SERVER_GET_ID

public static final byte SERVER_GET_ID

See Also:: Constant Field Values (src)

SERVER_GET_TEMPORARY_QUEUE

public static final byte SERVER_GET_TEMPORARY_QUEUE

See Also:: Constant Field Values (src)

SERVER_GET_TEMPORARY_TOPIC

public static final byte SERVER_GET_TEMPORARY_TOPIC

See Also:: Constant Field Values (src)

SERVER_RECEIVE

public static final byte SERVER_RECEIVE

See Also:: Constant Field Values (src)

SERVER_SET_ENABLED

public static final byte SERVER_SET_ENABLED

See Also:: Constant Field Values (src)

SERVER_SET_SPY_DISTRIBUTED_CONNECTION

public static final byte SERVER_SET_SPY_DISTRIBUTED_CONNECTION

See Also:: Constant Field Values (src)

SERVER_SUBSCRIBE

public static final byte SERVER_SUBSCRIBE

See Also:: Constant Field Values (src)

SERVER_TRANSACT

public static final byte SERVER_TRANSACT

See Also:: Constant Field Values (src)

SERVER_UNSUBSCRIBE

public static final byte SERVER_UNSUBSCRIBE

See Also:: Constant Field Values (src)

SERVER_DESTROY_SUBSCRIPTION

public static final byte SERVER_DESTROY_SUBSCRIPTION

See Also:: Constant Field Values (src)

SERVER_CHECK_USER

public static final byte SERVER_CHECK_USER

See Also:: Constant Field Values (src)

SERVER_PING

public static final byte SERVER_PING

See Also:: Constant Field Values (src)

SERVER_CLOSE

public static final byte SERVER_CLOSE

See Also:: Constant Field Values (src)

SERVER_AUTHENTICATE

public static final byte SERVER_AUTHENTICATE

See Also:: Constant Field Values (src)

Constructor Detail

OIL2ServerIL

public OIL2ServerIL(java.lang.String addr,
                    int port,
                    java.lang.String socketFactoryName,
                    boolean enableTcpNoDelay)

Constructor for the OILServerIL object

Method Detail

connect

public void connect()
             throws java.io.IOException

Throws:: java.io.IOException

setConnectionToken

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

Sets the ConnectionToken attribute of the OILServerIL object

Specified by:: setConnectionToken in interface ServerIL (src)

Parameters:: dest - The new ConnectionToken value
Throws:: java.lang.Exception - Description of Exception

setEnabled

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

Sets the Enabled attribute of the OILServerIL object

Specified by:: setEnabled in interface ServerIL (src)

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

getID

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

Gets the ID attribute of the OILServerIL object

Specified by:: getID in interface ServerIL (src)

Returns:: The ID value
Throws:: java.lang.Exception - Description of Exception

getTemporaryQueue

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

Gets the TemporaryQueue attribute of the OILServerIL object

Specified by:: getTemporaryQueue in interface ServerIL (src)

Parameters:: dc - Description of Parameter
Returns:: The TemporaryQueue value
Throws:: JMSException (src) - Description of Exception; java.lang.Exception - Description of Exception

getTemporaryTopic

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

Gets the TemporaryTopic attribute of the OILServerIL object

Specified by:: getTemporaryTopic in interface ServerIL (src)

Parameters:: dc - Description of Parameter
Returns:: The TemporaryTopic value
Throws:: JMSException (src) - Description of Exception; java.lang.Exception - Description of Exception

acknowledge

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

#Description of the Method

Specified by:: acknowledge in interface ServerIL (src)

Parameters:: dc - Description of Parameter; item - Description of Parameter
Throws:: JMSException (src) - Description of Exception; java.lang.Exception - Description of Exception

addMessage

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

Adds a feature to the Message attribute of the OILServerIL object

Specified by:: addMessage in interface ServerIL (src)

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

browse

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

#Description of the Method

Specified by:: browse in interface ServerIL (src)

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

checkID

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

#Description of the Method

Specified by:: checkID in interface ServerIL (src)

Parameters:: ID - Description of Parameter
Throws:: JMSException (src) - Description of Exception; java.lang.Exception - Description of Exception

checkUser

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

#Description of the Method

Specified by:: checkUser in interface ServerIL (src)

Parameters:: userName - Description of Parameter; password - Description of Parameter
Returns:: Description of the Returned Value
Throws:: JMSException (src) - Description of Exception; java.lang.Exception - Description of Exception

authenticate

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

#Description of the Method

Specified by:: authenticate in interface ServerIL (src)

Parameters:: userName - Description of Parameter; password - Description of Parameter
Returns:: Description of the Returned Value
Throws:: JMSException (src) - Description of Exception; java.lang.Exception - Description of Exception

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

#Description of the Method

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

cloneServerIL

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

Need to clone because there are instance variables tha can get clobbered. All Multiple connections can NOT share the same JVMServerIL object

Specified by:: cloneServerIL in interface ServerIL (src)

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

connectionClosing

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

#Description of the Method

Specified by:: connectionClosing in interface ServerIL (src)

Parameters:: dc - Description of Parameter
Throws:: JMSException (src) - Description of Exception; java.lang.Exception - Description of Exception

createQueue

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

#Description of the Method

Specified by:: createQueue in interface ServerIL (src)

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

createTopic

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

#Description of the Method

Specified by:: createTopic in interface ServerIL (src)

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

deleteTemporaryDestination

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

#Description of the Method

Specified by:: deleteTemporaryDestination in interface ServerIL (src)

Parameters:: dc - Description of Parameter; dest - Description of Parameter
Throws:: JMSException (src) - Description of Exception; java.lang.Exception - Description of Exception

destroySubscription

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

#Description of the Method

Specified by:: destroySubscription in interface ServerIL (src)

Parameters:: id - Description of Parameter
Throws:: JMSException (src) - Description of Exception; java.lang.Exception - Description of Exception

ping

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

#Description of the Method

Specified by:: ping in interface ServerIL (src)

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

receive

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

#Description of the Method

Specified by:: receive in interface ServerIL (src)

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

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

#Description of the Method

Specified by:: subscribe in interface ServerIL (src)

Parameters:: dc - Description of Parameter; s - Description of Parameter
Throws:: JMSException (src) - Description of Exception; java.lang.Exception - Description of Exception

transact

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

#Description of the Method

Specified by:: transact in interface ServerIL (src)

Parameters:: dc - Description of Parameter; t - Description of Parameter
Throws:: JMSException (src) - Description of Exception; java.lang.Exception - Description of Exception

unsubscribe

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

#Description of the Method

Specified by:: unsubscribe in interface ServerIL (src)

Parameters:: dc - Description of Parameter; subscriptionId - Description of Parameter
Throws:: JMSException (src) - Description of Exception; java.lang.Exception - Description of Exception