Package com.adaptris.core.jcsmp.solace
Class SolaceJcsmpQueueConsumer
- java.lang.Object
-
- com.adaptris.core.AdaptrisMessageWorkerImp
-
- com.adaptris.core.AdaptrisMessageConsumerImp
-
- com.adaptris.core.jcsmp.solace.SolaceJcsmpAbstractConsumer
-
- com.adaptris.core.jcsmp.solace.SolaceJcsmpQueueConsumer
-
- All Implemented Interfaces:
AdaptrisComponent
,AdaptrisMessageConsumer
,AdaptrisMessageWorker
,ComponentLifecycle
,ComponentLifecycleExtension
,SolaceJcsmpReceiverStarter
,MessageEventGenerator
,StateManagedComponent
,com.solacesystems.jcsmp.XMLMessageListener
@ComponentProfile(summary="A Solace native JCSMP component that consumes your messages from the Solace VPN.", tag="queue,consumer,solace,jcsmp", since="3.9.3") public class SolaceJcsmpQueueConsumer extends SolaceJcsmpAbstractConsumer
This implementation of
AdaptrisMessageConsumer
will use the Solace Jcsmp Api to consume messages from a Queue on your Solace router.There are four main components that you will need to configure;
- Destination: The Solace end point to consume messages from.
- End point permissions: Should match the Solace configured endpoint properties.
- End point access type: Should match either EXCLUSIVE or NONEXCLUSIVE
- Acknowledge mode: Should either be CLIENT or AUTO.
In the adapter configuration file this class is aliased as solace-jcsmp-queue-consumer which is the preferred alternative to the fully qualified classname when building your configuration.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.adaptris.core.jcsmp.solace.SolaceJcsmpAbstractConsumer
SolaceJcsmpAbstractConsumer.accessType, SolaceJcsmpAbstractConsumer.ackMode, SolaceJcsmpAbstractConsumer.permissions
-
-
Field Summary
-
Fields inherited from class com.adaptris.core.AdaptrisMessageWorkerImp
log
-
-
Constructor Summary
Constructors Constructor Description SolaceJcsmpQueueConsumer()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
close()
java.lang.String
getQueue()
The Solace Queueprotected java.lang.String
newThreadName()
void
prepare()
void
setQueue(java.lang.String queue)
The Solace Queuevoid
startReceive()
void
stop()
-
Methods inherited from class com.adaptris.core.jcsmp.solace.SolaceJcsmpAbstractConsumer
createConsumerFlowProperties, createEndpointProperties, getAcknowledgeMode, getEndpointAccessType, getEndpointPermissions, getMessageTranslator, getTransacted, init, onException, onReceive, setAcknowledgeMode, setEndpointAccessType, setEndpointPermissions, setMessageTranslator, setTransacted, start
-
Methods inherited from class com.adaptris.core.AdaptrisMessageConsumerImp
changeState, registerAdaptrisMessageListener, renameThread, requestClose, requestInit, requestStart, requestStop, retrieveAdaptrisMessageListener, retrieveComponentState
-
Methods inherited from class com.adaptris.core.AdaptrisMessageWorkerImp
createName, createQualifier, decode, encode, getEncoder, getIsTrackingEndpoint, getMessageFactory, getUniqueId, handleConnectionException, isTrackingEndpoint, registerConnection, registerEncoderMessageFactory, retrieveConnection, setEncoder, setIsTrackingEndpoint, setMessageFactory, setUniqueId, withMessageFactory, withUniqueID
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface com.adaptris.core.AdaptrisComponent
getUniqueId
-
Methods inherited from interface com.adaptris.core.AdaptrisMessageConsumer
consumeLocationKey
-
Methods inherited from interface com.adaptris.core.AdaptrisMessageWorker
decode, encode, getEncoder, getMessageFactory, handleConnectionException, registerConnection, retrieveConnection, setEncoder, setMessageFactory
-
Methods inherited from interface com.adaptris.core.MessageEventGenerator
createName, createQualifier, isTrackingEndpoint
-
-
-
-
Method Detail
-
startReceive
public void startReceive() throws java.lang.Exception
- Specified by:
startReceive
in interfaceSolaceJcsmpReceiverStarter
- Specified by:
startReceive
in classSolaceJcsmpAbstractConsumer
- Throws:
java.lang.Exception
-
stop
public void stop()
- Specified by:
stop
in interfaceComponentLifecycle
- Overrides:
stop
in classSolaceJcsmpAbstractConsumer
-
close
public void close()
-
prepare
public void prepare() throws CoreException
- Throws:
CoreException
-
newThreadName
protected java.lang.String newThreadName()
- Overrides:
newThreadName
in classAdaptrisMessageConsumerImp
-
getQueue
public java.lang.String getQueue()
The Solace Queue
-
setQueue
public void setQueue(java.lang.String queue)
The Solace Queue
-
-