cc/td/doc/product/rtrmgmt/bacbba/bacbba25
hometocprevnextglossaryfeedbacksearchhelp
PDF

Table of Contents

cns.idl
Module List
Interface List
Module common
Module authentication
Interface AuthenticateWithPassword
Interface LoginWithPassword
Module cns
Interface CNSServiceManager

cns.idl


Module List

The file cns.idl contains the following modules:

common
authentication
cns

Interface List

The file cns.idl contains the following interfaces:

authentication::AuthenticateWithPassword
authentication::LoginWithPassword
cns::CNSServiceManager

Module common

Common module defines the common structures and exceptions used by all the modules.

Data Structures and Types

AttributeList User Defined Type

Usage
typedef sequence<sAttribute> AttributeList

eErrorCategory Enumerated Type

This enum represents the error category of modules, data access, authentication, CDA and authorization.

Usage
enum eErrorCategory
{
SYSTEM,
DATA_ACCESS,
AUTHENTICATION,
CDA,
AZN,
DESS
};
Enumerators

SYSTEM — category of common errors

DATA_ACCESS — data access error

AUTHENTICATION — authentication error

CDA — CDA errors

AZN — authorization errors

DESS — DESS errors

EnvironmentContext User Defined Type

Usage
typedef sequence<sBOMEntry> EnvironmentContext

eValueType Enumerated Type

Represents the enumeration of supported type for attribute values.

Usage
enum eValueType
{
TYPE_INTEGER,
TYPE_BOOLEAN,
TYPE_WSTRING,
TYPE_BINARY
};

OctetArray User Defined Type

Usage
typedef sequence<octet> OctetArray

sAttribute Structure

Represents the attribute which has name and value list.

Usage
struct sAttribute
{
string name;
ValueList values;
};
Members

name — Attribute Name

values — Multi value list of the attribute name

sBOMEntry Structure

This structure represents BOMEntry (Business Object Model) strcture. A sequence of BOM Entries make an environment context which is used in policy evaluation. BOM Entry is used to specify a property value needed to perform a function. In case check permission function in Authroization Manager, BOM entry specify an object which is used in evaluating conditions on a policy rule object. BOM objects are used in Authorization Manager to check permissions.

Usage
struct sBOMEntry
{
string bomClass;
string name;
AttributeList attrs;
};
Members

bomClass — BOM Class name name — BOM Object name attrs — List of attributes values on the BOM object.

sExceptionData Structure

Represents the exception data.

Usage
struct sExceptionData
{
eErrorCategory category;
long code;
string message;
string details;
string trace;
};
Members

eErrorCategory — Error Category

code — Error Code

message — Error message

details — Exception details

trace — Additional trace information in case of nested exceptions.

sVersion Structure

This structure holds version details of GSAL-CORBA.

Usage
struct sVersion
{
long major;
long minor;
};
Members

major — Represents major version of GSAL-CORBA

minor — Represents minor version of GSAL-CORBA

Value Union

Represents the union to store an attribute value.

Usage
union Value switch (eValueType)
{
case TYPE_INTEGER:
long integer;
case TYPE_BOOLEAN:
boolean bool;
case TYPE_WSTRING:
string wstr;
case TYPE_BINARY:
OctetArray binary;
};

ValueList User Defined Type

Sequence of "Any" Values.

Usage
typedef sequence<Value> ValueList

Exceptions

CNSException

This is a common CNS Exception.

Usage
exception CNSException
{
sExceptionData e;
};

Module authentication

Authentication module defines interfaces, data structures and exceptions used for authentication.

Data Structures and Types

eResponseStatus Enumerated Type

Usage
enum eResponseStatus
{
SUCCESS,
CONTINUE,
CREDENTIAL_EXPIRED,
AUTHENTICATION_FAILURE
};

MechProviderList User Defined Type

Usage
typedef sequence<sMechProvider> MechProviderList

Principal Structure

This structure represents the user information.

Usage
struct Principal
{
string type;
string name;
};
Members

type — Principal Type

name — Principal Name

PrincipalList User Defined Type

Usage
typedef sequence<Principal> PrincipalList

sMechProvider Structure

This strucure reprsents authentication mechanism providing information for the object.

Usage
struct sMechProvider
{
string mechanism;
string provider;
};
Members

mechanism — Authentication mechanism

provider — Authentication provider

sResponse Structure

Information about response of authentication or login.

Usage
struct sResponse
{
common::OctetArray response;
eResponseStatus status;
common::OctetArray token;
};
Members

response — This is token handler which can be used to obtain a complete token.

status — This field reprsents status of authentication/login.

token — This is the actual token after succesfull authentication/login.

Token User Defined Type

Usage
typedef sequence<octet> Token

TokenList User Defined Type

Usage
typedef sequence<Token> TokenList

Exceptions

AuthenticationIncompleteException

Usage
exception AuthenticationIncompleteException
{
common::sExceptionData e;
};

AuthenticationRequiredException

Usage
exception AuthenticationRequiredException
{
common::sExceptionData e;
};

InvalidMechanismOrProviderException

Usage
exception InvalidMechanismOrProviderException
{
common::sExceptionData e;
};

InvalidUserOrCredentialException

Usage
exception InvalidUserOrCredentialException
{
common::sExceptionData e;
};

NotAuthorizedException

Usage
exception NotAuthorizedException
{
common::sExceptionData e;
};

NotImplementedException

Usage
exception NotImplementedException
{
common::sExceptionData e;
};

OptionsNotSupportedException

Usage
exception OptionsNotSupportedException
{
common::sExceptionData e;
};

Interface AuthenticateWithPassword

Provides password-based authentication services to application clients. This interface is provided as a convenience for applications that authenticate users based on their password. The {@link Authenticate} interface should be used where possible since it can support other mechanisms in addition to username and password.

Operations

authenticate()

Authenticates a user based on their password.

Usage
sResponse authenticate(
in string username,
in string password,
inout common::AttributeList options,
inout common::EnvironmentContext env)
raises(
OptionsNotSupportedException,
CNSException);
Parameters

username — the username

password — the user's password

options — a list of options to the underlying mechanism

env — the environment context for policy evaluation

Returns

The sResponse containing the status.

Raises

OptionsNotSupportedException — if an unsupported option was requested

CNSException — if the method fails for another reason

Interface LoginWithPassword

Provides password-based login services to application clients.

Description

This interface is provided as a convenience for applications that login users based on their password. The Login interface should be used where possible because it can support other mechanisms in addition to username and passsword.

Operations

login()

Allows a user to login based on userName and Password.

Usage
sResponse login(
in string userName,
in string password,
inout common::AttributeList options,
inout common::EnvironmentContext env)
raises(
OptionsNotSupportedException,
CNSException);
Parameters

username — the username

password — the user's password

options — a list of options to the underlying mechanism

env — the environment context for policy evaluation

Returns

The sResponse containing the status.

Raises

OptionsNotSupportedException — if an unsupported option was requested

CNSException — if the method fails for another reason

logout()

Logout Operation

Usage
void logout();
raises(
CNSException);
Raises

CNSException — if logout fails

Description

Log out the currently logged-in client.

Module cns

The CNS module is the base module to obtain other manager interfaces.

Interface CNSServiceManager

This module is the Top Level Manager interface Object

Operations

getAuthenticationManager()

Usage
authentication::AuthenticationManager getAuthenticationManager();
raises(
CNSException);

hometocprevnextglossaryfeedbacksearchhelp
Posted: Wed May 21 08:21:37 PDT 2003
All contents are Copyright © 1992--2003 Cisco Systems, Inc. All rights reserved.
Important Notices and Privacy Statement.