io.mats3.impl.jms

Class JmsMatsJmsSessionHandler_Pooling.JmsSessionHolderImpl

java.lang.Object

io.mats3.impl.jms.JmsMatsJmsSessionHandler_Pooling.JmsSessionHolderImpl

All Implemented Interfaces:

JmsMatsJmsSessionHandler.JmsSessionHolder, JmsMatsStatics

Enclosing class:

JmsMatsJmsSessionHandler_Pooling

public static class JmsMatsJmsSessionHandler_Pooling.JmsSessionHolderImpl
extends java.lang.Object
implements JmsMatsJmsSessionHandler.JmsSessionHolder, JmsMatsStatics

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.concurrent.atomic.AtomicBoolean	_closedOrCrashed
protected JmsMatsJmsSessionHandler_Pooling.ConnectionWithSessionPool	_connectionWithSessionPool
protected java.lang.Object	_currentContext
protected javax.jms.Session	_jmsSession
protected javax.jms.MessageProducer	_messageProducer

Fields inherited from interface io.mats3.impl.jms.JmsMatsStatics

EXTRA_GRACE_MILLIS, ILLEGAL_CALL_FLOWS, JMS_MSG_PROP_AUDIT, JMS_MSG_PROP_DISPATCH_TYPE, JMS_MSG_PROP_FROM, JMS_MSG_PROP_INITIALIZING_APP, JMS_MSG_PROP_INITIATOR_ID, JMS_MSG_PROP_MATS_MESSAGE_ID, JMS_MSG_PROP_MESSAGE_TYPE, JMS_MSG_PROP_TO, JMS_MSG_PROP_TRACE_ID, LOG_PREFIX, MAX_STACK_HEIGHT, MAX_TOTAL_CALL_NUMBER, MDC_MATS_APP_NAME, MDC_MATS_APP_VERSION, MDC_MATS_CALL_NUMBER, MDC_MATS_IN_MESSAGE_SYSTEM_ID, MDC_MATS_INIT, MDC_MATS_OUT_MATS_MESSAGE_ID, MDC_MATS_STAGE, MDC_MATS_STAGE_ID, MDC_MATS_STAGE_INDEX, MDC_TRACE_ID, NO_INVOCATION_POINT, RANDOM_ALPHABET, THREAD_PREFIX, TOTAL_JMS_MSG_PROPS_SIZE

Constructor Summary

Constructors

Constructor and Description
JmsSessionHolderImpl(JmsMatsTransactionManager.JmsMatsTxContextKey txContextKey, JmsMatsJmsSessionHandler_Pooling.ConnectionWithSessionPool connectionWithSessionPool, javax.jms.Session jmsSession, javax.jms.MessageProducer messageProducer)

Method Summary

Modifier and Type	Method and Description
void	close() Employed by StageProcessors: This physically closes the JMS Session, and removes it from the pool-Connection, and when all Sessions for a given pool-Connection is closed, the pool-Connection is closed.
void	crashed(java.lang.Throwable t) Notifies that a Session (or "downstream" consumer or producer) raised some exception - probably due to some connectivity issues experienced as a JMSException while interacting with the JMS API, or because the JmsMatsJmsSessionHandler.JmsSessionHolder.isSessionOk() returned false.
javax.jms.MessageProducer	getDefaultNoDestinationMessageProducer()
javax.jms.Session	getSession()
void	isSessionOk() Shall be invoked at these points, with the action to perform if it raises JmsMatsException.JmsMatsJmsException.
void	release() For Initiators: This returns the JmsSessionHolder to the Session Pool for the underlying Connection.
protected void	setCurrentContext(java.lang.Object currentContext)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.mats3.impl.jms.JmsMatsStatics

createFlowId, getInvocationPoint, handleIncomingMessageMatsObject, handleIncomingState, id, id, idThis, ms3, produceAndSendMsgSysMessages, randomString, setConcurrencyWithLog, stageOrInit

Field Detail

_connectionWithSessionPool

protected final JmsMatsJmsSessionHandler_Pooling.ConnectionWithSessionPool _connectionWithSessionPool

_jmsSession

protected final javax.jms.Session _jmsSession

_messageProducer

protected final javax.jms.MessageProducer _messageProducer

_currentContext

protected java.lang.Object _currentContext

_closedOrCrashed

protected java.util.concurrent.atomic.AtomicBoolean _closedOrCrashed

Constructor Detail

