VERSION
VERSION
The wrapper version.
The wrapper version number.
Outbound Status Web Service.
__construct(string $cloud_id, string $username, string $access_key)
Create a OutboundStatusWebService object.
This object provides access to the status of an outbound service invocation and provides means to cancel them.
| string | $cloud_id | The cloud identifier, such as "1-2-0". |
| string | $username | The cloud account username. |
| string | $access_key | The cloud account's access key. |
getApplicationStatus(string $application_instance_id) : \Aculab\WebServicesWrapper\ApplicationStatus|null
Get the status of an application.
Gets the application status as an ApplicationStatus object.
The application instance id in known to UAS applications and is included in the instance info object of HTTP requests to REST applications.
For outbound applications, the application instance id can also be obtained from \Aculab\WebServicesWrapper\OutboundInstanceStatus::getApplicationInstanceId()
| string | $application_instance_id | The application instance id of the instance to check. |
Returns an ApplicationStatus object if the status is available.
setCryptoMethod(integer $method)
Set the crypto method used when connectiing to the web services server.
This allows a specific crypto method to be used when connecting to the web service server. The values should be one of the STREAM_CRYPTO_METHOD_TLSv1_N_CLIENT constants. The default is STREAM_CRYPTO_METHOD_ANY_CLIENT.
| integer | $method | The crypto method to use. |
setProxy(string $proxy, boolean $request_fulluri)
Configures the proxy server to use when making Web Service requests.
| string | $proxy | URI specifying address of proxy server. (e.g. tcp://proxy.example.com:5100). |
| boolean | $request_fulluri | When set to TRUE, the entire URI will be used when constructing the request. While this is a non-standard request format, some proxy servers require it. |
getInstanceStatus(array|string $invocation_reference_ids) : array
Get the status of one or more outbound instances.
| array|string | $invocation_reference_ids | A single invocation reference ID object or an array of invocation reference IDs. |
Returns an array of OutboundInstanceStatus objects, keyed by invocation reference ID.
cancelInstance(array|string $invocation_reference_ids) : array
Cancel one or more outbound servce invocations.
| array|string | $invocation_reference_ids | A invocation reference ID object or an array of invocation reference IDs. |
Returns an array, keyed by invocation reference ID, containing the cancellation status, The cancellation status is one of "success", "failed", or "unknown".
"success" indicates that the service invocation was successfully cancelled before it was run. "failed" indicates that the service was recognised but could not be cancelled. "unknown" indicates that the service was not recognised, either because it was incorrect or has expired.