Listener Status object
The Listener Status object represents the status of a listener process deployed to a runtime, Runtime cluster, or Runtime cloud. For example, you can retrieve a listener's status to ensure that requests for pause, resume, or restart take effect before performing other actions.
Retrieving the listener status is an asynchronous process:
-
The client sends a QUERY request that specifies a container ID and, optionally, a listener ID to the platform.
-
The platform returns a listener status token.
-
The client sends a GET request that includes the listener status token to the platform.
-
The platform returns the status of the specified listener or listeners.
If the QUERY request does not include a listener ID, the subsequent GET request retrieves the status of all listeners on that container.
Structure
QUERY response:
<AsyncOperationTokenResult responseStatusCode="">
<asyncToken token=""/>
</AsyncOperationTokenResult>
GET response:
<AsyncOperationResult responseStatusCode="" numberOfResults="">
<result type="" status="" listenerId="" connectorType=""/>
.
.
.
<result type="" status="" listenerId=""/>
</AsyncOperationTokenResult>
| Field | Type | Description |
|---|---|---|
| responseStatusCode | string | The status code returned from a request, as follows: - 202 — Initialized the Listener status request and is in progress (QUERY response). - 200 — Listener status request is complete (GET response). |
| token | string | A unique token generated by the platform. |
| type | string | A static value of ListenerStatus. |
| status | string | The status of the listener as listening, paused, or errored. |
| listenerId | string | The Component ID for the listener process. |
| connectorType | string | The internal and unique identifier for connector type, which resembles the connector type names presented on the Build tab of the user interface. |
Supported operations
| GET | QUERY | CREATE | UPDATE | EXECUTE | DELETE |
|---|---|---|---|---|---|
 | |  | | | |
-
The ordinary GET operation retrieves async results from the QUERY.
-
You can use the following fields as QUERY filters for the Listener Status object:
Field Allowed values listenerId Valid Component ID for the listener process. If you do not specify a listener ID, the subsequent GET request retrieves the status of all listeners on that container.
Note: Cite obtaining the ID using the ComponentMetadata object, not Process. Or in the Build UI, in Revision History for an opened Process.containerId Required. Valid containerId for the runtime, Runtime cluster, or Runtime cloud. Only the EQUALS operator is allowed for Listener Status object filters.
For general information about the structure of QUERY filters, refer to Query filters.
SOAP implementation
-
GET operation
Request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.platform.boomi.com/">
<soapenv:Header>
<wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
<wsse:UsernameToken wsu:Id="UsernameToken" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
<wsse:Username>your email</wsse:Username>
<wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">your password</wsse:Password>
</wsse:UsernameToken>
</wsse:Security>
</soapenv:Header>
<soapenv:Body>
<api:asyncResult>
<api:token>ListenerStatus-f3f690a0-296a-4350-918c-b00bd7f7702e</api:token>
</api:asyncResult>
</soapenv:Body>
</soapenv:Envelope>Response:
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<bns:asyncResultResponse xmlns:bns="http://api.platform.boomi.com/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<bns:results responseStatusCode="200" numberOfResults="1">
<bns:result xsi:type="bns:ListenerStatus" status="listening" listenerId="ea56da44-ea7d-4c80-9866-30556474938e" connectorType="wss"/>
</bns:results>
</bns:asyncResultResponse>
</S:Body>
</S:Envelope> -
QUERY operation
The following example query returns a listener status token for a single listener process.
Request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.platform.boomi.com/">
<soapenv:Header>
<wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
<wsse:UsernameToken wsu:Id="UsernameToken" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
<wsse:Username>your email</wsse:Username>
<wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">your password</wsse:Password>
</wsse:UsernameToken>
</wsse:Security>
</soapenv:Header>
<soapenv:Body>
<api:queryAsync>
<api:objectType>ListenerStatus</api:objectType>
<api:queryConfig>
<api:QueryFilter>
<api:expression operator="and" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="api:GroupingExpression">
<api:nestedExpression operator="EQUALS" property="listenerId"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="api:SimpleExpression">
<api:argument>ea56da44-ea7d-4c80-9866-30556474938e</api:argument>
</api:nestedExpression>
<api:nestedExpression operator="EQUALS" property="containerId"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="api:SimpleExpression">
<api:argument>1045759d-7f6c-4108-bd0e-7b71541d6a2d</api:argument>
</api:nestedExpression>
</api:expression>
</api:QueryFilter>
</api:queryConfig>
</api:queryAsync>
</soapenv:Body>
</soapenv:Envelope>Response:
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<bns:queryAsyncResponse xmlns:bns="http://api.platform.boomi.com/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<bns:results responseStatusCode="202">
<bns:asyncToken token="ListenerStatus-f3f690a0-296a-4350-918c-b00bd7f7702e"/>
</bns:results>
</bns:queryAsyncResponse>
</S:Body>
</S:Envelope>
