Package com.adaptris.core.jcsmp.solace

Class SolaceJcsmpConnection

java.lang.Object

com.adaptris.core.AdaptrisConnectionImp

com.adaptris.core.AllowsRetriesConnection

com.adaptris.core.jcsmp.solace.SolaceJcsmpConnection

All Implemented Interfaces:

AdaptrisComponent, AdaptrisConnection, ComponentLifecycle, ComponentLifecycleExtension, SolaceJcsmpSessionCreator, StateManagedComponent

@ComponentProfile(summary="A Solace native JCSMP connection used to create JCSMP sessions to your Solace appliance.",
                  tag="connection,solace,jcsmp",
                  since="3.9.3")
public class SolaceJcsmpConnection
extends AllowsRetriesConnection
implements SolaceJcsmpSessionCreator

The Interlok AdaptrisConnection that will allow us to connect to your Solace router via the JCSMP api.

Simply supply the host, vpn name, user and password.

In the adapter configuration file this class is aliased as solace-jcsmp-connection which is the preferred alternative to the fully qualified classname when building your configuration.

Field Summary

Fields inherited from class com.adaptris.core.AdaptrisConnectionImp

log

Constructor Summary

Constructors

Constructor	Description
SolaceJcsmpConnection()

Method Summary

Modifier and Type	Method	Description
protected boolean	additionalDebug()
protected void	closeConnection()
com.solacesystems.jcsmp.JCSMPSession	createSession()
java.lang.Boolean	getAdditionalDebug()
SolaceJcsmpAdvancedConnectionProperties	getAdvancedProperties()
@NotNull AuthenticationProvider	getAuthenticationProvider()	How would you like to be authenticated when connecting to Solace.
@NotNull java.lang.String	getHost()	The tcp address to your Solace router, such as "tcp://localhost:55555".
@NotNull java.lang.String	getVpn()	The Solace VPN name, such as "default".
protected void	initConnection()
protected void	prepareConnection()
void	setAdditionalDebug(java.lang.Boolean additionalDebug)
void	setAdvancedProperties(SolaceJcsmpAdvancedConnectionProperties advancedProperties)
void	setAuthenticationProvider(@NotNull AuthenticationProvider authenticationProvider)	How would you like to be authenticated when connecting to Solace.
void	setHost(@NotNull java.lang.String host)	The tcp address to your Solace router, such as "tcp://localhost:55555".
void	setVpn(@NotNull java.lang.String vpn)	The Solace VPN name, such as "default".
protected void	startConnection()
protected void	stopConnection()

Methods inherited from class com.adaptris.core.AllowsRetriesConnection

connectionAttempts, connectionRetryInterval, createLoggingStatement, getConnectionAttempts, getConnectionRetryInterval, logWarning, setConnectionAttempts, setConnectionRetryInterval

Methods inherited from class com.adaptris.core.AdaptrisConnectionImp

addExceptionListener, addMessageConsumer, addMessageProducer, changeState, cloneForTesting, close, connectionErrorHandler, getConnectionErrorHandler, getUniqueId, getWorkersFirstOnShutdown, init, prepare, requestClose, requestInit, requestStart, requestStop, retrieveComponentState, retrieveConnection, retrieveExceptionListeners, retrieveMessageConsumers, retrieveMessageProducers, setConnectionErrorHandler, setUniqueId, setWorkersFirstOnShutdown, start, stop, workersFirstOnShutdown

Methods inherited from class java.lang.Object

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

Constructor Detail

SolaceJcsmpConnection

public SolaceJcsmpConnection()

Method Detail

createSession

public com.solacesystems.jcsmp.JCSMPSession createSession()
                                                   throws java.lang.Exception

Specified by:

createSession in interface SolaceJcsmpSessionCreator

Throws:

java.lang.Exception

prepareConnection

protected void prepareConnection()
                          throws CoreException

Specified by:

prepareConnection in class AdaptrisConnectionImp

Throws:

CoreException

initConnection

protected void initConnection()
                       throws CoreException

Specified by:

initConnection in class AdaptrisConnectionImp

Throws:

CoreException

startConnection

protected void startConnection()
                        throws CoreException

Specified by:

startConnection in class AdaptrisConnectionImp

Throws:

CoreException

stopConnection

protected void stopConnection()

Specified by:

stopConnection in class AdaptrisConnectionImp

closeConnection

protected void closeConnection()

Specified by:

closeConnection in class AdaptrisConnectionImp

additionalDebug

protected boolean additionalDebug()

getHost

@NotNull
public @NotNull java.lang.String getHost()

The tcp address to your Solace router, such as "tcp://localhost:55555".

setHost

public void setHost(@NotNull
                    @NotNull java.lang.String host)

The tcp address to your Solace router, such as "tcp://localhost:55555".

Parameters:

host -

getVpn

@NotNull
public @NotNull java.lang.String getVpn()

The Solace VPN name, such as "default".

setVpn

public void setVpn(@NotNull
                   @NotNull java.lang.String vpn)

The Solace VPN name, such as "default".

Parameters:

vpn -

getAuthenticationProvider

@NotNull
public @NotNull AuthenticationProvider getAuthenticationProvider()

How would you like to be authenticated when connecting to Solace.

setAuthenticationProvider

public void setAuthenticationProvider(@NotNull
                                      @NotNull AuthenticationProvider authenticationProvider)

How would you like to be authenticated when connecting to Solace.

getAdditionalDebug

public java.lang.Boolean getAdditionalDebug()

setAdditionalDebug

public void setAdditionalDebug(java.lang.Boolean additionalDebug)

getAdvancedProperties

public SolaceJcsmpAdvancedConnectionProperties getAdvancedProperties()

setAdvancedProperties

public void setAdvancedProperties(SolaceJcsmpAdvancedConnectionProperties advancedProperties)