Package io.mats3.spring.jms.factories

Class ScenarioConnectionFactoryWrapper

java.lang.Object

io.mats3.util.wrappers.ConnectionFactoryWrapper

io.mats3.spring.jms.factories.ScenarioConnectionFactoryWrapper

All Implemented Interfaces:

MatsFactory.MatsWrapper<javax.jms.ConnectionFactory>, javax.jms.ConnectionFactory, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.context.EnvironmentAware, org.springframework.context.Lifecycle, org.springframework.context.Phased, org.springframework.context.SmartLifecycle

public class ScenarioConnectionFactoryWrapper
extends ConnectionFactoryWrapper
implements org.springframework.context.EnvironmentAware, org.springframework.beans.factory.BeanNameAware, org.springframework.context.SmartLifecycle

A ConnectionFactoryWrapper which lazily decides which of the three MatsScenarios are active, and produces the wrapper-target ConnectionFactory based on that - you most probably want to use ScenarioConnectionFactoryProducer to make an instance of this class, but you can configure it directly too.

The main documentation for this MatsScenario concept is in the JavaDoc of ScenarioConnectionFactoryProducer.

See Also:

• ScenarioConnectionFactoryProducer
• MatsProfiles
• MatsScenario

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ScenarioConnectionFactoryWrapper.ConnectionFactoryProvider	A ConnectionFactory provider which can throw Exceptions - if it returns a ConnectionFactoryWithStartStopWrapper, start() and stop() will be invoked on that, read more on its JavaDoc.
protected static class	ScenarioConnectionFactoryWrapper.CouldNotGetConnectionFactoryFromProviderException
protected static class	ScenarioConnectionFactoryWrapper.CouldNotStartConnectionFactoryWithStartStopWrapperException
protected static class	ScenarioConnectionFactoryWrapper.CouldNotStopConnectionFactoryWithStartStopWrapperException
static interface	ScenarioConnectionFactoryWrapper.ScenarioDecider	We need a way to decide between the three different MatsScenarios.

Field Summary

Fields

Modifier and Type	Field	Description
protected String	_beanName
protected org.springframework.core.env.Environment	_environment
protected ScenarioConnectionFactoryWrapper.ConnectionFactoryProvider	_localhostConnectionFactoryProvider
protected ScenarioConnectionFactoryWrapper.ConnectionFactoryProvider	_localVmConnectionFactoryProvider
protected MatsScenario	_matsScenarioDecision
protected ScenarioConnectionFactoryWrapper.ConnectionFactoryProvider	_regularConnectionFactoryProvider
protected ScenarioConnectionFactoryWrapper.ScenarioDecider	_scenarioDecider
protected javax.jms.ConnectionFactory	_targetConnectionFactory

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Constructor	Description
ScenarioConnectionFactoryWrapper(ScenarioConnectionFactoryWrapper.ConnectionFactoryProvider regular, ScenarioConnectionFactoryWrapper.ConnectionFactoryProvider localhost, ScenarioConnectionFactoryWrapper.ConnectionFactoryProvider localvm, ScenarioConnectionFactoryWrapper.ScenarioDecider scenarioDecider)	Constructor taking ScenarioConnectionFactoryWrapper.ConnectionFactoryProviders for each of the three MatsScenarios and a ScenarioConnectionFactoryWrapper.ScenarioDecider to decide which of these to employ - you most probably want to use ScenarioConnectionFactoryProducer to make one of these.

Method Summary

Modifier and Type	Method	Description
protected void	createTargetConnectionFactoryBasedOnScenarioDecider()
MatsScenario	getMatsScenarioUsedToMakeConnectionFactory()
int	getPhase()
boolean	isAutoStartup()
boolean	isRunning()
void	setBeanName(String name)
void	setEnvironment(org.springframework.core.env.Environment environment)
void	setWrappee(javax.jms.ConnectionFactory targetConnectionFactory)	Sets the wrapped ConnectionFactory, e.g.
void	start()
void	stop()
void	stop(Runnable callback)
javax.jms.ConnectionFactory	unwrap()

Methods inherited from class io.mats3.util.wrappers.ConnectionFactoryWrapper

createConnection, createConnection

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.mats3.MatsFactory.MatsWrapper

unwrapFully, unwrapTo

Field Details

_regularConnectionFactoryProvider

