com.oneandone.ejbcdiunit.jms

Class MockConnectionExt

java.lang.Object

com.oneandone.ejbcdiunit.jms.MockConnectionExt

All Implemented Interfaces:

AutoCloseable, javax.jms.Connection

public class MockConnectionExt
extends Object
implements javax.jms.Connection

used to support new interface version of jms

Author:

aschoerk

Method Summary

Modifier and Type	Method and Description
void	callExceptionListener() Calls the ExceptionListener if an exception is set setJMSException(javax.jms.JMSException).
void	callExceptionListener(javax.jms.JMSException exception) Calls the ExceptionListener using the specified exception.
void	close()
javax.jms.ConnectionConsumer	createConnectionConsumer(javax.jms.Destination destination, String s, javax.jms.ServerSessionPool serverSessionPool, int i)
javax.jms.ConnectionConsumer	createDurableConnectionConsumer(javax.jms.Topic topic, String s, String s1, javax.jms.ServerSessionPool serverSessionPool, int i)
javax.jms.Session	createSession() Creates a Session object, specifying no arguments.
javax.jms.Session	createSession(boolean b, int i)
javax.jms.Session	createSession(int i) Creates a Session object, specifying sessionMode.
javax.jms.ConnectionConsumer	createSharedConnectionConsumer(javax.jms.Topic topic, String s, String s1, javax.jms.ServerSessionPool serverSessionPool, int i) Creates a connection consumer for this connection (optional operation) on the specific topic using a shared non-durable subscription with the specified name.
javax.jms.ConnectionConsumer	createSharedDurableConnectionConsumer(javax.jms.Topic topic, String s, String s1, javax.jms.ServerSessionPool serverSessionPool, int i) Creates a connection consumer for this connection (optional operation) on the specific topic using a shared durable subscription with the specified name.
String	getClientID()
com.mockrunner.jms.ConfigurationManager	getConfigurationManager() Returns the ConfigurationManager.
com.mockrunner.jms.DestinationManager	getDestinationManager() Returns the DestinationManager.
javax.jms.ExceptionListener	getExceptionListener()
javax.jms.ConnectionMetaData	getMetaData()
String	getPassword() Returns the password.
com.mockrunner.mock.jms.MockSession	getSession(int index) Returns a MockSession.
List	getSessionList() Returns the list of MockSession objects.
String	getUserName() Returns the user name.
boolean	isClosed()
boolean	isStarted()
boolean	isStopped()
void	setClientID(String s)
void	setExceptionListener(javax.jms.ExceptionListener exceptionListener)
void	setMetaData(javax.jms.ConnectionMetaData metaData) You can use this to set the ConnectionMetaData.
void	start()
void	stop()
void	throwJMSException() Throws a JMSException if one is set with setJMSException(javax.jms.JMSException).

Methods inherited from class java.lang.Object

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

Method Detail

getUserName

public String getUserName()

Returns the user name.

Returns:

the user name

getPassword

public String getPassword()

Returns the password.

Returns:

the password

getDestinationManager

public com.mockrunner.jms.DestinationManager getDestinationManager()

Returns the DestinationManager.

Returns:

the DestinationManager

getConfigurationManager

public com.mockrunner.jms.ConfigurationManager getConfigurationManager()

Returns the ConfigurationManager.

Returns:

the ConfigurationManager

getSessionList

public List getSessionList()

Returns the list of MockSession objects.

Returns:

the list

getSession

public com.mockrunner.mock.jms.MockSession getSession(int index)

Returns a MockSession. If there's no such MockSession, null is returned.

Parameters:

index - the index of the session object

Returns:

the session object

throwJMSException

public void throwJMSException()
                       throws javax.jms.JMSException

Throws a JMSException if one is set with setJMSException(javax.jms.JMSException). Deletes the exception.

Throws:

javax.jms.JMSException - thrown of JMSException has been set.

callExceptionListener

public void callExceptionListener()

Calls the ExceptionListener if an exception is set setJMSException(javax.jms.JMSException). Deletes the exception after calling the ExceptionListener.

callExceptionListener

public void callExceptionListener(javax.jms.JMSException exception)

Calls the ExceptionListener using the specified exception.

Parameters:

exception - the exception

setMetaData

public void setMetaData(javax.jms.ConnectionMetaData metaData)

You can use this to set the ConnectionMetaData. Usually this should not be necessary. Per default an instance of MockConnectionMetaData is returned when calling getMetaData().

Parameters:

metaData - the meta data

createSession

public javax.jms.Session createSession(boolean b,
                                       int i)
                                throws javax.jms.JMSException

Specified by:

createSession in interface javax.jms.Connection

Throws:

javax.jms.JMSException

createConnectionConsumer

public javax.jms.ConnectionConsumer createConnectionConsumer(javax.jms.Destination destination,
                                                             String s,
                                                             javax.jms.ServerSessionPool serverSessionPool,
                                                             int i)
                                                      throws javax.jms.JMSException

Specified by:

createConnectionConsumer in interface javax.jms.Connection

