Web Services Java Wrapper Overview

Introduction

Aculab Cloud provides a number of Web Services that implement features such as initiating outbound services, managing files, sending SMS messages and managing telephone numbers and other resources on the cloud.

You can make requests to these web services directly or use this high-level language wrapper.

The Wrapper Library

The wrapper is supplied as a java archive webservicewrappers.jar. It comes packaged with both the Java UAS and Java REST API the Java UAS along with a number of sample applications that illustrate how to use it.

The PlatformAccount class identifies the cloud Rapide server and user account on which the web service is to be called.
For each Web Service suite a set of classes exists that wraps the web service requests and unwraps the JSON format responses.

The main wrapper classes available on Aculab Cloud Rapide and Aculab Cloud are:

OutboundServiceWebService - invokes outbound services that start UAS applications
OutboundRESTAPIService - invokes outbound services that start REST API applications
ApplicationStatusWebService - retrieves the status of one or more application instances
MessageWebService - sends SMS and MMS messages, keeps track of their progress and identifies blocked numbers
FileWebService - manages media files, REST API log files, and message media files on the cloud media store
VoiceBiometricsUsersWebService - manages voice biometrics users
VoiceBiometricsUserGroupsWebService - manages voice biometrics user groups
VoiceBiometricsUserGroupKeysWebService - manages voice biometrics user group keys
MonitorWebService - accesses monitor recording media files
RESTInterruptWebService - interrupts a REST API application instance
ConferenceManager - manages conference reservations and configures active conferences using ConferenceWebService
TelephoneNumberPurchaseWebService - purchases inbound telephone number for use with Aculab Cloud
NumberLookupWebService - get information about a telephone number
ReportsWebService - requests and downloads detailed application, call or error reports
WebRTCClientToolsWebService - generate tokens used to allow WebRTC clients to register for calls
SecurityToolsWebService - check the security of web service requests
ServicesWebService - read, write, modify and delete services; retrieve service schemas; and manage outbound service queues

Note: The wrapper is not thread safe. When writing multithreaded applications, it is best practice to create separate instances of the main wrapper classes for each thread.

Samples

The java samples included in the download package illustrate how to use the various wrapper classes.

Please note that in the interests of clarity these samples are short on the kind of error handling and diagnostic aspects that would typically be required in a live environment.

Where to Find Them

In the Java Web Services download package they can be found in the <installation folder>\lib folder.

How to Run Them

These samples are all console applications. Some require command line parameters to be supplied. Those that do describe the expected parameters below each sample description.