Server Manager API

Table Of Contents

Service Manager API

package com.cisco.vnm.common.api

public interface ServiceManager extends Remote

Public Data Structures and Types

static final String BEST_EFFORT

static final String ATOMIC

static final short CREATE

static final short MODIFY

static final short DELETE

Public Methods

setSessionContext()

queryContained()

Service Manager API

---

package com.cisco.vnm.common.api

public interface ServiceManager extends Remote

This interface provides methods for inventory and provisioning.

Public Data Structures and Types

static final String BEST_EFFORT

Usage:

static final String BEST_EFFORT;

static final String ATOMIC

Usage:

static final String ATOMIC;

static final short CREATE

Usage:

static final short CREATE;

static final short MODIFY

Usage:

static final short MODIFY;

static final short DELETE

Usage:

static final short DELETE;

Public Methods

setSessionContext()

Initiate the session context, taking input from properties. One use, for example, is to pass user/password, token, or cookie for authentication and authorization.

Usage:

public void setSessionContext(Properties prop) throws RemoteException,

ServiceMgrException;

queryContained()

Retrieve an object and all the children in its containment hierarchy.

Usage:

public InventoryQueryResult queryContained(String base_obj_id,

 short scope,

 String obj_class,

 // if empty matches all String attr_value) throws RemoteException,

ServiceMgrException;

Description:

Returns a list of objects encoded in an XML string (defined as QueryResult in an XML DTD).

•base_obj_id—specify the base object (root) to start the query; if empty, returns the top level objects in the system (that is, root objects); expects an XML string encoded as "ObjId".

•scope—specifies the depth of the containment tree, where 0 refers to the entire containment tree;
1 refers to the base object only, n refers to scope of the nth level (including the base object). Currently supports only these values: 0 = entire containment tree, 1 = base object only, 2 = base object plus first level contained objects.

•obj_class—returns only objects whose class matches the one specified; if empty, all objects within the scope are returned.

•attr_value—returns only objects whose attribute value matches the one specified; if empty, all objects within the scope are returned; expects an XML string encoded as "Attribute".

If both obj_class and attr_value are specified, returns objects that match both criteria (that is, objects of specified type and attribute value).

Parameters:

base_obj_id—a string that specifies the base object.

scope—a short that specifies the depth of the containment tree.

obj_class—a string indicating that only objects whose class matches the class specified should be returned.

attr_value—a string indicating that only objects whose attribute value matches the one specified should be returned.

Returns:

InventoryQueryResult which contains batch of objects, encoded as an XML string.