OILServerIL (JBoss Messaging API) - JBoss 4.0.1 sp1 messaging API Documentation 英文版文档

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.oil
Class OILServerIL

java.lang.Object
  org.jboss.mq.il.oil.OILServerIL

All Implemented Interfaces:: Cloneable, Serializable, ServerIL

public final class OILServerIL
extends Object
implements Serializable, Cloneable, ServerIL

The JVM implementation of the ServerIL object

Version:: $Revision: 1.12 $
Author:: Hiram Chirino (Cojonudo14@hotmail.com), Norbert Lataille (Norbert.Lataille@m4x.org)
See Also:: Serialized Form

Constructor Summary

OILServerIL(InetAddress addr, int port, String socketFactoryName, boolean enableTcpNoDelay)
          Constructor for the OILServerIL object

Method Summary

void acknowledge(ConnectionToken dc, AcknowledgementRequest item)
          #Description of the Method

void addMessage(ConnectionToken dc, SpyMessage val)
          Adds a feature to the Message attribute of the OILServerIL object

String authenticate(String userName, String password)
          #Description of the Method

SpyMessage[] browse(ConnectionToken dc, javax.jms.Destination dest, String selector)
          #Description of the Method

void checkID(String ID)
          #Description of the Method

String checkUser(String userName, String password)
          #Description of the Method

Object clone()
          #Description of the Method

ServerIL cloneServerIL()
          Need to clone because there are instance variables tha can get clobbered.

void connectionClosing(ConnectionToken dc)
          #Description of the Method

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)
          #Description of the Method

String getID()
          Gets the ID attribute of the OILServerIL object

javax.jms.TemporaryQueue getTemporaryQueue(ConnectionToken dc)
          Gets the TemporaryQueue attribute of the OILServerIL object

javax.jms.TemporaryTopic getTemporaryTopic(ConnectionToken dc)
          Gets the TemporaryTopic attribute of the OILServerIL object

void ping(ConnectionToken dc, long clientTime)
          #Description of the Method

SpyMessage receive(ConnectionToken dc, int subscriberId, long wait)
          #Description of the Method

void setConnectionToken(ConnectionToken dest)
          Sets the ConnectionToken attribute of the OILServerIL object

void setEnabled(ConnectionToken dc, boolean enabled)
          Sets the Enabled attribute of the OILServerIL object

void subscribe(ConnectionToken dc, Subscription s)
          #Description of the Method

void transact(ConnectionToken dc, TransactionRequest t)
          #Description of the Method

void unsubscribe(ConnectionToken dc, int subscriptionId)
          #Description of the Method

Methods inherited from class java.lang.Object

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

Constructor Detail

OILServerIL

public OILServerIL(InetAddress addr,
                   int port,
                   String socketFactoryName,
                   boolean enableTcpNoDelay)

Constructor for the OILServerIL object
Parameters:: port - Description of Parameter

Method Detail

setConnectionToken

public void setConnectionToken(ConnectionToken dest)
                        throws Exception

Sets the ConnectionToken attribute of the OILServerIL object

Specified by:: setConnectionToken in interface ServerIL

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

setEnabled

public void setEnabled(ConnectionToken dc,
                       boolean enabled)
                throws javax.jms.JMSException,
                       Exception

Sets the Enabled attribute of the OILServerIL object

Specified by:: setEnabled in interface ServerIL

Parameters:: dc - The new Enabled value; enabled - The new Enabled value
Throws:: javax.jms.JMSException - Description of Exception; Exception - Description of Exception

getID

public String getID()
             throws Exception

Gets the ID attribute of the OILServerIL object

Specified by:: getID in interface ServerIL

Returns:: The ID value
Throws:: Exception - Description of Exception

getTemporaryQueue

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

Gets the TemporaryQueue attribute of the OILServerIL object

Specified by:: getTemporaryQueue in interface ServerIL

Parameters:: dc - Description of Parameter
Returns:: The TemporaryQueue value
Throws:: javax.jms.JMSException - Description of Exception; Exception - Description of Exception

getTemporaryTopic

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

Gets the TemporaryTopic attribute of the OILServerIL object

