Class SolaceJcsmpAbstractConsumer
- All Implemented Interfaces:
AdaptrisComponent
,AdaptrisMessageConsumer
,AdaptrisMessageWorker
,ComponentLifecycle
,ComponentLifecycleExtension
,SolaceJcsmpReceiverStarter
,MessageEventGenerator
,StateManagedComponent
,com.solacesystems.jcsmp.XMLMessageListener
- Direct Known Subclasses:
SolaceJcsmpQueueConsumer
,SolaceJcsmpTopicConsumer
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic enum
static enum
static enum
-
Field Summary
Fields inherited from class com.adaptris.core.AdaptrisMessageWorkerImp
log
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected com.solacesystems.jcsmp.ConsumerFlowProperties
createConsumerFlowProperties
(com.solacesystems.jcsmp.Queue queue) protected com.solacesystems.jcsmp.EndpointProperties
"CLIENT" / "AUTO""EXCLUSIVE" / "NONEXCLUSIVE""CONSUME" / "DELETE" / "READ_ONLY" / "NONE" / "MODIFY_TOPIC""The message translator is responsible for translating the Solace JCSMP message object into anAdaptrisMessage
and the reverse.If set to 'true' will commit or rollback the consumed message upon success or failure during processing.void
init()
void
onException
(com.solacesystems.jcsmp.JCSMPException exception) void
onReceive
(com.solacesystems.jcsmp.BytesXMLMessage message) void
setAcknowledgeMode
(String acknowledgeMode) "CLIENT" / "AUTO"void
setEndpointAccessType
(String endpointAccessType) "EXCLUSIVE" / "NONEXCLUSIVE"void
setEndpointPermissions
(String endpointPermissions) "CONSUME" / "DELETE" / "READ_ONLY" / "NONE" / "MODIFY_TOPIC""void
setMessageTranslator
(SolaceJcsmpMessageTranslator messageTranslator) The message translator is responsible for translating the Solace JCSMP message object into anAdaptrisMessage
and the reverse.void
setTransacted
(Boolean transacted) If set to 'true' will commit or rollback the consumed message upon success or failure during processing.void
start()
abstract void
void
stop()
Methods inherited from class com.adaptris.core.AdaptrisMessageConsumerImp
changeState, newThreadName, 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.ComponentLifecycle
close
Methods inherited from interface com.adaptris.core.ComponentLifecycleExtension
prepare
Methods inherited from interface com.adaptris.core.MessageEventGenerator
createName, createQualifier, isTrackingEndpoint
-
Constructor Details
-
SolaceJcsmpAbstractConsumer
public SolaceJcsmpAbstractConsumer()
-
-
Method Details
-
onException
public void onException(com.solacesystems.jcsmp.JCSMPException exception) - Specified by:
onException
in interfacecom.solacesystems.jcsmp.XMLMessageListener
-
onReceive
public void onReceive(com.solacesystems.jcsmp.BytesXMLMessage message) - Specified by:
onReceive
in interfacecom.solacesystems.jcsmp.XMLMessageListener
-
init
- Specified by:
init
in interfaceComponentLifecycle
- Throws:
CoreException
-
start
- Specified by:
start
in interfaceComponentLifecycle
- Throws:
CoreException
-
stop
public void stop()- Specified by:
stop
in interfaceComponentLifecycle
-
createConsumerFlowProperties
protected com.solacesystems.jcsmp.ConsumerFlowProperties createConsumerFlowProperties(com.solacesystems.jcsmp.Queue queue) -
createEndpointProperties
protected com.solacesystems.jcsmp.EndpointProperties createEndpointProperties() -
startReceive
- Specified by:
startReceive
in interfaceSolaceJcsmpReceiverStarter
- Throws:
Exception
-
getMessageTranslator
The message translator is responsible for translating the Solace JCSMP message object into anAdaptrisMessage
and the reverse. The translator will typically handle the payload and the headers/metadata. -
setMessageTranslator
The message translator is responsible for translating the Solace JCSMP message object into anAdaptrisMessage
and the reverse. The translator will typically handle the payload and the headers/metadata.- Parameters:
messageTranslator
-
-
getEndpointPermissions
"CONSUME" / "DELETE" / "READ_ONLY" / "NONE" / "MODIFY_TOPIC""
This must match your end-point permissions on the Solace queue/topic.
-
setEndpointPermissions
"CONSUME" / "DELETE" / "READ_ONLY" / "NONE" / "MODIFY_TOPIC""
This must match your end-point permissions on the Solace queue/topic.
- Parameters:
endpointPermissions
-
-
getEndpointAccessType
"EXCLUSIVE" / "NONEXCLUSIVE"
This must match your end-point configuration on the Solace queue/topic.
-
setEndpointAccessType
"EXCLUSIVE" / "NONEXCLUSIVE"
This must match your end-point configuration on the Solace queue/topic.
- Parameters:
endpointAccessType
-
-
getAcknowledgeMode
"CLIENT" / "AUTO"
Client acknowledge mode means Interlok will handle the Acknowledgements after the workflow has finished or the producer gives us a successful async callback.
-
setAcknowledgeMode
"CLIENT" / "AUTO"
Client acknowledge mode means Interlok will handle the Acknowledgements after the workflow has finished or the producer gives us a successful async callback.
- Parameters:
acknowledgeMode
-
-
getTransacted
If set to 'true' will commit or rollback the consumed message upon success or failure during processing. -
setTransacted
If set to 'true' will commit or rollback the consumed message upon success or failure during processing.
-