Throws:

javax.jms.JMSException

createDurableConnectionConsumer

public javax.jms.ConnectionConsumer createDurableConnectionConsumer(javax.jms.Topic topic,
                                                                    String s,
                                                                    String s1,
                                                                    javax.jms.ServerSessionPool serverSessionPool,
                                                                    int i)
                                                             throws javax.jms.JMSException

Specified by:

createDurableConnectionConsumer in interface javax.jms.Connection

Throws:

javax.jms.JMSException

getMetaData

public javax.jms.ConnectionMetaData getMetaData()
                                         throws javax.jms.JMSException

Specified by:

getMetaData in interface javax.jms.Connection

Throws:

javax.jms.JMSException

getClientID

public String getClientID()
                   throws javax.jms.JMSException

Specified by:

getClientID in interface javax.jms.Connection

Throws:

javax.jms.JMSException

setClientID

public void setClientID(String s)
                 throws javax.jms.JMSException

Specified by:

setClientID in interface javax.jms.Connection

Throws:

javax.jms.JMSException

getExceptionListener

public javax.jms.ExceptionListener getExceptionListener()
                                                 throws javax.jms.JMSException

Specified by:

getExceptionListener in interface javax.jms.Connection

Throws:

javax.jms.JMSException

setExceptionListener

public void setExceptionListener(javax.jms.ExceptionListener exceptionListener)
                          throws javax.jms.JMSException

Specified by:

setExceptionListener in interface javax.jms.Connection

Throws:

javax.jms.JMSException

start

public void start()
           throws javax.jms.JMSException

Specified by:

start in interface javax.jms.Connection

Throws:

javax.jms.JMSException

stop

public void stop()
          throws javax.jms.JMSException

Specified by:

stop in interface javax.jms.Connection

Throws:

javax.jms.JMSException

close

public void close()
           throws javax.jms.JMSException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface javax.jms.Connection

Throws:

javax.jms.JMSException

isStarted

public boolean isStarted()

isStopped

public boolean isStopped()

isClosed

public boolean isClosed()

createSession

public javax.jms.Session createSession(int i)
                                throws javax.jms.JMSException

Creates a Session object, specifying sessionMode.

The effect of setting the sessionMode argument depends on whether this method is called in a Java SE environment, in the Java EE application client container, or in the Java EE web or EJB container. If this method is called in the Java EE web or EJB container then the effect of setting the sessionMode argument also depends on whether or not there is an active JTA transaction in progress.

In a Java SE environment or in the Java EE application client container:

• If sessionMode is set to Session.SESSION_TRANSACTED then the session will use a local transaction which may subsequently be committed or rolled back by calling the session's commit or rollback methods.
• If sessionMode is set to any of Session.CLIENT_ACKNOWLEDGE, Session.AUTO_ACKNOWLEDGE or Session.DUPS_OK_ACKNOWLEDGE. then the session will be non-transacted and messages received by this session will be acknowledged according to the value of sessionMode. For a definition of the meaning of these acknowledgement modes see the links below.

In a Java EE web or EJB container, when there is an active JTA transaction in progress:

• The argument sessionMode is ignored. The session will participate in the JTA transaction and will be committed or rolled back when that transaction is committed or rolled back, not by calling the session's commit or rollback methods. Since the argument is ignored, developers are recommended to use createSession(), which has no arguments, instead of this method.

In the Java EE web or EJB container, when there is no active JTA transaction in progress:

• The argument acknowledgeMode must be set to either of Session.AUTO_ACKNOWLEDGE or Session.DUPS_OK_ACKNOWLEDGE. The session will be non-transacted and messages received by this session will be acknowledged automatically according to the value of acknowledgeMode. For a definition of the meaning of these acknowledgement modes see the links below. The values Session.SESSION_TRANSACTED and Session.CLIENT_ACKNOWLEDGE may not be used.

Applications running in the Java EE web and EJB containers must not attempt to create more than one active (not closed) Session object per connection. If this method is called in a Java EE web or EJB container when an active Session object already exists for this connection then a JMSException will be thrown.

Specified by:

createSession in interface javax.jms.Connection

Parameters:

i - indicates which of four possible session modes will be used.

• If this method is called in a Java SE environment or in the Java EE application client container, the permitted values are Session.SESSION_TRANSACTED, Session.CLIENT_ACKNOWLEDGE, Session.AUTO_ACKNOWLEDGE and Session.DUPS_OK_ACKNOWLEDGE.
• If this method is called in the Java EE web or EJB container when there is an active JTA transaction in progress then this argument is ignored.
• If this method is called in the Java EE web or EJB container when there is no active JTA transaction in progress, the permitted values are Session.AUTO_ACKNOWLEDGE and Session.DUPS_OK_ACKNOWLEDGE. In this case the values Session.TRANSACTED and Session.CLIENT_ACKNOWLEDGE are not permitted.

Returns:

a newly created session

Throws:

javax.jms.JMSException - if the Connection object fails to create a session due to

