This shows you the differences between two versions of the page.
mq_series_adaptor [2022/03/18 11:17] montse [Introducción] |
mq_series_adaptor [2024/12/10 12:21] (current) montse [Initialization Parameters] |
||
---|---|---|---|
Line 3: | Line 3: | ||
This adaptor is used to connect with a MQ console to be able to work with a huge amount of data. MQ queues are data structure that follow the FIFO (First in, First out) philosophy, first message in fisrt out. | This adaptor is used to connect with a MQ console to be able to work with a huge amount of data. MQ queues are data structure that follow the FIFO (First in, First out) philosophy, first message in fisrt out. | ||
- | =====Configuración===== | + | =====Configuration===== |
- | In the initialisation process, it is necessary to provide the information to connect to the queue. This is the information that the adapter needs: | + | In the initialization process, it is necessary to provide the information to connect to the queue. This is the information that the adapter needs: |
- | =====Parámetros de Inicialización===== | + | =====Initialization Parameters===== |
- | * **Queue name**: Name of the queue to connect. | + | * **Queue name**: name of the queue to connect. |
- | * **Queue manager**: Queue manager name. | + | * **Queue manager**: queue manager name. |
- | * **Channel name**: Channel name. | + | * **Channel name**: channel name. |
- | * **Host**: Ip address of the queue console. | + | * **Host**: IP address of the queue console. |
- | * **Port**: Port for the IP address of the queue console. | + | * **Port**: port for the IP address of the queue console. |
- | * **User**: Username to access the MQ console. | + | * **User**: username to access the MQ console. |
- | * **Password**: Password to access the MQ console. | + | * **Password**: password to access the MQ console. |
- | * **Message selector**: Option to choose a specific message. | + | * **Message selector**: option to choose a specific message. |
- | * **Queue type**: Type of queue to be connected. For example: Sender (Receives messages) or Receiver (Sends messages).\\ | + | * **Queue type**: type of queue to be connected. For example: Sender (Receives messages) or Receiver (Sends messages).\\ |
+ | |||
+ | =====Functions===== | ||
+ | * **addConsumer**: adds a new consumer to the queue. | ||
+ | |||
+ | * **commit**: confirmation of a temporary change to permanent. | ||
+ | |||
+ | * **connect**: attempts to connect to the specified queue. Returns true if it succeeds, and returns false or error if it fails.No parameters are required since it uses the adapter's parameters. | ||
+ | |||
+ | * **disconnect**: performs the disconnection of the queue. Returns true if successful or false otherwise. No parameters are required. | ||
+ | |||
+ | * **getNumMessages**: only for QUEUE_SENDER. Returns the number of messages contained in a queue. | ||
+ | |||
+ | * **receiveMessage**: it reads and receives all the messages sent to a queue. The first message received would be stored in the first position and the last one in the last position. | ||
+ | |||
+ | * **rollback**: allows rollback. | ||
+ | |||
+ | * **sendMessage**: send messages to the queue. You must indicate in the parameters which message the queue has to receive. | ||
- | =====Funciones===== | ||
- | * **commit**: confirmation of a temporary to permanent change. | ||
- | * **connect**: Attempts to connect to the specified queue. Returns true if it succeeds, and returns false or error if it fails. No parameters are required as it uses the parameters of the adapter. | ||
- | * **disconnect**: Disconnects from the queue. Returns true on success or false otherwise. No parameters required. | ||
- | * **receiveMessage**: Reads and receives all the messages thrown into a queue. The first message received would be stored in the first position and the last one in the last position. | ||
- | * **sendMessage**: Send messages to the queue. You must indicate in the parameters which message the queue has to receive.\\ | ||