ListenerStatusController

The second part of the URI must be lsstatus to call the ListenerStatusController.

inquire

Get status information about one ore more listeners. This actions executes the PCF commando MQCMD_INQUIRE_LISTENER_STATUS. On success, the returned JSON object will have a data array, on failure an error object.

URL Parameters

/api/lsstatus/inquire/<QueueManager>/<ListenerName>

Queuemanager

The name of the queuemanager. This parameter is required.

ListenerName

The name of the listener. When this parameter is used, the query parameter for listername will be ignored. A generic name can be used.

Query Parameters

ExcludeSystem

When value is true, the status of system listeners are not returned. By default this parameter is false. This parameter is optional.

Filter

Speficies which filter to use: I means Integerfilter, S means Stringfilter. FilterParam and FilterValue are required to create the filter. When a filter can’t be build because of too little information, it will be silently discarded.

FilterOp

The operator that is being used to evaluate whether the parameter satisfies the filter-value. The default is EQ.

The following values are allowed:

A Stringfilter can use some additional operators:

FilterParam

The name of the parameter to filter on. The names are based on the names used in the WebSphere MQ information center.

FilterValue

The value to use for filtering. When a string is passed for an Integerfilter, a WebSphere MQ constant is assumed.

ListenerName

The name of the listener. name is a synonym for this parameter. It is ignored when a URL parameter is used. Generic names are allowed.

ListenerStatusAttrs

With the ListenerStatusAttrs parameter you can specify which attributes must be returned from the PCF command. Multiple occurences of this parameter are possible. The value must be a (case-sensitive) valid attribute name.

Attrs is a synonym for ListenerStatusAttrs

Example

/api/lsstatus/inquire/PIGEON
/api/lsstatus/inquire/PIGEON?ListenerName=MQWEB*

<?php
	/*
	 * Inquire status of all listeners from queuemanager 
	 * PIGEON. MQWeb runs on localhost and is listening on port 8081. 
	 */
	$url = "http://localhost:8081/api/lsstatus/inquire/PIGEON";

	$curl = curl_init();
	curl_setopt($curl, CURLOPT_URL, $url);
	curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);

	$response = curl_exec($curl);
	$data = json_decode($response, true);		
	print_r($data);

JSON Object

When using an application/json POST request you can post a JSON object with names like the query parameters.

All URL parameters and query parameters are ignored except for the URL parameter for the name of the queuemanager.

{
  'ListenerName' : 'SYSTEM*',
  'ListenerStatusAttrs' : [
    'ListenerName'
  ]
}

There are some differences between query parameters and a JSON object:

An IntegerFilterCommand can’t be used together with a StringFilterCommand

This is a Perl example that inquires all statuses.

#!/usr/bin/perl
use strict;
use warnings;
use JSON;
use LWP::UserAgent;
use HTTP::Request::Common;

# This sample will show the status of all listeners

my $qmgr = shift;
die("Please pass me the name of a queuemanager as argument") 
	unless defined($qmgr);

my $json = JSON->new;

# There's no need to set ListenerName to * because this is the default,
# but we do it here to show how to build the json content.
my %input = ( 
	'ListenerName' => '*',
);
my $content = $json->encode(\%input);    

my $ua = LWP::UserAgent->new;
my $req = POST 'http://localhost:8081/api/lsstatus/inquire/' . $qmgr;
$req->header(
	'Content-Type' => 'application/json',
	'Content-length' => length($content)
);
$req->content($content);

my $res = $ua->request($req);
die $res->status_line unless $res->is_success;

my $mqweb = $json->decode($res->content());
if ( exists($mqweb->{error}) ) {
	say 'An MQ error occurred while inquiring listener status.';
	say 'Reason Code: '
		, $mqweb->{error}->{reason}->{code}
		, ' - '
		, $mqweb->{error}->{reason}->{desc};
}}
else {
	foreach my $status(@{$mqweb->{data}}) {
		print $status->{ListenerName}->{value};
		print ' : ', $status->{Status}->{display}; 
		print "\n";
	}
}