• some internal error,
• lack of support for the specific transaction and acknowledgement mode, or
• because this method is being called in a Java EE web or EJB application and an active session already exists for this connection.

Since:

JMS 2.0

See Also:

Session.SESSION_TRANSACTED, Session.AUTO_ACKNOWLEDGE, Session.CLIENT_ACKNOWLEDGE, Session.DUPS_OK_ACKNOWLEDGE, Connection.createSession(boolean, int), Connection.createSession()

createSession

public javax.jms.Session createSession()
                                throws javax.jms.JMSException

Creates a Session object, specifying no arguments.

The behaviour of the session that is created depends on whether this method is called in a Java SE environment, in the Java EE application client container, or in the Java EE web or EJB container. If this method is called in the Java EE web or EJB container then the behaviour of the session also depends on whether or not there is an active JTA transaction in progress.

In a Java SE environment or in the Java EE application client container:

• The session will be non-transacted and received messages will be acknowledged automatically using an acknowledgement mode of Session.AUTO_ACKNOWLEDGE For a definition of the meaning of this acknowledgement mode see the link below.

In a Java EE web or EJB container, when there is an active JTA transaction in progress:

• The session will participate in the JTA transaction and will be committed or rolled back when that transaction is committed or rolled back, not by calling the session's commit or rollback methods.

In the Java EE web or EJB container, when there is no active JTA transaction in progress:

• The session will be non-transacted and received messages will be acknowledged automatically using an acknowledgement mode of Session.AUTO_ACKNOWLEDGE For a definition of the meaning of this acknowledgement mode see the link below.

Applications running in the Java EE web and EJB containers must not attempt to create more than one active (not closed) Session object per connection. If this method is called in a Java EE web or EJB container when an active Session object already exists for this connection then a JMSException will be thrown.

Specified by:

createSession in interface javax.jms.Connection

Returns:

a newly created session

Throws:

javax.jms.JMSException - if the Connection object fails to create a session due to

• some internal error or
• because this method is being called in a Java EE web or EJB application and an active session already exists for this connection.

Since:

JMS 2.0

See Also:

Session.AUTO_ACKNOWLEDGE, Connection.createSession(boolean, int), Connection.createSession(int)

createSharedConnectionConsumer

public javax.jms.ConnectionConsumer createSharedConnectionConsumer(javax.jms.Topic topic,
                                                                   String s,
                                                                   String s1,
                                                                   javax.jms.ServerSessionPool serverSessionPool,
                                                                   int i)
                                                            throws javax.jms.JMSException

Creates a connection consumer for this connection (optional operation) on the specific topic using a shared non-durable subscription with the specified name.

This is an expert facility not used by ordinary JMS clients.

This method must not be used in a Java EE web or EJB application. Doing so may cause a JMSException to be thrown though this is not guaranteed.

Specified by:

createSharedConnectionConsumer in interface javax.jms.Connection

Parameters:

topic - the topic to access

s - the name used to identify the shared non-durable subscription

s1 - only messages with properties matching the message selector expression are delivered. A value of null or an empty string indicates that there is no message selector for the message consumer.

serverSessionPool - the server session pool to associate with this connection consumer

i - the maximum number of messages that can be assigned to a server session at one time

Returns:

the connection consumer

Throws:

javax.jms.JMSException - if the Connection object fails to create a connection consumer for one of the following reasons:

• an internal error has occurred
• invalid arguments for sessionPool and messageSelector or
• this method has been called in a Java EE web or EJB application (though it is not guaranteed that an exception is thrown in this case)

Since:

JMS 2.0

See Also:

ConnectionConsumer

createSharedDurableConnectionConsumer

public javax.jms.ConnectionConsumer createSharedDurableConnectionConsumer(javax.jms.Topic topic,
                                                                          String s,
                                                                          String s1,
                                                                          javax.jms.ServerSessionPool serverSessionPool,
                                                                          int i)
                                                                   throws javax.jms.JMSException

Creates a connection consumer for this connection (optional operation) on the specific topic using a shared durable subscription with the specified name.

This is an expert facility not used by ordinary JMS clients.

This method must not be used in a Java EE web or EJB application. Doing so may cause a JMSException to be thrown though this is not guaranteed.

Specified by:

createSharedDurableConnectionConsumer in interface javax.jms.Connection

Parameters:

topic - topic to access

s - the name used to identify the shared durable subscription

s1 - only messages with properties matching the message selector expression are delivered. A value of null or an empty string indicates that there is no message selector for the message consumer.

serverSessionPool - the server session pool to associate with this durable connection consumer

i - the maximum number of messages that can be assigned to a server session at one time

Returns:

the durable connection consumer

Throws:

javax.jms.JMSException - if the Connection object fails to create a connection consumer for one of the following reasons:

• an internal error has occurred
• invalid arguments for sessionPool and messageSelector or
• this method has been called in a Java EE web or EJB application (though it is not guaranteed that an exception is thrown in this case)

Since:

JMS 2.0

See Also:

ConnectionConsumer