Package sae


Detailed Description

Service Activation Engine API.

This API provides remote access to the SAE core API.


Classes

exception  FeatureNotInstalled
 An Exception that indicates that a requested interface module is not installed. More...
interface  SAEFeature
 Common interface for SAE interface modules. More...
interface  ServiceActivationEngine
 The interface to the interface module manager of SAE. More...
struct  Attr
 Structure used for the name and values of an object attribute. More...
struct  TimeSpec
 Structure used for the attributes of a time specification. More...
struct  ScheduledTime
 Structure used for two time specifications for a service schedule. More...
struct  ActionExt
 Structure used for service schedules that consist of actions that are performed at specified times. More...
struct  Action
 Structure used for an action to be taken at a specified time. More...
struct  ScheduleEntry
 Structure used for a service schedule. More...
struct  Select
 Structure used to identify attributes and to filter information retrieved from service definitions and subscriptions. More...
struct  IdxPair
 Structure used to hold a subscription index paired with a service index. More...
struct  ReadResult
 Structure used to hold the result of a subscriber information request. More...
exception  UnknownUserException
 Exception raised if a subscriber is not logged in to the subscriber session. More...
exception  NonUniqueUserException
 Exception raised if there is more than one active subscriber session for the specified subscriber ID. More...
exception  UnknownServiceException
 Exception raised if the requested service is not available. More...
exception  UnknownServiceSessionException
 Exception raised if the requested service session does not exist. More...
exception  UnknownSubscriptionException
 Exception raised if the requested subscription does not exist. More...
exception  SAEException
 Exception raised if there is an unspecified error condition within the SAE. More...
exception  LoginException
 Exception raised if a subscriber login to a subscriber session fails, or if an authentication fails for a registered login, an unregistered login, or a registered login that is being obtained. More...
exception  OverloadException
 Exception raised if the SAE was overloaded at the time of the request and did not perform the requested operation. More...
exception  UnsupportedException
 Exception raised if SAE does not support the requested operation. More...
exception  ServiceAuthenticationException
 Exception raised if authentication for service activation failed. More...
struct  TimedAddress
 Structure that encapsulates a subscriber's IP address and the timestamp of the request. More...
struct  InterfaceName
 Structure used to hold the name of a managed interface and the name of virtual router on which the interface resides. More...
struct  InterfaceIndex
 Structure used to hold the SNMP interface index (ifindex) of a managed interface and the virtual router on which the interface resides. More...
struct  AddrInterfaceName
 Structure used to hold the name of a managed interface, the name of the router or virtual router on which the interface resides, and the IP address of the interface. More...
struct  TunnelSession
struct  GlobalAddress
 Globally unique IP address. More...
struct  GlobalLoginName
 Globally unique Login Name. More...
union  SubscriberId
 Structure to identify one or more active subscriber sessions in an SAE. More...
struct  DhcpAttribute
 Structure that encapsulates DHCP profile data that is used to manipulate IP addresses assigned through DHCP. More...
interface  Subscriber
 Interface that is used to manage an active subscriber session. More...
struct  Registration
 Structure used for client device registration information for DHCP connections. More...
interface  SubscriberIterator
 Interface that is used to iteratively retrieve subscriber objects that were not transmitted from a single API call to the SAE. More...
interface  SAEAccess
 Interface to access the SAE core API. More...
exception  ScriptSyntaxError
 The script was rejected by the script compiler. More...
exception  ScriptExecutionError
 The script could not be executed. More...
exception  OperationFailed
interface  ScriptProcessor

Typedefs

typedef sequence< string > StringSeq
 A sequence of strings.
typedef sequence< wstring > WStringSeq
 Sequence of wide strings (unicode).
typedef sequence< AttrAttrSeq
 List of attributes.
typedef sequence< AttrSeqAttrSeqSeq
 List of attribute lists.
typedef sequence< ActionExtActionExtSeq
 List of actions to be scheduled.
typedef sequence< ActionActionSeq
 List of actions.
typedef sequence< long long > LongLongSeq
 64-bit integer value for list of eventDates.
typedef string ScheduleEntryId
 ID for a service schedule (ScheduleEntry).
typedef sequence< ScheduleEntryIdScheduleEntryIdSeq
 Sequence of IDs for a service schedule.
typedef sequence< ScheduleEntryScheduleEntrySeq
 Sequence of entries for a service schedule.
typedef sequence< IdxPairIdxPairSeq
 Sequence of indexes for subscriptions paired with services.
typedef sequence< DhcpAttributeDhcpAttributes
 Sequence of DHCP attributes.
typedef sequence< SubscriberSubscriberSeq
 Sequence of subscriber objects.
typedef sequence< RegistrationRegistrationSeq
 Sequence of registration objects.
typedef sequence< wstring > Arguments
 List of script arguments.

Enumerations

enum  SAET {
  SAET_PUBLIC_IP_AUTHENTICATION,
  SAET_MUTEX_GROUPS,
  SAET_SERVICE_AUTHORIZATION,
  SAET_ANONYMOUS_USER,
  SAET_AUTH_PRECLUDES_ACTIVATE_ON_LOGIN,
  SAET_INHERITED_SUBSCRIPTION,
  SAET_SERVICE_UNAVAILABLE,
  SAET_SUBSCRIPTION_AUTHORIZATION,
  SAET_ACTIVATE_ONLY,
  SAET_INVISIBLE,
  SAET_FILTERED_OUT,
  SAET_NO_SESSION_MODIFICATION,
  SAET_TRANSIENT_EXCEPTION,
  SAET_PERSISTENT_ACTIVATION,
  SAET_MODIFY_EXCEPTION
}
 Types of exceptions for ServiceAuthenticationException. More...
