RabbitMQStore (Apache Synapse - Core 2.1.7-wso2v94 API)

java.lang.Object
- org.apache.synapse.message.store.AbstractMessageStore
- - org.apache.synapse.message.store.impl.rabbitmq.RabbitMQStore

All Implemented Interfaces:

ManagedLifecycle, MessageStore, Nameable, SynapseArtifact
```
public class RabbitMQStore
extends AbstractMessageStore
```

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_PORT` RabbitMQ Server default port
`static String`	`EXCHANGE_NAME` RabbitMQ exchange.
`static String`	`HOST_NAME` RabbitMQ Server Host name
`static String`	`HOST_PORT` RabbitMQ Server Port
`static String`	`PASSWORD` RabbitMQ Broker password
`static String`	`QUEUE_NAME` RabbitMQ queue name that this message store must store the messages to.
`static String`	`ROUTE_KEY` RabbitMQ route key which queue is binded
`static String`	`SSL_ENABLED`
`static String`	`SSL_KEYSTORE_LOCATION`
`static String`	`SSL_KEYSTORE_PASSWORD`
`static String`	`SSL_KEYSTORE_TYPE`
`static String`	`SSL_TRUSTSTORE_LOCATION`
`static String`	`SSL_TRUSTSTORE_PASSWORD`
`static String`	`SSL_TRUSTSTORE_TYPE`
`static String`	`SSL_VERSION`
`static String`	`USERNAME` RabbitMQ Broker username
`static String`	`VIRTUAL_HOST` RabbitMQ Server Virtual Host

Fields inherited from class org.apache.synapse.message.store.AbstractMessageStore
description, fileName, lock, messageStoreMBean, messageStoreObservers, name, parameterKeyMap, parameters, sequence, synapseConfiguration, synapseEnvironment

Constructor Summary

Constructors
Constructor and Description

RabbitMQStore()

Constructors
Constructor and Description
`RabbitMQStore()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`cleanup(com.rabbitmq.client.Connection connection, boolean error)` Cleans up the RabbitMQ Connection
`void`	`clear()` Delete all the Messages in the Message Store
`boolean`	`closeConnection(com.rabbitmq.client.Connection connection)` Close any given connection
`boolean`	`closeProducerConnection()` Closes the existing RabbitMQ message producer connection.
`void`	`destroy()` This method should implement the destroying of the implemented parts of the configuration.
`MessageContext`	`get(int index)` Return the Message in given index position (this may depend on the implementation)
`MessageContext`	`get(String messageId)` Get the Message with the given ID from the Message store without removing it
`List<MessageContext>`	`getAll()` Get the All messages in the Message store without removing them from the queue
`MessageConsumer`	`getConsumer()` Returns a Message Consumer for this message store.
`MessageProducer`	`getProducer()` Returns a Message Producer for this message store.
`int`	`getType()` Returns the type of this message store.
`void`	`init(SynapseEnvironment se)` This method should implement the initialization of the implemented parts of the configuration.
`org.apache.axis2.context.MessageContext`	`newAxis2Mc()`
`boolean`	`newProducerConnection()` Create a new message producer connection, if there is an existing connection close it and create a new connection
`MessageContext`	`newSynapseMc(org.apache.axis2.context.MessageContext msgCtx)`
`com.rabbitmq.client.Connection`	`producerConnection()`
`MessageContext`	`remove()` Retrieves and removes the first Message in this store.
`MessageContext`	`remove(String messageID)` Delete and return the MessageContext with given Message id

Methods inherited from class org.apache.synapse.message.store.AbstractMessageStore
addParameter, addParameterKey, dequeued, difference, enqueued, getArtifactContainerName, getDescription, getFileName, getLock, getName, getParameterKey, getParameterKeyMap, getParameters, isEdited, nextConsumerId, nextProducerId, notifyMessageAddition, notifyMessageRemoval, registerObserver, setArtifactContainerName, setDescription, setFileName, setIsEdited, setName, setParameters, size, unregisterObserver

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - USERNAME
```
public static final String USERNAME
```
    RabbitMQ Broker username
    
    See Also:
    
    Constant Field Values
  - PASSWORD
