Prerequisites

The Rhino REST API Framework requires a Linux system with OpenJDK 11. The JAVA_HOME shell environment variable should be set to the base directory of the OpenJDK installation.

Use Rhino 3.0.0.0 or later.

Important The Rhino REST API Framework requires access to Metaswitch Artifactory servers. Please contact Metaswitch for a username and password.
Important Contact Metaswitch if you require a license file.

Preparing to use Rhino REST API Framework

Installation and setup is simple:

1

Download the SDK package

download Download the Rhino REST API Framework

Uncompress the archive unified-rest-ra-sdk-1.0.0.0.zip

~/work$ unzip unified-rest-ra-sdk-1.0.0.0.zip
~/work$ cd unified-rest-ra-sdk
~/work/unified-rest-ra-sdk$ ls -l
total 80
drwxr-xr-x@ 14 sdkuser  staff   448  2 Nov 11:09 .
drwxr-xr-x   4 sdkuser  staff   128  2 Nov 11:07 ..
-rw-r--r--@  1 sdkuser  staff    24 23 Oct 14:16 .build
-rw-r--r--@  1 sdkuser  staff    73 23 Oct 14:16 .gitignore
-rw-r--r--@  1 sdkuser  staff    21 23 Oct 14:16 .sdk.root
-rw-r--r--@  1 sdkuser  staff   267 23 Oct 14:16 README.txt
drwxr-xr-x@ 25 sdkuser  staff   800  2 Nov 11:07 build
-rw-r--r--@  1 sdkuser  staff   391 23 Oct 14:16 build.xml
-rw-r--r--@  1 sdkuser  staff   293 23 Oct 14:16 deps.properties
-rw-r--r--   1 sdkuser  staff   825  2 Nov 11:07 ivy.properties
-rw-r--r--   1 sdkuser  staff  6421  2 Nov 11:09 release.properties
drwxr-xr-x@  7 sdkuser  staff   224 23 Oct 14:16 rhino-sdk
-rw-r--r--@  1 sdkuser  staff  2171 23 Oct 14:16 sdk.properties
drwxr-xr-x@  6 sdkuser  staff   192 23 Oct 14:16 tools
Tip You may freely rename the destination directory unified-rest-ra-sdk

2

Update sdk.properties

There are a few properties in sdk.properties you should update based on your requirements

sdk.properties
# Branch name.
branch.name=trunk 1

# Ivy details to use when publishing modules.
sdk.ivy.org=UNSET 2
sdk.ivy.publish.revision=1.0.0 3

# Component versions to use by default.
# These can be overridden inside individual modules in module.properties.
sdk.component.version=1.0 4
sdk.component.vendor=UNSET 5

  1. the name of the branch, which could be something similar to <yourorg>-rest-ra/trunk

  2. the org value for all Ivy artifacts created by this Rhino REST API Framework SDK install.

  3. the revision value for all Ivy artifacts created by this Rhino REST API Framework SDK install.

  4. the version portion of the SLEE Component ID for all SLEE components published by this Rhino REST API Framework SDK install.

  5. the vendor portion of the SLEE Component ID for all SLEE components published by this Rhino REST API Framework SDK install.

Example values for an ExampleCo Rhino REST API Framework project
branch.name=exampleco-rest-ra/trunk

sdk.ivy.org=exampleco
sdk.ivy.publish.revision=1.0.0

sdk.component.version=1.0
sdk.component.vendor=ExampleCo

3

Run ant for the first time

When you run ant for the first time, the Rhino REST API Framework initialises itself by downloading components from artifactory servers. You will be prompted for a username and password.

Important Contact Metaswitch for a username and password to access Metaswitch Artifactory servers. 
~/work/unified-rest-ra-sdk$ ant
Buildfile: /Users/davidp/temp/unified-rest-ra-sdk/build.xml

init-build-extensions:

pre-init-ivy-common:

init-ivy-common:

Determining Ivy settings.

Checking ivy-defaults.properties for ivy settings.
 artifactory.host=repo.opencloud.com                             (from ivy-defaults.properties)
 artifactory.url=https://${artifactory.host}/artifactory         (from ivy-defaults.properties)
 ivy.cache.root=${sdk.root}/build/target/ivy-caches/online-resolvers.cache(from ivy-defaults.properties)
 ivy.checksums=sha1                                              (from ivy-defaults.properties)
 ivy.dir=${basedir}                                              (from ivy-defaults.properties)
 ivy.libs=${target}/libs                                         (from ivy-defaults.properties)
 ivy.local.root=${sdk.root}/repositories/sdk-local               (from ivy-defaults.properties)
 ivy.offline.root=${sdk.root}/repositories/opencloud-offline-mirror(from ivy-defaults.properties)
 ivy.publication.root=${ivy.local.root}                          (from ivy-defaults.properties)
 ivy.resolve.refresh=false                                       (from ivy-defaults.properties)
 ivy.sdk-resolvers.file=online-resolvers.xml                     (from ivy-defaults.properties)
 ivy.sdk-resolvers.path=${ivy.settings.dir}/${ivy.sdk-resolvers.file}(from ivy-defaults.properties)
 ivy.symlinks=false                                              (from ivy-defaults.properties)

Missing Artifactory credentials. An Artifactory username and password are required to access SDK dependencies.
[oc:ivyautoconfigure] Please enter your Artifactory username:
<metaswitch-supplied-username>

Please enter your Artifactory password:

Writing Ivy configuration to: /Users/davidp/temp/unified-rest-ra-sdk/ivy.properties
...

The installation and setup is now complete.

Tip Learn more about the Sentinel Express SDK.
Previous page Next page