This shows you the differences between two versions of the page.
mq_series_adaptor [2023/05/08 12:10] montse [Functions] |
mq_series_adaptor [2024/12/10 12:21] (current) montse [Initialization Parameters] |
||
---|---|---|---|
Line 4: | Line 4: | ||
=====Configuration===== | =====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: |
=====Initialization Parameters===== | =====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===== | =====Functions===== | ||
- | * **addConsumer**: Adds a new consumer to the queue. | + | * **addConsumer**: adds a new consumer to the queue. |
- | * **commit**: Confirmation of a temporary to permanent change. | + | * **commit**: confirmation of a temporary change to permanent. |
- | * **connect**: Attempts to connect to the specified queue. Returns true if successful, and returns false or error if unsuccessful. No parameters are required since it uses the adapter's parameters. | + | * **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 disconnection from the queue. Returns true if successful or false otherwise. No parameters are required. | + | * **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. | + | * **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. | + | * **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 for rollback. | + | * **rollback**: allows rollback. |
- | * **sendMessage**: Send messages to the queue. You must indicate in the parameters which message the queue has to receive. | + | * **sendMessage**: send messages to the queue. You must indicate in the parameters which message the queue has to receive. |