org.jboss.mq.il.uil2
Class UILServerIL

java.lang.Object
  extended byorg.jboss.mq.il.uil2.UILServerIL
All Implemented Interfaces:
java.lang.Cloneable, MsgTypes (src) , java.io.Serializable, ServerIL (src)

public class UILServerIL
extends java.lang.Object
implements java.lang.Cloneable, MsgTypes (src) , java.io.Serializable, ServerIL (src)

The UILServerIL is created on the server and copied to the client during connection factory lookups. It represents the transport interface to the JMS server.

See Also:
Serialized Form

Field Summary
protected  java.net.Socket socket
          Description of the Field
protected  SocketManager (src) socketMgr
          Description of the Field
 
Fields inherited from interface org.jboss.mq.il.uil2.msgs.MsgTypes (src)
m_acknowledge, m_addMessage, m_authenticate, m_browse, m_checkID, m_checkUser, m_close, m_connectionClosing, m_createQueue, m_createTopic, m_deleteTemporaryDestination, m_destroySubscription, m_getID, m_getTemporaryQueue, m_getTemporaryTopic, m_ping, m_pong, m_receive, m_receiveRequest, m_setEnabled, m_setSpyDistributedConnection, m_subscribe, m_transact, m_unsubscribe
 
Constructor Summary
UILServerIL(java.net.InetAddress addr, int port, java.lang.String socketFactoryName, boolean enableTcpNoDelay, int bufferSize, int chunkSize)
           
 
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 UILServerIL object
 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
protected  void checkConnection()
          #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 connectionClosing(ConnectionToken (src)  dc)
          #Description of the Method
protected  void createConnection()
          Used to establish a new connection to the server
 Queue (src) createQueue(ConnectionToken (src)  dc, java.lang.String destName)
          #Description of the Method
 Topic (src) createTopic(ConnectionToken (src)  dc, java.lang.String destName)
          #Description of the Method
 void deleteTemporaryDestination(ConnectionToken (src)  dc, SpyDestination (src)  dest)
          #Description of the Method
protected  void destroyConnection()
          Used to close the current connection with the server
 void destroySubscription(ConnectionToken (src)  dc, DurableSubscriptionID (src)  id)
          #Description of the Method
 java.lang.String getID()
          Gets the ID attribute of the UILServerIL object
 TemporaryQueue (src) getTemporaryQueue(ConnectionToken (src)  dc)
          Gets the TemporaryQueue attribute of the UILServerIL object
 TemporaryTopic (src) getTemporaryTopic(ConnectionToken (src)  dc)
          Gets the TemporaryTopic attribute of the UILServerIL 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 UILServerIL object
 void setEnabled(ConnectionToken (src)  dc, boolean enabled)
          Sets the Enabled attribute of the UILServerIL 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

socket

protected transient java.net.Socket socket
Description of the Field


socketMgr

protected transient SocketManager (src)  socketMgr
Description of the Field

Constructor Detail

UILServerIL

public UILServerIL(java.net.InetAddress addr,
                   int port,
                   java.lang.String socketFactoryName,
                   boolean enableTcpNoDelay,
                   int bufferSize,
                   int chunkSize)
            throws java.lang.Exception
Parameters:
addr -
port -
socketFactoryName -
enableTcpNoDelay -
bufferSize -
chunkSize -
Throws:
java.lang.Exception
Method Detail

setConnectionToken

public void setConnectionToken(ConnectionToken (src)  dest)
                        throws java.lang.Exception
Sets the ConnectionToken attribute of the UILServerIL 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 UILServerIL 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 UILServerIL 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 UILServerIL 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 UILServerIL 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 UILServerIL 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
Authenticate the user

Specified by:
authenticate in interface ServerIL (src)
Parameters:
username - Description of Parameter
password - Description of Parameter
Returns:
a sessionID
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 destName)
                  throws JMSException (src) ,
                         java.lang.Exception
#Description of the Method

Specified by:
createQueue in interface ServerIL (src)
Parameters:
dc - - the destination connection token
destName - - the name of the destination
Returns:
Throws:
JMSException (src) - Description of Exception
java.lang.Exception - Description of Exception

createTopic

public Topic (src)  createTopic(ConnectionToken (src)  dc,
                         java.lang.String destName)
                  throws JMSException (src) ,
                         java.lang.Exception
#Description of the Method

Specified by:
createTopic in interface ServerIL (src)
Parameters:
dc - - the destination connection token
destName - - the name of the destination
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

subscribe

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 - - the destination connection token
subscriptionID - Description of Parameter
Throws:
JMSException (src) - Description of Exception
java.lang.Exception - Description of Exception

checkConnection

protected void checkConnection()
                        throws java.lang.Exception
#Description of the Method

Throws:
java.lang.Exception - Description of Exception

createConnection

protected void createConnection()
                         throws java.lang.Exception
Used to establish a new connection to the server

Throws:
java.lang.Exception - Description of Exception

destroyConnection

protected void destroyConnection()
Used to close the current connection with the server