JmsSessionHolderImpl

public JmsSessionHolderImpl(JmsMatsTransactionManager.JmsMatsTxContextKey txContextKey,
                            JmsMatsJmsSessionHandler_Pooling.ConnectionWithSessionPool connectionWithSessionPool,
                            javax.jms.Session jmsSession,
                            javax.jms.MessageProducer messageProducer)

Method Detail

setCurrentContext

protected void setCurrentContext(java.lang.Object currentContext)

isSessionOk

public void isSessionOk()
                 throws JmsMatsException.JmsMatsJmsException

Description copied from interface: JmsMatsJmsSessionHandler.JmsSessionHolder

Shall be invoked at these points, with the action to perform if it raises JmsMatsException.JmsMatsJmsException.

1. (For StageProcessors) Before going into MessageConsumer.receive() - if JmsMatsException.JmsMatsJmsException is raised, JmsMatsJmsSessionHandler.JmsSessionHolder.close() or JmsMatsJmsSessionHandler.JmsSessionHolder.crashed(Throwable) shall be invoked, and then a new JmsSessionHolder shall be fetched. [This is to be able to signal to the StageProcessor that the underlying Connection might have become unstable - start afresh]
2. (For StageProcessors and Initiators) Before committing any resources other than the JMS Session - if JmsMatsException.JmsMatsJmsException is raised, rollback shall be performed, JmsMatsJmsSessionHandler.JmsSessionHolder.close() or JmsMatsJmsSessionHandler.JmsSessionHolder.crashed(Throwable) shall be invoked, and then a new JmsSessionHolder shall be fetched. [This is to tighten the gap between typically the DB commit and the JMS commit: Just before the DB is committed, an invocation to this method is performed. If this goes OK, then the DB is committed and then the JMS Session is committed.]

Specified by:

isSessionOk in interface JmsMatsJmsSessionHandler.JmsSessionHolder

Throws:

JmsMatsException.JmsMatsJmsException

getSession

public javax.jms.Session getSession()

Specified by:

getSession in interface JmsMatsJmsSessionHandler.JmsSessionHolder

Returns:

the JMS Session. It will be the same instance every time.

getDefaultNoDestinationMessageProducer

public javax.jms.MessageProducer getDefaultNoDestinationMessageProducer()

Specified by:

getDefaultNoDestinationMessageProducer in interface JmsMatsJmsSessionHandler.JmsSessionHolder

Returns:

the default non-specific MessageProducer that goes along with the JMS Session.

close

public void close()

Description copied from interface: JmsMatsJmsSessionHandler.JmsSessionHolder

Employed by StageProcessors: This physically closes the JMS Session, and removes it from the pool-Connection, and when all Sessions for a given pool-Connection is closed, the pool-Connection is closed.

Specified by:

close in interface JmsMatsJmsSessionHandler.JmsSessionHolder

release

public void release()

Description copied from interface: JmsMatsJmsSessionHandler.JmsSessionHolder

For Initiators: This returns the JmsSessionHolder to the Session Pool for the underlying Connection.

Note: It is allowed to call this in a finally block after use, so it must guard against already having been closed or crashed when inside the JmsMatsTransactionManager, in which case it should probably effectively act as a no-op.

Specified by:

release in interface JmsMatsJmsSessionHandler.JmsSessionHolder

crashed

public void crashed(java.lang.Throwable t)

Description copied from interface: JmsMatsJmsSessionHandler.JmsSessionHolder

Notifies that a Session (or "downstream" consumer or producer) raised some exception - probably due to some connectivity issues experienced as a JMSException while interacting with the JMS API, or because the JmsMatsJmsSessionHandler.JmsSessionHolder.isSessionOk() returned false.

This should close and ditch the Session, then the SessionHandler should (semantically) mark the underlying Connection as broken, and then then get all other "leasers" to come back with their sessions (close or crash), so that the Connection can be closed. The leasers should then get a new session by JmsMatsJmsSessionHandler.getSessionHolder(JmsMatsStageProcessor), which will be based on a fresh Connection.

NOTE: If a session comes back with "crashed", but it has already been "revoked" by the SessionHandler due to another crash, this invocation should be equivalent to JmsMatsJmsSessionHandler.JmsSessionHolder.close(), i.e. "come home as agreed upon, whatever the state you are in".

Specified by:

crashed in interface JmsMatsJmsSessionHandler.JmsSessionHolder

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object