Aculab Web Services Wrapper (v1.2.0)
\
Aculab
WebServicesWrapper
VoiceBiometrics
Users

\Aculab\WebServicesWrapperRestInterruptWebService

REST Interrupt Web Service.

Summary

Methods
Properties
Constants
setWebServicesServer()
setCryptoMethod()
setProxy()
__construct()
interruptApplication()
No public properties found
VERSION
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Constants

VERSION

VERSION

The wrapper version.

The wrapper version number.

Methods

setWebServicesServer()

setWebServicesServer(string  $wsserver)

Set the web services server address.

This allows the web service requests to be directed to a specific server. The default is https://ws-<cloud_id>.aculabcloud.net

Parameters

string $wsserver

The base URL of the web services server.

setCryptoMethod()

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.

Parameters

integer $method

The crypto method to use.

setProxy()

setProxy(string  $proxy, boolean  $request_fulluri)

Configures the proxy server to use when making Web Service requests.

Parameters

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.

__construct()

__construct(string  $cloud_id, string  $username, string  $access_key)

Create a RestInterruptWebService object.

Parameters

string $cloud_id

The cloud identifier, such as "1-2-0".
string $username

The cloud account username.
string $access_key

The access key for the cloud account.

interruptApplication()

interruptApplication(array|string  $applicationInstanceId, string  $redirect_page = null, string  $redirect_method = null) : array

Interrupt an instance of a REST application.

This will interrupt one or more REST application instances that are running on Aculab Cloud. The current action will be stopped and any further actions in the list will be skipped.

Parameters

array|string $applicationInstanceId

The application instance ID of the REST application to interrupt, or an array of such IDs.
string $redirect_page

The page to which to send the result of the interrupt.
string $redirect_method

The method ("GET" or "POST") to use when accessing the $redirect_page.

Throws

\Aculab\WebServicesWrapper\WebServiceException

Returns

array —

Returns an array RestInterruptedResult objects, indexed by application ID.