Idl Interface - Cisco CRS-1 - Carrier Routing System Router Api Manual

Cisco CRS-1 Series XML Transport and CORBA IDL
When the CORBA XML agent receives the XML request, it uses the XML infrastructure on the router
to parse and process the request. The agent then obtains the XML response from the XML infrastructure
and passes this back to the client as a response parameter on the "invoke()" method return.

IDL Interface

The following IDL example defines the interfaces used to make Cisco CRS-1 Series XML API requests.
The IDL interface was designed to be simple for easy migration to other transports. Request details,
including operation name, request parameters, and versioning information, are not exposed through the
IDL, but are instead encoded in the request itself. To make a Cisco CRS-1 Series XML API request, the
client application calls the "invoke()" method sending the "stringified" XML request as the request
parameter. The stringified XML response along with error information is returned in the response
parameter to the client application.
module Manageability
{
/*
* edt: * * XMLAgent::login
*
* Provides the definition for the login() method for the XMLAgent idl
*
* Return:CORBA::Boolean
*
*
*
*
* Argument: username
*
* IN - valid login username on the router.
*
* Argument: password
*
* IN - valid unencrypted password for the given username on the router.
*
* Argument: session_context
*
* OUT - internally generated context for a given valid login session.
* Clients will use this in the invoke call.
*
* Argument: response
*
* OUT - contains error code and error message string in case login failed.
* Clients will use this to know the reason of failure.
*
*/
/*
* edt: * * XMLAgent::invoke
*
* Provides the definition for the invoke() method for the XMLAgent idl
*
* Return: None
*
* Argument: session_context
Cisco CRS-1 Series Carrier Routing System XML API Guide
11-104
interface XMLAgent
{
TRUE - The method succeeded
FALSE - The method failed
boolean login (in string username,
in string password,
out long session_context,
out string response);
Chapter 11 XML Transport and Event Notifications
OL-4596-01