enum  SubscriberIdType {
  SIT_ADDRESS,
  SIT_DN,
  SIT_LOGIN_NAME,
  SIT_IF_NAME,
  SIT_IF_INDEX,
  SIT_PRIMARY_USER_NAME,
  SIT_ADDR_IF_NAME,
  SIT_TUNNEL_SESSION,
  SIT_SESSIONID,
  SIT_SESSION_HANDLE,
  SIT_GLOBAL_ADDRESS,
  SIT_GLOBAL_LOGIN_NAME
}
 Types of subscriber IDs. More...

Variables

const string DEFAULT_SESSION_NAME = "default"
 Constructor. Reserved session name.
const string MANUAL = "MANUAL"
 Constructor. Manual service activation trigger.
const string ACTIVATE_ON_LOGIN = "ACTIVATE_ON_LOGIN"
 Constructor. Automatic service activation trigger.


Typedef Documentation

typedef sequence<string> sae.StringSeq

A sequence of strings.

typedef sequence<wstring> sae.WStringSeq

Sequence of wide strings (unicode).

typedef sequence<Attr> sae.AttrSeq

List of attributes.

typedef sequence<AttrSeq> sae.AttrSeqSeq

List of attribute lists.

typedef sequence<ActionExt> sae.ActionExtSeq

List of actions to be scheduled.

Since:
4.1

typedef sequence<Action> sae.ActionSeq

List of actions.

Deprecated:
Use ActionExtSeq.

typedef sequence<long long> sae.LongLongSeq

64-bit integer value for list of eventDates.

typedef string sae.ScheduleEntryId

ID for a service schedule (ScheduleEntry).

typedef sequence<ScheduleEntryId> sae.ScheduleEntryIdSeq

Sequence of IDs for a service schedule.

typedef sequence<ScheduleEntry> sae.ScheduleEntrySeq

Sequence of entries for a service schedule.

typedef sequence<IdxPair> sae.IdxPairSeq

Sequence of indexes for subscriptions paired with services.

typedef sequence<DhcpAttribute> sae.DhcpAttributes

Sequence of DHCP attributes.

typedef sequence<Subscriber> sae.SubscriberSeq

Sequence of subscriber objects.

typedef sequence<Registration> sae.RegistrationSeq

Sequence of registration objects.

typedef sequence<wstring> sae.Arguments

List of script arguments.


Enumeration Type Documentation

enum sae::SAET

Types of exceptions for ServiceAuthenticationException.

Enumerator:
SAET_PUBLIC_IP_AUTHENTICATION  Authentication of a DHCP address failed.
SAET_MUTEX_GROUPS  A service mutex group prevented activation of the service.
SAET_SERVICE_AUTHORIZATION  Authorization of the service failed.
SAET_ANONYMOUS_USER  Anonymous user profile is not authorized to activate the service.
SAET_AUTH_PRECLUDES_ACTIVATE_ON_LOGIN  Service cannot be set to activate-on-login because it requires authentication.
SAET_INHERITED_SUBSCRIPTION  Inherited subscription cannot be modified.
SAET_SERVICE_UNAVAILABLE  Service is not available for activation.
SAET_SUBSCRIPTION_AUTHORIZATION  Authorization of the subscription failed.
SAET_ACTIVATE_ONLY  Service can only be activated.
SAET_INVISIBLE  Service is not visible to clients.
SAET_FILTERED_OUT  Service is not available for activation.
SAET_NO_SESSION_MODIFICATION  Session modification not permitted.
SAET_TRANSIENT_EXCEPTION  Transitory problem while activating, deactivating or modifying a service.
SAET_PERSISTENT_ACTIVATION  Failed to add persistent activation.
SAET_MODIFY_EXCEPTION  Problem while modifying a service.

enum sae::SubscriberIdType

Types of subscriber IDs.

Enumerator:
SIT_ADDRESS  Subscriber's IP address and timestamp (time of retrieval request based on an IP address.
SIT_DN  Distinguished name of subscriber profile.
SIT_LOGIN_NAME  Subscriber's login name.
SIT_IF_NAME  Name of interface and the name or virtual router to which the subscriber connects.
SIT_IF_INDEX  SNMP index of interface and the name of the virtual router to which the subscriber connects.
SIT_PRIMARY_USER_NAME  Primary username.
SIT_ADDR_IF_NAME  Subscriber's IP address, name of the managed interface, and name of the virtual router to which the subscriber connects.
SIT_TUNNEL_SESSION  Subscriber's L2TP tunnel session identification and name of the virtual router to which the subscriber connects.
SIT_SESSIONID  Subscriber's RADIUS session ID.
SIT_SESSION_HANDLE  Subscriber's session handle.
SIT_GLOBAL_ADDRESS  IP Address + VPN-ID.
SIT_GLOBAL_LOGIN_NAME  LoginName + VPN-ID.


Variable Documentation

const string sae.DEFAULT_SESSION_NAME = "default"

Constructor. Reserved session name.

const string sae.MANUAL = "MANUAL"

Constructor. Manual service activation trigger.

const string sae.ACTIVATE_ON_LOGIN = "ACTIVATE_ON_LOGIN"

Constructor. Automatic service activation trigger.


Generated on Wed May 8 13:28:16 2013 for SAE API by  doxygen 1.4.7