```
public static final String PASSWORD
```
    RabbitMQ Broker password
    
    See Also:
    
    Constant Field Values
  - HOST_NAME
```
public static final String HOST_NAME
```
    RabbitMQ Server Host name
    
    See Also:
    
    Constant Field Values
  - HOST_PORT
```
public static final String HOST_PORT
```
    RabbitMQ Server Port
    
    See Also:
    
    Constant Field Values
  - DEFAULT_PORT
```
public static final int DEFAULT_PORT
```
    RabbitMQ Server default port
    
    See Also:
    
    Constant Field Values
  - VIRTUAL_HOST
```
public static final String VIRTUAL_HOST
```
    RabbitMQ Server Virtual Host
    
    See Also:
    
    Constant Field Values
  - QUEUE_NAME
```
public static final String QUEUE_NAME
```
    RabbitMQ queue name that this message store must store the messages to.
    
    See Also:
    
    Constant Field Values
  - ROUTE_KEY
```
public static final String ROUTE_KEY
```
    RabbitMQ route key which queue is binded
    
    See Also:
    
    Constant Field Values
  - EXCHANGE_NAME
```
public static final String EXCHANGE_NAME
```
    RabbitMQ exchange.
    
    See Also:
    
    Constant Field Values
  - SSL_ENABLED
```
public static final String SSL_ENABLED
```
    See Also:
    
    Constant Field Values
  - SSL_KEYSTORE_LOCATION
```
public static final String SSL_KEYSTORE_LOCATION
```
    See Also:
    
    Constant Field Values
  - SSL_KEYSTORE_TYPE
```
public static final String SSL_KEYSTORE_TYPE
```
    See Also:
    
    Constant Field Values
  - SSL_KEYSTORE_PASSWORD
```
public static final String SSL_KEYSTORE_PASSWORD
```
    See Also:
    
    Constant Field Values
  - SSL_TRUSTSTORE_LOCATION
```
public static final String SSL_TRUSTSTORE_LOCATION
```
    See Also:
    
    Constant Field Values
  - SSL_TRUSTSTORE_TYPE
```
public static final String SSL_TRUSTSTORE_TYPE
```
    See Also:
    
    Constant Field Values
  - SSL_TRUSTSTORE_PASSWORD
```
public static final String SSL_TRUSTSTORE_PASSWORD
```
    See Also:
    
    Constant Field Values
  - SSL_VERSION
```
public static final String SSL_VERSION
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - RabbitMQStore
```
public RabbitMQStore()
```
- Method Detail
  - init
```
public void init(SynapseEnvironment se)
```
    Description copied from interface: ManagedLifecycle
    
    This method should implement the initialization of the implemented parts of the configuration.
    
    Specified by:
    
    init in interface ManagedLifecycle
    
    Overrides:
    
    init in class AbstractMessageStore
    
    Parameters:
    
    se - SynapseEnvironment to be used for initialization
  - newProducerConnection
```
public boolean newProducerConnection()
```
    Create a new message producer connection, if there is an existing connection close it and create a new connection
    
    Returns:
    
    true if a new connection is created successfully
  - destroy
```
public void destroy()
```
    Description copied from interface: ManagedLifecycle
    
    This method should implement the destroying of the implemented parts of the configuration.
    
    Specified by:
    
    destroy in interface ManagedLifecycle
    
    Overrides:
    
    destroy in class AbstractMessageStore
  - closeConnection
```
public boolean closeConnection(com.rabbitmq.client.Connection connection)
```
    Close any given connection
    
    Parameters:
    
    connection -
    
    Returns:
    
    true if the connection closed successfully false otherwise
  - closeProducerConnection
```
public boolean closeProducerConnection()
```
    Closes the existing RabbitMQ message producer connection.
    
    Returns:
    
    true if the producer connection was closed without any error,
    false otherwise.
  - getProducer
```
public MessageProducer getProducer()
```
    Description copied from interface: MessageStore
    
    Returns a Message Producer for this message store.
    
    Returns:
    
    new MessageProducer
  - getConsumer
```
public MessageConsumer getConsumer()
```
    Description copied from interface: MessageStore
    
    Returns a Message Consumer for this message store.
    
    Returns:
    
    A non-null message consumer that can read messages from this message store.
  - newAxis2Mc
```
public org.apache.axis2.context.MessageContext newAxis2Mc()
```
  - newSynapseMc
```
public MessageContext newSynapseMc(org.apache.axis2.context.MessageContext msgCtx)
```
  - producerConnection
```
public com.rabbitmq.client.Connection producerConnection()
```
  - remove
```
public MessageContext remove()
                      throws NoSuchElementException
