About the Administration API

The Mashup Builder has its own administration APIs accessible through HTTP REST. You can use them very easily with the 360-admin-client.jar Java library that abstracts everything to let you work with high level objects.

This page discusses:

Administration Methods

Here is a list of the administration methods available:

Method

Description

void saveConfiguration(Object configuration)

Saves a configuration object to the staging area. You only need to provide a configuration object as configuration classes are naturally tied to a filename.

Object getConfiguration(Class configurationClass)

Retrieves the last version of a given configuration class, from the staging area. If there are no staged configurations available, the latest applied configuration is returned.

void resetConfiguration(Class configurationClass)

Removes the staged instance of the given configuration class to cancel changes.

boolean hasStagedConfiguration(Class configurationClass)

Returns true if an instance of this configuration class is stored in the staging area.

ApplyStagingConfigurationAnswer applyStagingConfiguration()

Applies all the staged configuration files.

ApplyStagingConfigurationAnswer applyStagingConfiguration(List<Class> confClasses)

Applies only the given staged configuration files.

void checkStagingConfiguration()

Runs a full configuration consistency check towards the staged configuration.

void generateCloudViewConfiguration()

Enforces the evaluation of the Data Ontology to generate and apply the underlying Mashup Builder configuration.

Default Services Locations

The following table lists the various service types and their locations. If you have multiple instances of the Mashup Builder, add the application name to the path.

Service Type

Deployment Role

Instance name

Location

Path

mashup-builder

Mashup Builder

360-administration-console

BASEPORT + 1 (gateway)

/mashup-builder

360-administration-service

Gateway

360-administration-service

BASEPORT + 11 (gateway)

/360-admin-service

360-mashup-ui

Mashup UI

360-mashup-ui-mu0

BASEPORT + 0 (searchserver-ss0)

/mashup-ui/page/<PAGENAME>

access-api

Mashup API

access-api-ac0

BASEPORT + 10 (searchserver-ss0)

/access/feeds/<PAGENAME>

trustedQueriesService

Trusted Queries API

trustedQueriesService-tqs0

BASEPORT + 10 (searchserver-ss0)

/360-trustedqueries

businessConsole

Business Console

businessConsole

BASEPORT + 1 (gateway)

/business-console

Mashup Builder services all answer to /admin/isAlive if they are alive. For example: 

http://<HOSTNAME>:<BASEPORT+10>/access/admin/isAlive

Configuration System

Exalead CloudView modules are managed by a distinct configuration system, introducing a new staging area and a per module configuration management. The configuration works as follows:

  • On save (through Mashup Builder / Administration API), files are staged in <DATADIR>/gct/staging

  • On apply (through Mashup Builder / Administration API), all or specified files are copied in <DATADIR>/config/360. Configuration files in this directory are considered as applied. Then, the applyConfiguration call of the underlying Exalead CloudView instance is invoked.

  • At runtime, services read their configuration from <DATADIR>/gct/<last version>/master/360

  • When a new configuration is applied, services are notified and reload their configuration without having to restart.

If you want to modify the Mashup Builder configuration manually in the <DATADIR>/config/360 directory, you need to invoke an apply configuration order on Exalead CloudView by running the command: <DATADIR>/bin/cvcmd.sh applyConfig