protected ScenarioConnectionFactoryWrapper.ConnectionFactoryProvider _regularConnectionFactoryProvider

_localhostConnectionFactoryProvider

protected ScenarioConnectionFactoryWrapper.ConnectionFactoryProvider _localhostConnectionFactoryProvider

_localVmConnectionFactoryProvider

protected ScenarioConnectionFactoryWrapper.ConnectionFactoryProvider _localVmConnectionFactoryProvider

_scenarioDecider

protected ScenarioConnectionFactoryWrapper.ScenarioDecider _scenarioDecider

_beanName

protected String _beanName

_environment

protected org.springframework.core.env.Environment _environment

_targetConnectionFactory

protected volatile javax.jms.ConnectionFactory _targetConnectionFactory

_matsScenarioDecision

protected volatile MatsScenario _matsScenarioDecision

Constructor Details

ScenarioConnectionFactoryWrapper

public ScenarioConnectionFactoryWrapper(ScenarioConnectionFactoryWrapper.ConnectionFactoryProvider regular,
 ScenarioConnectionFactoryWrapper.ConnectionFactoryProvider localhost,
 ScenarioConnectionFactoryWrapper.ConnectionFactoryProvider localvm,
 ScenarioConnectionFactoryWrapper.ScenarioDecider scenarioDecider)

Constructor taking ScenarioConnectionFactoryWrapper.ConnectionFactoryProviders for each of the three MatsScenarios and a ScenarioConnectionFactoryWrapper.ScenarioDecider to decide which of these to employ - you most probably want to use ScenarioConnectionFactoryProducer to make one of these.

Method Details

setBeanName

public void setBeanName(String name)

Specified by:

setBeanName in interface org.springframework.beans.factory.BeanNameAware

setEnvironment

public void setEnvironment(org.springframework.core.env.Environment environment)

Specified by:

setEnvironment in interface org.springframework.context.EnvironmentAware

setWrappee

public void setWrappee(javax.jms.ConnectionFactory targetConnectionFactory)

Description copied from class: ConnectionFactoryWrapper

Sets the wrapped ConnectionFactory, e.g. in case you instantiated it with the no-args constructor. Do note that the field holding the wrapped instance is not volatile nor synchronized. This means that if you want to set it after it has been published to other threads, you will have to override both this method and ConnectionFactoryWrapper.unwrap() to provide for needed memory visibility semantics, i.e. establish a happens-before edge between the setting of the instance and any other threads getting it.

Specified by:

setWrappee in interface MatsFactory.MatsWrapper<javax.jms.ConnectionFactory>

Overrides:

setWrappee in class ConnectionFactoryWrapper

Parameters:

targetConnectionFactory - the ConnectionFactory which is returned by ConnectionFactoryWrapper.unwrap(), unless that is overridden.

unwrap

public javax.jms.ConnectionFactory unwrap()

Specified by:

unwrap in interface MatsFactory.MatsWrapper<javax.jms.ConnectionFactory>

Overrides:

unwrap in class ConnectionFactoryWrapper

Returns:

the wrapped ConnectionFactory. All forwarding methods invokes this method to get the wrapped ConnectionFactory, thus if you want to get creative wrt. how and when the ConnectionFactory is decided, you can override this method.

getMatsScenarioUsedToMakeConnectionFactory

public MatsScenario getMatsScenarioUsedToMakeConnectionFactory()

Returns:

the MatsScenario that was used to make the ConnectionFactory returned by unwrap().

createTargetConnectionFactoryBasedOnScenarioDecider

protected void createTargetConnectionFactoryBasedOnScenarioDecider()

getPhase

public int getPhase()

Specified by:

getPhase in interface org.springframework.context.Phased

Specified by:

getPhase in interface org.springframework.context.SmartLifecycle

isAutoStartup

public boolean isAutoStartup()

Specified by:

isAutoStartup in interface org.springframework.context.SmartLifecycle

start

public void start()

Specified by:

start in interface org.springframework.context.Lifecycle

isRunning

public boolean isRunning()

Specified by:

isRunning in interface org.springframework.context.Lifecycle

stop

public void stop()

Specified by:

stop in interface org.springframework.context.Lifecycle

stop

public void stop(Runnable callback)

Specified by:

stop in interface org.springframework.context.SmartLifecycle