SAE access interface module. More...
import "sae.idl";Go to the source code of this file.
Classes | |
| struct | sae.Attr |
| Structure used for the name and values of an object attribute. More... | |
| struct | sae.TimeSpec |
| Structure used for the attributes of a time specification. More... | |
| struct | sae.ScheduledTime |
| Structure used for two time specifications for a service schedule. More... | |
| struct | sae.ActionExt |
| Structure used for service schedules that consist of actions that are performed at specified times. More... | |
| struct | sae.Action |
| Structure used for an action to be taken at a specified time. More... | |
| struct | sae.ScheduleEntry |
| Structure used for a service schedule. More... | |
| struct | sae.Select |
| Structure used to identify attributes and to filter information retrieved from service definitions and subscriptions. More... | |
| struct | sae.IdxPair |
| Structure used to hold a subscription index paired with a service index. More... | |
| struct | sae.ReadResult |
| Structure used to hold the result of a subscriber information request. More... | |
| exception | sae.UnknownUserException |
| Exception raised if a subscriber is not logged in to the subscriber session. More... | |
| exception | sae.NonUniqueUserException |
| Exception raised if there is more than one active subscriber session for the specified subscriber ID. More... | |
| exception | sae.UnknownServiceException |
| Exception raised if the requested service is not available. More... | |
| exception | sae.UnknownServiceSessionException |
| Exception raised if the requested service session does not exist. More... | |
| exception | sae.UnknownSubscriptionException |
| Exception raised if the requested subscription does not exist. More... | |
| exception | sae.SAEException |
| Exception raised if there is an unspecified error condition within the SAE. More... | |
| exception | sae.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 | sae.OverloadException |
| Exception raised if the SAE was overloaded at the time of the request and did not perform the requested operation. More... | |
| exception | sae.UnsupportedException |
| Exception raised if SAE does not support the requested operation. More... | |
| exception | sae.ServiceAuthenticationException |
| Exception raised if authentication for service activation failed. More... | |
| struct | sae.TimedAddress |
| Structure that encapsulates a subscriber's IP address and the timestamp of the request. More... | |
| struct | sae.InterfaceName |
| Structure used to hold the name of a managed interface and the name of virtual router on which the interface resides. More... | |
| struct | sae.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 | sae.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 | sae.TunnelSession |
| struct | sae.GlobalAddress |
| Globally unique IP address. More... | |
| struct | sae.GlobalLoginName |
| Globally unique Login Name. More... | |
| union | sae.SubscriberId |
| Structure to identify one or more active subscriber sessions in an SAE. More... | |
| struct | sae.DhcpAttribute |
| Structure that encapsulates DHCP profile data that is used to manipulate IP addresses assigned through DHCP. More... | |
| interface | sae.Subscriber |
| Interface that is used to manage an active subscriber session. More... | |
| struct | sae.Registration |
| Structure used for client device registration information for DHCP connections. More... | |
| interface | sae.SubscriberIterator |
| Interface that is used to iteratively retrieve subscriber objects that were not transmitted from a single API call to the SAE. More... | |
| interface | sae.SAEAccess |
| Interface to access the SAE core API. More... | |
Packages | |
| package | sae |
Service Activation Engine API. | |
Typedefs | |
| 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. | |
| typedef sequence< Action > | sae.ActionSeq |
| List of actions. | |
| 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. | |
Enumerations | |
| enum | sae.SAET { sae.SAET_PUBLIC_IP_AUTHENTICATION, sae.SAET_MUTEX_GROUPS, sae.SAET_SERVICE_AUTHORIZATION, sae.SAET_ANONYMOUS_USER, sae.SAET_AUTH_PRECLUDES_ACTIVATE_ON_LOGIN, sae.SAET_INHERITED_SUBSCRIPTION, sae.SAET_SERVICE_UNAVAILABLE, sae.SAET_SUBSCRIPTION_AUTHORIZATION, sae.SAET_ACTIVATE_ONLY, sae.SAET_INVISIBLE, sae.SAET_FILTERED_OUT, sae.SAET_NO_SESSION_MODIFICATION, sae.SAET_TRANSIENT_EXCEPTION, sae.SAET_PERSISTENT_ACTIVATION, sae.SAET_MODIFY_EXCEPTION } |
Types of exceptions for ServiceAuthenticationException. More... | |
| enum | sae.SubscriberIdType { sae.SIT_ADDRESS, sae.SIT_DN, sae.SIT_LOGIN_NAME, sae.SIT_IF_NAME, sae.SIT_IF_INDEX, sae.SIT_PRIMARY_USER_NAME, sae.SIT_ADDR_IF_NAME, sae.SIT_TUNNEL_SESSION, sae.SIT_SESSIONID, sae.SIT_SESSION_HANDLE, sae.SIT_GLOBAL_ADDRESS, sae.SIT_GLOBAL_LOGIN_NAME } |
Types of subscriber IDs. More... | |
Variables | |
| 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. | |
SAE access interface module.
This module defines a remote interface to the SAE core API. You can use this module to access the SAE from external applications.
1.6.1