Specified by:: getTemporaryTopic in interface ServerIL

Parameters:: dc - Description of Parameter
Returns:: The TemporaryTopic value
Throws:: javax.jms.JMSException - Description of Exception; Exception - Description of Exception

acknowledge

public void acknowledge(ConnectionToken dc,
                        AcknowledgementRequest item)
                 throws javax.jms.JMSException,
                        Exception

#Description of the Method

Specified by:: acknowledge in interface ServerIL

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

addMessage

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

Adds a feature to the Message attribute of the OILServerIL object

Specified by:: addMessage in interface ServerIL

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

browse

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

#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:: javax.jms.JMSException - Description of Exception; Exception - Description of Exception

checkID

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

#Description of the Method

Specified by:: checkID in interface ServerIL

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

checkUser

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

#Description of the Method

Specified by:: checkUser in interface ServerIL

Parameters:: userName - Description of Parameter; password - Description of Parameter
Returns:: Description of the Returned Value
Throws:: javax.jms.JMSException - Description of Exception; Exception - Description of Exception

authenticate

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

#Description of the Method

Specified by:: authenticate in interface ServerIL

Parameters:: userName - Description of Parameter; password - Description of Parameter
Returns:: Description of the Returned Value
Throws:: javax.jms.JMSException - Description of Exception; Exception - Description of Exception

clone

public Object clone()
             throws CloneNotSupportedException

#Description of the Method

Returns:: Description of the Returned Value
Throws:: CloneNotSupportedException - Description of Exception

cloneServerIL

public ServerIL cloneServerIL()
                       throws 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

Returns:: Description of the Returned Value
Throws:: Exception - Description of Exception

connectionClosing

public void connectionClosing(ConnectionToken dc)
                       throws javax.jms.JMSException,
                              Exception

#Description of the Method

Specified by:: connectionClosing in interface ServerIL

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

createQueue

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

#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:: javax.jms.JMSException - Description of Exception; Exception - Description of Exception

createTopic

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

#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:: javax.jms.JMSException - Description of Exception; Exception - Description of Exception

deleteTemporaryDestination

public void deleteTemporaryDestination(ConnectionToken dc,
                                       SpyDestination dest)
                                throws javax.jms.JMSException,
                                       Exception

#Description of the Method

Specified by:: deleteTemporaryDestination in interface ServerIL

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

destroySubscription

public void destroySubscription(ConnectionToken dc,
                                DurableSubscriptionID id)
                         throws javax.jms.JMSException,
                                Exception

#Description of the Method

Specified by:: destroySubscription in interface ServerIL

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

ping

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

#Description of the Method

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,
                          Exception

#Description of the Method

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

public void subscribe(ConnectionToken dc,
                      Subscription s)
               throws javax.jms.JMSException,
                      Exception

#Description of the Method

Specified by:: subscribe in interface ServerIL

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

transact

public void transact(ConnectionToken dc,
                     TransactionRequest t)
              throws javax.jms.JMSException,
                     Exception

#Description of the Method

Specified by:: transact in interface ServerIL

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

unsubscribe

public void unsubscribe(ConnectionToken dc,
                        int subscriptionId)
                 throws javax.jms.JMSException,
                        Exception

#Description of the Method

Specified by:: unsubscribe in interface ServerIL

Parameters:: dc - Description of Parameter; subscriptionId - Description of Parameter
Throws:: javax.jms.JMSException - Description of Exception; 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

Constructor Summary
`OILServerIL(InetAddress addr, int port, String socketFactoryName, boolean enableTcpNoDelay)` Constructor for the OILServerIL object

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

OILServerIL (JBoss Messaging API) - JBoss 4.0.1 sp1 messaging API Documentation 英文版文档

org.jboss.mq.il.oil Class OILServerIL

OILServerIL

setConnectionToken

setEnabled

getID

getTemporaryQueue

getTemporaryTopic

acknowledge

addMessage

browse

checkID

checkUser

authenticate

clone

cloneServerIL

connectionClosing

createQueue

createTopic

deleteTemporaryDestination

destroySubscription

ping

receive

subscribe

transact

unsubscribe

org.jboss.mq.il.oil
Class OILServerIL