<DRAFT>

ROOTS Console Interface

1. ROOTS Console Interface
   1. Introduction
   2. Provided ROOTS targets

Introduction

The purpose of this document is to provide a guide for application programmers to use the remote interface of ROOTS with non Java clients. For that, the text-based web service operations of the remote interface are described to build own clients. To understood this document the reader must be familiar with the ROOTS Type System.

ROOTS Console Interface for string target execution on the ROOTS server is represented by IStringTargetExecution interface.
Each ROOTS server target must provide this interface. Target services are registered using the remote.target property to define the target they operate on.
A target service must either provide the IStringExecution or the IPropertyExecution interface.

IStringTargetExecutionFactory is an interface of the property execution client factory for string execution client handles.
To execute properties on the specific target of the ROOTS server one IStringTargetExecution object must be created by IStringTargetExecutionFactory.
Afterward the method
String execute(String target, String properties)
must be invoked on this IStringTargerExecution object to execute properties on the ROOTS server.

target is a String parameter that specifies the string execution service on the server.

properties is a String representation of a SersMap<?> object that contains properties needed for target specific execution.
SersMap is an StrSerialized map implementation defined in bundle biz.kachel.roots.strobjects.types.
SersMapFactory service can be used to create new SersMap<?> objects.
Some targets expect subtarget property that specifies the kind of the application request.

Result of the execute method is also String representation of an SersMap<?> object.
In bundle biz.kachel.roots.remote.basic.common.util useful utility classes can be found for encapsulate converting Strings parameters to SersMap and vice versa.

Actually there are two implementations provided by ROOTS:
InprocessClient (InProcess client for ROOTS internal usage) and PropertyExecutionClientFactory (based on Hessian web service protocol).

In following chapter available targets are described with expected input properties and properties of the result SersMap.
The text constants are written in bold letter, parameter names in italic letters.

Provided ROOTS targets

This chapter described expected input properties and result of all available ROOTS targets implementing IStringTargetExecution:

IStringTargetExecution String execute(String target, String properties) ...

As described in the introduction, properties is a String representation of an SersMap object, also the result String.

Following targets are available in ROOTS server:

• target = console.login
  Usage: open remote session at the beginning of an operation block.
  Returned session id must be passed into all further ROOTS remote calls.
  Package containing enumeration types representing used property names: biz.kachel.roots.console.common
  Required properties in properties SersMap<?> (property name: property value description; property value type):
  • user: user name; String
  • password: user password; String
  • host.name: host name; String
  • host.address: host address; String
    Name and type of SersMap<?> result set properties:
  • _session.id : session identifier; String
  • roles: user roles; String[]

For all following targets described in this section the session identifier must be given as a property in properties:

• _session.id : session identifier; String
  This session identifier is a part of the result SersMap of console.login target.

• target = cservice
  Usage: service informations.
  Name and type of SersMap<?> result properties:
  For each service class a property is generated with according informations.
  Property name is set to the String representation of (next) integer value. First property name is "0".
  • <propertyName> : service id, class name and component name; String[3]

• target = cbundle
  Usage: ROOTS bundle informations.
  Names and type of SersMap<?> result properties:
  For each bundle a property is generated with according bundle informations.
  Property name is set to the String representation of (next) integer value. First Property name is "0".
  • <propertyName> : bundle symbolic name, bundle state, fragment information and bundle id; String[4]

• target = cappl
  Usage: application management informations.
  Package containing enumeration types representing used property names: biz.kachel.ecp.console.common
  Package containing types of returned property values: biz.kachel.ecp.console.common.model
  Additional required properties in properties SersMap<?>:
  • subtarget : subtarget specifies the kind of the application request.
    Following table describes the allowed subtarget property values and additional required properties in properties depending on subtarget value:

• target = cevent
  Usage: ROOTS application management informations.
  Package containing enumeration types representing used property names: biz.kachel.roots.ecp.console.common
  Package containing types of returned property values: biz.kachel.ecp.console.common.model
  Additional required properties in properties:
  • subtarget : subtarget specifies the kind of request.
    Following table describes the allowed subtarget property values and additional required properties in properties depending on subtarget value:

• target = cweb
  Usage: console web links from ecpweb.properties file.e
  Names and types of result properties:
  For each property found in ecpweb.properties one entry is generated in SersMap<?> result set properties:
  • <propertyName> : link name; String

• target = csession
  Usage: console session informations.
  Package containing types of returned property values: biz.kachel.roots.ecp.console.common.model
  Names and types of result properties:
  • result: session model informations; Collection<SessionModel>
    O
• target = cmain
  Usage: console main informations (license, overview, statistics)
  Package containing enumeration types representing used property names: biz.kachel.roots.ecp.console.common
  Package containing types of returned property values: biz.kachel.roots.ecp.console.common.model
  Additional required property in properties SersMap<?>:
  • subtarget : subtarget specifies the kind of application request.
    Following table describes the allowed subtarget property values and additional required properties in properties depending on subtarget value: