public interface MessageProcessor extends ManagedLifecycle, Nameable, SynapseArtifact
Modifier and Type | Method and Description |
---|---|
boolean |
activate()
This method is used to activate a deactivated message processor.
|
void |
cleanupLocalResources()
This method is used to cleanup local resources such as JMS connections
used by the message processor.
|
boolean |
deactivate()
This method is used to deactivate the message processor.
|
String |
getArtifactContainerName()
Get the name of the artifact container from which the message processor deployed
|
String |
getFileName()
This method is used to retrieve the configuration file name of the message processor.
|
List<MessageConsumer> |
getMessageConsumer()
This method retrieves the message consumer of message processor.
|
String |
getMessageStoreName()
This method returns the associated message store name of the message processor.
|
Map<String,Object> |
getParameters()
This method is used to retrieve the configuration parameters of message processor.
|
String |
getTargetEndpoint()
This method is used to retrieve the associated target endpoint name of the message processor.
|
boolean |
isDeactivated()
This method is used to see if the message processor is deactivated.
|
boolean |
isEdited()
Whether the message processor edited through the management console
|
boolean |
isPaused()
This method is used to check if the state is in paused mode.
|
void |
pauseService()
This method is only used by the associated forwarding services of message processors.
|
void |
resumeService()
This is the opposite of pauseService method.
|
void |
setArtifactContainerName(String artifactContainerName)
Set the name of the artifact container from which the message processor deployed
|
void |
setFileName(String fileName)
This method is used to set the actual configuration file.
|
void |
setIsEdited(boolean isEdited)
Set whether the message processor edited through the management console
|
boolean |
setMessageConsumer(MessageConsumer messageConsumer)
This method is used to set the message consumer of message processor.
|
void |
setMessageStoreName(String messageStoreName)
This method is used to set the associated message store of the message processor.
|
void |
setParameters(Map<String,Object> parameters)
This method is used to set configuration parameters of the message processor.
|
void |
setTargetEndpoint(String targetEndpoint)
This method set the target endpoint associated with the message processor.
|
boolean |
start()
This method is used to start the message processor.
|
boolean |
stop()
This method is used to stop the message processor.
|
destroy, init
getDescription, setDescription
boolean start()
true
if successful, false
otherwiseboolean stop()
true
if successful, false
otherwiseboolean deactivate()
true
if successful, false
otherwiseboolean activate()
true
if successful, false
otherwiseboolean isDeactivated()
true
if successful, false
otherwisevoid setMessageStoreName(String messageStoreName)
messageStoreName
- Name of this message store.String getMessageStoreName()
void setParameters(Map<String,Object> parameters)
parameters
- Message processor parameters.Map<String,Object> getParameters()
void setFileName(String fileName)
fileName
- is the name of the fileString getFileName()
boolean setMessageConsumer(MessageConsumer messageConsumer)
messageConsumer
- is the name of the associated message consumerList<MessageConsumer> getMessageConsumer()
void setTargetEndpoint(String targetEndpoint)
targetEndpoint
- is the name of the associated endpointString getTargetEndpoint()
void pauseService()
void resumeService()
boolean isPaused()
void cleanupLocalResources()
boolean isEdited()
void setIsEdited(boolean isEdited)
isEdited
- String getArtifactContainerName()
void setArtifactContainerName(String artifactContainerName)
artifactContainerName
- Copyright © 2005–2018 Apache Software Foundation. All rights reserved.