The installation of the REST module on the gateway server can be done automatically via scripts or manually.

Automated Installation

At runtime you can execute the module's install scripts through the Kit Manager, deployed in advance on the OSGi service platform. In general, the Kit Manager can be used from a text console to the runtime:

• from the local console,
• from a Telnet client,
• from a Remote Console, available as a standalone tool or as a part of the Web Admin Console.

The installation of the REST Web Services module can be performed through execution of the Kit Manager installation scripts from the bin/pscripts folder:

• Web Services REST
• Web Services REST M2M
• Web Services REST Compact
• Web Services REST M2M Compact

It is recommended to use only compact or only non-compact bundle versions.The Web Services REST and Web Services REST M2M scripts should be installed together, but not in combination with the compact bundles of the Web Services REST Compact and the Web Services REST M2M Compact scripts.

To execute the install script, which in terms of the Kit Manager is to "install a kit", go to the kitman command group and use the install console command. The different sets of required bundles, found in the .txt files from the bin/pscripts/ folder, are automatically available under the corresponding kit name above. To install the preferred set of bundles of the REST module, pass the name or the ID of the kit as an argument to the install Kit Manager console command from the kitman command group:

kitman.install "<script name>"

as <script name> is the name of the script to be installed. The kitman command group is exported by the Kit Manager bundle – com.prosyst.mbs.util.kitman.jar, located in the /bundles directory.

You may also write your own install scripts for easier installation (and start) of a certain set of bundles. The required bundles for the REST Web Services module are listed in the Manual Installation section below.

Manual Installation

You can install only the needed bundles from the module taking into account their dependencies and Java execution environment profile.

The required bundles for the Jackson JSON serialization provider are:

• jackson-jaxrs-json-provider.jar
• jackson-jaxrs-base.jar
• jackson-module-jaxb-annotations.jar
• jackson-databind.jar
• jackson-annotations.jar
• jackson-core.jar

Choose to install and start the following bundles too:

• xml-apis.jar
• javax.annotation.jar
• javax.activation.jar
• javax.inject.jar
• javax.validation.jar
• javax.xml.bind.jar
• javax.ws.rs-2.1.jar
• jakarta.json.jar
• javax.json.bind.jar

• JAX-RS RI REST container (choose one):
  • jaxrs-ri.jar – non-compact profile;
  • jaxrs-ri.compact.jar – compact profile.

• com.prosyst.mbs.policyadmin.api.jar
• com.prosyst.mbs.policyadmin.commands.jar
• com.prosyst.mbs.policyadmin.identity.condition.jar
• com.prosyst.mbs.policyadmin.identity.useradmin.jar
• com.prosyst.mbs.policyadmin.policy.jar
• com.prosyst.mbs.policyadmin.core.jar
• com.prosyst.mbs.policyadmin.http.websockets.jar

• com.prosyst.mbs.webservices.rest.core.jar
• com.prosyst.mbs.webservices.rest.api.jar
• com.prosyst.mbs.webservices.rest.events.pull.jar
• com.prosyst.mbs.webservices.rest.events.push.jar

• JAX-RS REST container (choose one):
  • Jersey container (choose one based on java execution environment profile):
    • com.prosyst.mbs.webservices.rest.container.jersey.jar – non-compact profile;
    • com.prosyst.mbs.webservices.rest.container.jersey.compact.jar – compact profile.

• JSON serialization provider – one of the following, based on the java execution environment profile:
  • com.prosyst.mbs.webservices.rest.provider.jackson.jar– non compact;
  • com.prosyst.mbs.webservices.rest.provider.gson.jar – both compact and non compact.

• com.prosyst.mbs.webservices.rest.client.jetty.jar

• Jersey JAX-RS REST client (choose one based on java execution environment profile):
  • com.prosyst.mbs.webservices.rest.client.jersey.jar – non-compact profile;
  • com.prosyst.mbs.webservices.rest.client.jersey.compact.jar – compact profile.

• com.prosyst.mbs.webservices.rest.invoker.policy.jar
• com.prosyst.mbs.webservices.rest.doc.jar

To install and start a bundle execute the console command from the fw command group:

install -s <bundle_name>.jar