```
    Description copied from interface: MessageStore
    
    Retrieves and removes the first Message in this store. Message ordering will depend on the underlying implementation
    
    Returns:
    
    first message context in the store
    
    Throws:
    
    NoSuchElementException - if store is empty
  - clear
```
public void clear()
```
    Description copied from interface: MessageStore
    
    Delete all the Messages in the Message Store
  - getType
```
public int getType()
```
    Description copied from interface: MessageStore
    
    Returns the type of this message store.
    The type of a message store can be one of following types,
    Constants.JMS_MS, Constants.INMEMORY_MS, or Constants.JDBC_MS
    
    Specified by:
    
    getType in interface MessageStore
    
    Overrides:
    
    getType in class AbstractMessageStore
    
    Returns:
    
    Type of the message store.
  - remove
```
public MessageContext remove(String messageID)
```
    Description copied from interface: MessageStore
    
    Delete and return the MessageContext with given Message id
    
    Parameters:
    
    messageID - message id of the Message
    
    Returns:
    
    MessageContext instance
  - get
```
public MessageContext get(int index)
```
    Description copied from interface: MessageStore
    
    Return the Message in given index position (this may depend on the implementation)
    
    Parameters:
    
    index - position of the message
    
    Returns:
    
    Message in given index position
  - getAll
```
public List<MessageContext> getAll()
```
    Description copied from interface: MessageStore
    
    Get the All messages in the Message store without removing them from the queue
    
    Returns:
    
    List of all Messages
  - get
```
public MessageContext get(String messageId)
```
    Description copied from interface: MessageStore
    
    Get the Message with the given ID from the Message store without removing it
    
    Parameters:
    
    messageId - A message ID string
    
    Returns:
    
    Message with given ID
  - cleanup
```
public boolean cleanup(com.rabbitmq.client.Connection connection,
                       boolean error)
```
    Cleans up the RabbitMQ Connection
    
    Parameters:
    
    connection - RabbitMQ Connection
    
    error - is this method called upon an error
    
    Returns:
    
    true if the cleanup is successful. false otherwise.

Class RabbitMQStore

Field Summary

Fields inherited from class org.apache.synapse.message.store.AbstractMessageStore

Constructor Summary

Method Summary

Methods inherited from class org.apache.synapse.message.store.AbstractMessageStore

Methods inherited from class java.lang.Object

Field Detail

USERNAME

PASSWORD

HOST_NAME

HOST_PORT

DEFAULT_PORT

VIRTUAL_HOST

QUEUE_NAME

ROUTE_KEY

EXCHANGE_NAME

SSL_ENABLED

SSL_KEYSTORE_LOCATION

SSL_KEYSTORE_TYPE

SSL_KEYSTORE_PASSWORD

SSL_TRUSTSTORE_LOCATION

SSL_TRUSTSTORE_TYPE

SSL_TRUSTSTORE_PASSWORD

SSL_VERSION

Constructor Detail

RabbitMQStore

Method Detail

init

newProducerConnection

destroy

closeConnection

closeProducerConnection

getProducer

getConsumer

newAxis2Mc

newSynapseMc

producerConnection

remove

clear

getType

remove

get

getAll

get

cleanup