Alpaca

Introduction

The Alpaca Library is at it's core a Java interpretation of the BroadWorks OCI schema Version 20sp1 as available from Broadsoft XChange. In most cases datatypes found in the OCI schema in XML can be found in the Alpaca library as Java objects. In addition to the types found in the OCI schema, Alpaca contains objects to handle connectivity with a BroadWorks system and helpers to perform more complex tasks not available in the OCI schema.

Example

Creating an Alpaca based application can be as simple as creating a connection to BroadWorks and sending in a request. This example retrieves all access devices in the BroadWorks system. In production you would also want to verify that the response object was not an error response.

BroadWorksServer bws = BroadWorksServer.getBroadWorksServer(server, username, password);

// Get All Access Devices in the System
SystemAccessDeviceGetAllRequest accessDeviceGetAllRequest = new SystemAccessDeviceGetAllRequest(bws);
SystemAccessDeviceAccessDeviceTable accessDeviceTable = accessDeviceGetAllRequest.fire().getAccessDeviceTable();

for(Row accessDevice : accessDeviceTable.getRows()) {
    // Process Access Devices
}

Setup

• Download the current version of the Alpaca.
• Extract Alpaca into the desired location.
• Insert your alpaca.license file anywhere in the Alpaca directory. This is typically placed into ./config.
• Modify the ./config/alpaca.properties.xml file to the desired values. Minimal installation will be to set the server, username, and password. A full configuration guide can be accessed here.

<core>
    <default>
        <server>xsp.mycompany.com</server>
        <userId>myusername</userId>
        <password>mypassword</password>
    </default>
</core>

• You can test the configuration by running alpaca in the Alpaca Library directory.

Dependencies

• Java JDK 1.8