sae.Subscriber Interface Reference

import "saeaccess.idl";

List of all members.


Detailed Description

Interface that is used to manage an active subscriber session.

Lets you get information about the session, make service schedules available, add and remove subscriptions, set the session timeout, manage session login, and activate and deactivate services.

NOTE: All methods raise an UnknownUserException if the subscriber session is no longer active.


Public Member Functions

ReadResult read (in Select subscription, in Select service, in StringSeq attributes) raises (SAEException, UnknownUserException, NonUniqueUserException)
 The read() method requests information from a subscriber session.
AttrSeq readSubscriber (in StringSeq attributes) raises (SAEException, UnknownUserException, NonUniqueUserException)
 The readSubscriber() method retrieves specified subscriber attributes from the directory.
AttrSeqSeq readSubscription (in Select selection) raises (SAEException, UnknownUserException, NonUniqueUserException)
 The readSubscription() method retrieves specified subscription data from the directory.
AttrSeqSeq readService (in Select selection) raises (SAEException, UnknownUserException, NonUniqueUserException)
 The readService() method retrieves service data.
void addScheduleEntry (in ScheduleEntryId id, in ScheduledTime schedTime, in ActionExtSeq actions) raises (UnknownUserException, SAEException)
 The addScheduleEntry() method creates a service schedule for activating, deactivating, or denying a service.
void updateScheduleEntry (in ScheduleEntryId id, in ScheduledTime schedTime, in ActionExtSeq actions) raises (UnknownUserException, SAEException)
 The updateScheduleEntry() method updates the scheduled times and actions for a service schedule that has a specified ID.
void deleteScheduleEntry (in ScheduleEntryId id) raises (UnknownUserException, SAEException)
 The deleteScheduleEntry() method deletes a service schedule that has a specified ID.
ScheduleEntry getScheduleEntryById (in ScheduleEntryId id) raises (UnknownUserException, SAEException)
 The getScheduleEntryById() method retrieves a service schedule that has a specified ID.
ScheduleEntrySeq getScheduleEntriesByIds (in ScheduleEntryIdSeq ids) raises (UnknownUserException, SAEException)
 The getScheduleEntriesByIds() method retrieves schedule entries (ScheduleEntry) by their IDs.
ScheduleEntryIdSeq getScheduleEntryIds (in long long startDate, in long long endDate) raises (UnknownUserException, SAEException)
 The getScheduleEntryIds() method retrieves IDs within a specified range for schedule entries (ScheduleEntry).
void addOneTimeScheduleEntry (in long long eventDate, in ActionSeq actions) raises (UnknownUserException, SAEException)
 The addOneTimeScheduleEntry() method adds a service action scheduled for a single time.
void updateOneTimeScheduleEntryActions (in long long eventDate, in ActionSeq actions) raises (UnknownUserException, SAEException)
 The updateOneTimeScheduleEntryActions() method updates a service action scheduled for a single time.
void deleteOneTimeScheduleEntries (in long long startDate, in long long endDate) raises (UnknownUserException, SAEException)
 The deleteOneTimeScheduleEntries() method deletes service actions that are scheduled for a single time and whose scheduling date falls within a specified range.
ActionSeq getOneTimeScheduleEntryActions (in long long eventDate) raises (UnknownUserException, SAEException)
 The getOneTimeScheduleEntryActions() method retrieves a service action scheduled for a single time.
LongLongSeq getOneTimeScheduleEntryEventDates (in long long startDate, in long long endDate) raises (UnknownUserException, SAEException)
 The getOneTimeScheduleEntryEventDates() method retrieves schedule information for a service action that is scheduled for a single time and whose scheduling dates fall within a specified range.
WStringSeq addSubscriptionAttributes (in string subscriptionName, in string userName, in string password, in AttrSeq subscriptionAttributes) raises (UnknownUserException, NonUniqueUserException, UnknownServiceException, ServiceAuthenticationException, SAEException)
 The addSubscriptionAttributes() method adds a subscription to a service to the directory.
WStringSeq addSubscription (in string subscriptionName, in string userName, in string password) raises (UnknownUserException, NonUniqueUserException, UnknownServiceException, ServiceAuthenticationException, SAEException)
 The addSubscription() method adds a subscription to a service to the directory.
WStringSeq deleteSubscription (in string subscriptionName, in string userName, in string password) raises (UnknownUserException, NonUniqueUserException, UnknownServiceException, UnknownSubscriptionException, ServiceAuthenticationException, SAEException)
 The deleteSubscription() method removes a subscription to a service from the directory.
void setSessionTimeout (in unsigned long timeout) raises (UnknownUserException, NonUniqueUserException, SAEException)
 The setSessionTimeout() method specifies the number of seconds after which the subscriber session is automatically deactivated.
void updateSessionTimeout (in unsigned long timeout) raises (UnknownUserException, NonUniqueUserException, SAEException)
 The updateSessionTimeout() method updates the session timeout for the current subscriber.
void updateServiceSessionTimeout (in string subscriptionName, in string sessionName, in unsigned long timeout) raises (UnknownUserException, NonUniqueUserException, UnknownServiceException, UnknownSubscriptionException, SAEException)
 The updateServiceSessionTimeout() method updates the timeout of the service session for the specified session.
boolean login (in string loginName, in string password) raises (LoginException, SAEException)
 The login() method creates a subscriber session.
void logout () raises (UnknownUserException, SAEException)
 The logout() method ends the current subscriber session and starts an unauthenticated subscriber session.
void disconnect () raises (UnknownUserException, NonUniqueUserException, UnsupportedException, SAEException)
 The disconnect() method triggers subscriber being detached from the network.
void grantPublicIp (in string loginName, in string password) raises (UnknownUserException, ServiceAuthenticationException, SAEException)
 The grantPublicIp() method switches the IP address of a subscriber using DHCP from an unauthenticated IP address to an authenticated IP address.
void grantPublicIpAttr (in string loginName, in string password, in DhcpAttributes attr) raises (UnknownUserException, ServiceAuthenticationException, SAEException)
 The grantPublicIpAttr() method switches the IP address of a subscriber using DHCP from an unauthenticated IP address to an authenticated IP address.
void revokePublicIp () raises (UnknownUserException, SAEException)
 The revokePublicIp() method switches the IP address of subscriber using a DHCP connection from an authenticated IP address to an unauthenticated IP address.
void activateService (in string subscriptionName, in string sessionName, in AttrSeq activationAttributes) raises (UnknownUserException, NonUniqueUserException, UnknownServiceException, UnknownSubscriptionException, ServiceAuthenticationException, OverloadException, SAEException)
 The activateService() method activates a service session.
string activateServiceSession (in string subscriptionName, in string sessionName, in AttrSeq activationAttributes) raises (UnknownUserException, NonUniqueUserException, UnknownServiceException, UnknownSubscriptionException, ServiceAuthenticationException, OverloadException, SAEException)
 The activateServiceSession() method activates a service session and returns its correspondent accounting session ID.
void activateServiceBackground (in string subscriptionName, in string sessionName, in AttrSeq activationAttributes) raises (UnknownUserException, NonUniqueUserException, UnknownServiceException, UnknownSubscriptionException, ServiceAuthenticationException, OverloadException, SAEException)
 The activateServiceBackground() method activates a service session and, if service activation fails due to a short-lived problem, schedules that activation be attempted again in the background.
void modifyServiceSession (in string subscriptionName, in string sessionName, in AttrSeq activationAttributes) raises (UnknownUserException, NonUniqueUserException, UnknownServiceException, UnknownSubscriptionException, UnknownServiceSessionException, ServiceAuthenticationException, OverloadException, SAEException)
 The modifyServiceSession() method modifies an active service session.
void startModifyFragmentSession (in string subscriptionName, in string sessionName, in AttrSeq activationAttributes) raises (UnknownUserException, NonUniqueUserException, UnknownServiceException, UnknownSubscriptionException, UnknownServiceSessionException, ServiceAuthenticationException, SAEException)
 NOTE: The startModifyFragmentSession() method is only for internal use.
void finishModifyFragmentSession (in string subscriptionName, in string sessionName, in AttrSeq activationAttributes) raises (UnknownUserException, NonUniqueUserException, UnknownServiceException, UnknownSubscriptionException, UnknownServiceSessionException, ServiceAuthenticationException, OverloadException, SAEException)
 NOTE: The finishModifyFragmentSession() method is only for internal use.
void undoModifyFragmentSession (in string subscriptionName, in string sessionName, in AttrSeq activationAttributes) raises (UnknownUserException, NonUniqueUserException, UnknownServiceException, UnknownSubscriptionException, UnknownServiceSessionException, ServiceAuthenticationException, OverloadException, SAEException)
 NOTE: The undoModifyFragmentSession() method is only for internal use.
void deactivateService (in string subscriptionName, in string sessionName) raises (UnknownUserException, NonUniqueUserException, UnknownServiceException, UnknownSubscriptionException, ServiceAuthenticationException, SAEException)
 The deactivateService() method deactivates a service session for a subscription.
void deactivateServiceBackground (in string subscriptionName, in string sessionName) raises (UnknownUserException, NonUniqueUserException, UnknownServiceException, UnknownSubscriptionException, ServiceAuthenticationException, SAEException)
 The deactivateServiceBackground() method deactivates a service session and, if deactivation fails due to a short-lived problem, schedules that deactivation be attempted again in the background.
void deactivateServiceReason (in string subscriptionName, in string sessionName, in long reason) raises (UnknownUserException, NonUniqueUserException, UnknownServiceException, UnknownSubscriptionException, ServiceAuthenticationException, SAEException)
 The deactivateServiceReason() method deactivates a service session for a subscription and provides a reason for the deactivation.
void deactivateServiceBackgroundReason (in string subscriptionName, in string sessionName, in long reason) raises (UnknownUserException, NonUniqueUserException, UnknownServiceException, UnknownSubscriptionException, ServiceAuthenticationException, SAEException)
 The deactivateServiceBackgroundReason() method deactivates a service session and if deactivation fails due to a short-lived problem, schedules that deactivation be attempted again in the background.
void fragmentDown (in string aggregateSubscriptionName, in string aggregateSessionName, in string fragmentSessionId) raises (UnknownUserException, NonUniqueUserException, UnknownServiceException, UnknownSubscriptionException, UnknownServiceSessionException, SAEException)
 NOTE: The fragmentDown() method is only for internal use.
void fragmentReactivating (in string aggregateSubscriptionName, in string aggregateSessionName, in string fragmentSessionId) raises (UnknownUserException, NonUniqueUserException, UnknownServiceException, UnknownSubscriptionException, UnknownServiceSessionException, SAEException)
 NOTE: The fragmentReactivating() method is only for internal use.
void setActivationTrigger (in string subscriptionName, in string activationTrigger) raises (UnknownUserException, NonUniqueUserException, UnknownServiceException, UnknownSubscriptionException, ServiceAuthenticationException, SAEException)
 The setActivationTrigger() method changes how a subscription for a service becomes active.
void setPersistentSession (in string subscriptionName, in string sessionName, in AttrSeq persistentSessionAttributes) raises (UnknownUserException, NonUniqueUserException, UnknownServiceException, SAEException)
 The setPersistentSession() method identifies a service subscription that is to start automatically at subscriber login (which creates a service session).
void deletePersistentSession (in string subscriptionName, in string sessionName) raises (UnknownUserException, NonUniqueUserException, UnknownServiceException, SAEException)
 The deletePersistentSession() method deletes a service subscription that automatically starts at subscriber login.
void modifyPersistentSession (in string subscriptionName, in string sessionName, in boolean active) raises (UnknownUserException, NonUniqueUserException, UnknownServiceException, SAEException)
 The modifyPersistentSession() method modifies a service subscription that automatically starts at subscriber login.
void setInterimTime (in string subscriptionName, in string sessionName, in unsigned long time) raises (UnknownUserException, NonUniqueUserException, UnknownServiceException, SAEException)
 The setInterimTime() method sets the interval of the interim update for a service session.
void setSessionVolumeQuota (in string subscriptionName, in string sessionName, in string sessionVolumeQuota) raises (UnknownUserException, NonUniqueUserException, UnknownServiceException, SAEException)
 The setSessionVolumeQuota() method sets the volume quota for the session.
AttrSeqSeq getUsage (in Select selection) raises (SAEException, UnknownUserException, NonUniqueUserException, OverloadException)
 The getUsage() method retrieves usage information for selected service sessions.
void setProperty (in string aProperty) raises (SAEException, UnknownUserException, NonUniqueUserException)
 The setProperty() method sets the property attribute of the subscriber session.


Member Function Documentation

void sae.Subscriber.activateService ( in string  subscriptionName,
in string  sessionName,
in AttrSeq  activationAttributes 
) raises (UnknownUserException, NonUniqueUserException, UnknownServiceException, UnknownSubscriptionException, ServiceAuthenticationException, OverloadException, SAEException)

The activateService() method activates a service session.

To authorize the activation, the SAE sends a plug-in event to all authorization plug-ins that are configured for the service to be activated. A start message informs tracking plug-ins of the service activation.

Parameters:
[in] subscriptionName Name of the subscription in the directory.
[in] sessionName ID for the service session to be started. If sessionName is an empty string, the SAE uses the value sae.DEFAULT_SESSION_NAME instead.
[in] activationAttributes List of attribute values to be used when the session is activated. Attributes are listed in a sequence of sae.Attr structures as property=values pairs.
Exceptions:
UnknownUserException Raised if the subscriber is not logged in to a subscriber session.
NonUniqueUserException Raised if there is more than one active subscriber session for the specified subscriber ID.
UnknownServiceException Raised if the service is not available.
UnknownSubscriptionException Raised if the subscription does not exist.
ServiceAuthenticationException Raised if authentication for service activation fails.
OverloadException Raised if the SAE is overloaded at the time of the request and does not perform the requested operation.
SAEException Raised if there is an unspecified error condition within the SAE.

void sae.Subscriber.activateServiceBackground ( in string  subscriptionName,
in string  sessionName,
in AttrSeq  activationAttributes 
) raises (UnknownUserException, NonUniqueUserException, UnknownServiceException, UnknownSubscriptionException, ServiceAuthenticationException, OverloadException, SAEException)

The activateServiceBackground() method activates a service session and, if service activation fails due to a short-lived problem, schedules that activation be attempted again in the background.

Parameters:
[in] subscriptionName Name of the subscription.
[in] sessionName Name of the service session. If sessionName is empty, uses the default service session.
[in] activationAttributes List of attributes to be used during activation.
Exceptions:
UnknownUserException Raised if the subscriber is not logged in to a subscriber session.
NonUniqueUserException Raised if there is more than one active subscriber session for the specified subscriber ID.
UnknownServiceException Raised if the service is not available.
UnknownSubscriptionException Raised if the subscription does not exist.
SAEException Raised if there is an unspecified error condition within the SAE.
Deprecated:
In Io Use activateServiceSession

string sae.Subscriber.activateServiceSession ( in string  subscriptionName,
in string  sessionName,
in AttrSeq  activationAttributes 
) raises (UnknownUserException, NonUniqueUserException, UnknownServiceException, UnknownSubscriptionException, ServiceAuthenticationException, OverloadException, SAEException)

The activateServiceSession() method activates a service session and returns its correspondent accounting session ID.

To authorize the activation, the SAE sends a plug-in event to all authorization plug-ins that are configured for the service to be activated. A start message informs tracking plug-ins of the service activation.

Parameters:
[in] subscriptionName Name of the subscription in the directory.
[in] sessionName ID for the service session to be started. If sessionName is an empty string, the SAE uses the value sae.DEFAULT_SESSION_NAME instead.
[in] activationAttributes List of attribute values to be used when the session is activated. Attributes are listed in a sequence of sae.Attr structures as property=values pairs.
Returns:
The accounting session ID from the service session.
Exceptions:
UnknownUserException Raised if the subscriber is not logged in to a subscriber session.
NonUniqueUserException Raised if there is more than one active subscriber session for the specified subscriber ID.
UnknownServiceException Raised if the service is not available.
UnknownSubscriptionException Raised if the subscription does not exist.
ServiceAuthenticationException Raised if authentication for service activation fails.
OverloadException Raised if the SAE is overloaded at the time of the request and does not perform the requested operation.
SAEException Raised if there is an unspecified error condition within the SAE.
Since:
Io

void sae.Subscriber.addOneTimeScheduleEntry ( in long long  eventDate,
in ActionSeq  actions 
) raises (UnknownUserException, SAEException)

The addOneTimeScheduleEntry() method adds a service action scheduled for a single time.

Parameters:
[in] eventDate Time in msec since 1970-01-01.
[in] actions Service actions to be taken at the scheduled time.
Exceptions:
UnknownUserException Raised if the subscriber is not logged in to a subscriber session.
SAEException Raised if there is an unspecified error condition within the SAE.
Since:
4.0
Deprecated:
In 4.1.

void sae.Subscriber.addScheduleEntry ( in ScheduleEntryId  id,
in ScheduledTime  schedTime,
in ActionExtSeq  actions 
) raises (UnknownUserException, SAEException)

The addScheduleEntry() method creates a service schedule for activating, deactivating, or denying a service.

Parameters:
[in] id ID of the service schedule entry in the directory.
[in] schedTime Scheduled time for the action(s) to be taken.
[in] actions Service action(s) to be taken at a scheduled time.
Exceptions:
UnknownUserException Raised if the subscriber is not logged in to a subscriber session.
SAEException Raised if there is an unspecified error condition within the SAE.
Since:
4.1

WStringSeq sae.Subscriber.addSubscription ( in string  subscriptionName,
in string  userName,
in string  password 
) raises (UnknownUserException, NonUniqueUserException, UnknownServiceException, ServiceAuthenticationException, SAEException)

The addSubscription() method adds a subscription to a service to the directory.

Parameters:
[in] subscriptionName Name of the service for the subscription in the directory. A subscriptionName has the form "<serviceName>[%<subscriptionId>]".
[in] userName (Optional) Username of a subscriber for authorization to use the subscription.
[in] password (Optional) Password associated with the username for authorization to use the subscription.
Returns:
List of reply messages from the authorization plug-in.
Exceptions:
UnknownUserException Raised if the subscriber is not logged in to a subscriber session.
NonUniqueUserException Raised if there is more than one active subscriber session for the specified subscriber ID.
UnknownServiceException Raised if the service is not available.
ServiceAuthenticationException Raised if authentication for service activation fails.
SAEException Raised if there is an unspecified error condition within the SAE.

WStringSeq sae.Subscriber.addSubscriptionAttributes ( in string  subscriptionName,
in string  userName,
in string  password,
in AttrSeq  subscriptionAttributes 
) raises (UnknownUserException, NonUniqueUserException, UnknownServiceException, ServiceAuthenticationException, SAEException)

The addSubscriptionAttributes() method adds a subscription to a service to the directory.

Parameters:
[in] subscriptionName Name of the service for the subscription in the directory. A subscriptionName has the form "<serviceName>[%<subscriptionId>]".
[in] userName (Optional) Username of a subscriber for authorization to use the subscription.
[in] password (Optional) Password associated with the username for authorization to use the subscription.
[in] subscriptionAttributes 
Returns:
List of reply messages from the authorization plug-in.
Exceptions:
UnknownUserException Raised if the subscriber is not logged in to a subscriber session.
NonUniqueUserException Raised if there is more than one active subscriber session for the specified subscriber ID.
UnknownServiceException Raised if the service is not available.
ServiceAuthenticationException Raised if authentication for service activation fails.
SAEException Raised if there is an unspecified error condition within the SAE.

void sae.Subscriber.deactivateService ( in string  subscriptionName,
in string  sessionName 
) raises (UnknownUserException, NonUniqueUserException, UnknownServiceException, UnknownSubscriptionException, ServiceAuthenticationException, SAEException)

The deactivateService() method deactivates a service session for a subscription.

Parameters:
[in] subscriptionName Name of the subscription in the directory.
[in] sessionName ID for the service session. An empty string identifies the default service session.
Exceptions:
UnknownUserException Raised if the subscriber is not logged in to a subscriber session.
NonUniqueUserException Raised if there is more than one active subscriber session for the specified subscriber ID.
UnknownServiceException Raised if the service is not available.
UnknownSubscriptionException Raised if the subscription does not exist.
ServiceAuthenticationException Raised if authentication for service activation fails.
SAEException Raised if there is an unspecified error condition within the SAE.

void sae.Subscriber.deactivateServiceBackground ( in string  subscriptionName,
in string  sessionName 
) raises (UnknownUserException, NonUniqueUserException, UnknownServiceException, UnknownSubscriptionException, ServiceAuthenticationException, SAEException)

The deactivateServiceBackground() method deactivates a service session and, if deactivation fails due to a short-lived problem, schedules that deactivation be attempted again in the background.

Parameters:
[in] subscriptionName Name of the subscription.
[in] sessionName Name of the service session. If sessionName is empty, uses the default service session.
Exceptions:
UnknownUserException Raised if the subscriber is not logged in to a subscriber session.
NonUniqueUserException Raised if there is more than one active subscriber session for the specified subscriber ID.
UnknownServiceException Raised if the service is not available.
UnknownSubscriptionException Raised if the subscription does not exist.
ServiceAuthenticationException Raised if authentication for service activation fails.
SAEException Raised if there is an unspecified error condition within the SAE.

void sae.Subscriber.deactivateServiceBackgroundReason ( in string  subscriptionName,
in string  sessionName,
in long  reason 
) raises (UnknownUserException, NonUniqueUserException, UnknownServiceException, UnknownSubscriptionException, ServiceAuthenticationException, SAEException)

The deactivateServiceBackgroundReason() method deactivates a service session and if deactivation fails due to a short-lived problem, schedules that deactivation be attempted again in the background.

The method also provides a reason for the deactivation.

Parameters:
[in] subscriptionName Name of the subscription in the directory.
[in] sessionName ID for the service session. If sessionName is empty, the default service session is used.
[in] reason Reason for deactivating the session. This value is available for accounting stop records.
Exceptions:
UnknownUserException Raised if the subscriber is not logged in to a subscriber session.
NonUniqueUserException Raised if there is more than one active subscriber session for the specified subscriber ID.
UnknownServiceException Raised if the service is not available.
UnknownSubscriptionException Raised if the subscription does not exist.
ServiceAuthenticationException Raised if trying to deactivate a subscription to an activate-only service, or if the subscription is filtered by a RADIUS authentication plug-in.
SAEException Raised if there is an unspecified error condition within the SAE.

void sae.Subscriber.deactivateServiceReason ( in string  subscriptionName,
in string  sessionName,
in long  reason 
) raises (UnknownUserException, NonUniqueUserException, UnknownServiceException, UnknownSubscriptionException, ServiceAuthenticationException, SAEException)

The deactivateServiceReason() method deactivates a service session for a subscription and provides a reason for the deactivation.

Parameters:
[in] subscriptionName Name of the subscription in the directory.
[in] sessionName ID for the service session. If sessionName is empty, the default service session is used.
[in] reason Reason for deactivating the session. This value is available for accounting stop records.
Exceptions:
UnknownUserException Raised if the subscriber is not logged in to a subscriber session.
NonUniqueUserException Raised if there is more than one active subscriber session for the specified subscriber ID.
UnknownServiceException Raised if the service is not available.
UnknownSubscriptionException Raised if the subscription does not exist.
ServiceAuthenticationException Raised if trying to deactivate a subscription to an activate-only service, if the subscription is filtered by a RADIUS authentication plug-in, or if a short-lived problem happened while deactivating the subscription.
SAEException Raised if there is an unspecified error condition within the SAE.

void sae.Subscriber.deleteOneTimeScheduleEntries ( in long long  startDate,
in long long  endDate 
) raises (UnknownUserException, SAEException)

The deleteOneTimeScheduleEntries() method deletes service actions that are scheduled for a single time and whose scheduling date falls within a specified range.

Parameters:
[in] startDate Time in msec since 1970-01-01.
[in] endDate Time in msec since 1970-01-01.
Exceptions:
UnknownUserException Raised if the subscriber is not logged in to a subscriber session.
SAEException Raised if there is an unspecified error condition within the SAE.
Since:
4.0
Deprecated:
In 4.1.

void sae.Subscriber.deletePersistentSession ( in string  subscriptionName,
in string  sessionName 
) raises (UnknownUserException, NonUniqueUserException, UnknownServiceException, SAEException)

The deletePersistentSession() method deletes a service subscription that automatically starts at subscriber login.

As a result, the subscriber session for the service is not automatically activated at the next subscriber login.

Parameters:
[in] subscriptionName Name of the subscription in the directory.
[in] sessionName ID for the service session. An empty string identifies the default service session.
Exceptions:
UnknownUserException Raised if the subscriber is not logged in to a subscriber session.
NonUniqueUserException Raised if there is more than one active subscriber session for the specified subscriber ID.
UnknownServiceException Raised if the service is not available.
SAEException Raised if there is an unspecified error condition within the SAE.

void sae.Subscriber.deleteScheduleEntry ( in ScheduleEntryId  id  )  raises (UnknownUserException, SAEException)

The deleteScheduleEntry() method deletes a service schedule that has a specified ID.

Parameters:
[in] id ID of the service schedule entry in the directory.
Exceptions:
UnknownUserException Raised if the subscriber is not logged in to a subscriber session.
SAEException Raised if there is an unspecified error condition within the SAE/
Since:
4.1

WStringSeq sae.Subscriber.deleteSubscription ( in string  subscriptionName,
in string  userName,
in string  password 
) raises (UnknownUserException, NonUniqueUserException, UnknownServiceException, UnknownSubscriptionException, ServiceAuthenticationException, SAEException)

The deleteSubscription() method removes a subscription to a service from the directory.

Parameters:
[in] subscriptionName Name of the subscription in the directory.
[in] userName (Optional) Username for authorization to use the subscription.
[in] password (Optional) Password associated with the user name for authorization of the subscription.
Returns:
List of reply messages from the authorization plug-in.
Exceptions:
UnknownUserException Raised if the subscriber is not logged in to a subscriber session.
NonUniqueUserException Raised if there is more than one active subscriber session for the specified subscriber ID.
UnknownServiceException Raised if the service is not available.
UnknownSubscriptionException Raised if the subscription does not exist.
ServiceAuthenticationException Raised if authentication for service activation fails.
SAEException Raised if there is an unspecified error condition within the SAE.

void sae.Subscriber.disconnect (  )  raises (UnknownUserException, NonUniqueUserException, UnsupportedException, SAEException)

The disconnect() method triggers subscriber being detached from the network.

Exceptions:
UnknownUserException Raised if the subscriber is not logged in to a subscriber session.
NonUniqueUserException Raised if there is more than one active subscriber session for the specified subscriber ID.
UnsupportedException Raised if disconnect operation is not supported.
SAEException Raised if there is an unspecified error condition within the SAE.

void sae.Subscriber.finishModifyFragmentSession ( in string  subscriptionName,
in string  sessionName,
in AttrSeq  activationAttributes 
) raises (UnknownUserException, NonUniqueUserException, UnknownServiceException, UnknownSubscriptionException, UnknownServiceSessionException, ServiceAuthenticationException, OverloadException, SAEException)

NOTE: The finishModifyFragmentSession() method is only for internal use.

void sae.Subscriber.fragmentDown ( in string  aggregateSubscriptionName,
in string  aggregateSessionName,
in string  fragmentSessionId 
) raises (UnknownUserException, NonUniqueUserException, UnknownServiceException, UnknownSubscriptionException, UnknownServiceSessionException, SAEException)

NOTE: The fragmentDown() method is only for internal use.

void sae.Subscriber.fragmentReactivating ( in string  aggregateSubscriptionName,
in string  aggregateSessionName,
in string  fragmentSessionId 
) raises (UnknownUserException, NonUniqueUserException, UnknownServiceException, UnknownSubscriptionException, UnknownServiceSessionException, SAEException)

NOTE: The fragmentReactivating() method is only for internal use.

ActionSeq sae.Subscriber.getOneTimeScheduleEntryActions ( in long long  eventDate  )  raises (UnknownUserException, SAEException)

The getOneTimeScheduleEntryActions() method retrieves a service action scheduled for a single time.

Parameters:
[in] eventDate Time in msec since 1970-01-01.
Returns:
Sequence of actions specified for the schedule.
Exceptions:
UnknownUserException Raised if the subscriber is not logged in to a subscriber session.
SAEException Raised if there is an unspecified error condition within the SAE.
Since:
4.0
Deprecated:
In 4.1.

LongLongSeq sae.Subscriber.getOneTimeScheduleEntryEventDates ( in long long  startDate,
in long long  endDate 
) raises (UnknownUserException, SAEException)

The getOneTimeScheduleEntryEventDates() method retrieves schedule information for a service action that is scheduled for a single time and whose scheduling dates fall within a specified range.

Parameters:
[in] startDate Time in msec since 1970-01-01.
[in] endDate Time in msec since 1970-01-01.
Returns:
List of dates.
Exceptions:
UnknownUserException Raised if the subscriber is not logged in to a subscriber session.
SAEException Raised if there is an unspecified error condition within the SAE.
Since:
4.0
Deprecated:
In 4.1.

ScheduleEntrySeq sae.Subscriber.getScheduleEntriesByIds ( in ScheduleEntryIdSeq  ids  )  raises (UnknownUserException, SAEException)

The getScheduleEntriesByIds() method retrieves schedule entries (ScheduleEntry) by their IDs.

An ID for a ScheduleEntry is the primary key for the specified subscriber.

Parameters:
[in] ids Sequence of IDs of the service schedule entries in the directory.
Returns:
List of schedule entries.
Exceptions:
UnknownUserException Raised if the subscriber is not logged in to a subscriber session.
SAEException Raised if there is an unspecified error condition within the SAE.
Since:
4.1

ScheduleEntry sae.Subscriber.getScheduleEntryById ( in ScheduleEntryId  id  )  raises (UnknownUserException, SAEException)

The getScheduleEntryById() method retrieves a service schedule that has a specified ID.

An ID for the ScheduleEntry is the primary key for a specified subscriber.

Parameters:
[in] id ID of the service schedule entry in the directory.
Returns:
A service schedule entry.
Exceptions:
UnknownUserException Raised if the subscriber is not logged in to a subscriber session.
SAEException Raised if there is an unspecified error condition within the SAE.
Since:
4.1

ScheduleEntryIdSeq sae.Subscriber.getScheduleEntryIds ( in long long  startDate,
in long long  endDate 
) raises (UnknownUserException, SAEException)

The getScheduleEntryIds() method retrieves IDs within a specified range for schedule entries (ScheduleEntry).

Parameters:
[in] startDate Time in msec since 1970-01-01.
[in] endDate Time in msec since 1970-01-01.
Returns:
List of IDs associated with a service schedule entry in the directory.
Exceptions:
UnknownUserException Raised if the subscriber is not logged in to a subscriber session.
SAEException Raised if there is an unspecified error condition within the SAE.
Since:
4.1

AttrSeqSeq sae.Subscriber.getUsage ( in Select  selection  )  raises (SAEException, UnknownUserException, NonUniqueUserException, OverloadException)

The getUsage() method retrieves usage information for selected service sessions.

Usage information can include the length of time that a service has been active and the traffic statistics for a subscriber session. This method lets you develop applications that can dynamically retrieve usage information for active service sessions.

You can use the Subscriber.readSubscription() method to retrieve the most recent usage information that has been collected. You can also collect usage information by using interim accounting.

NOTE: In response to this method, the SAE reads the current usage data from the router. Because this method causes direct interaction with the router, numerous calls can overload the router and cause service degradation.

Parameters:
[in] selection Selects usage data to retrieve.
Exceptions:
UnknownUserException Raised if the subscriber is not logged in to a subscriber session.
NonUniqueUserException Raised if there is more than one active subscriber session for the specified subscriber ID.
UnknownServiceException Raised if the service is not available.
SAEException Raised if there is an unspecified error condition within the SAE.
OverloadException Raised if the SAE is overloaded at the time of the request and does not perform the requested operation.

void sae.Subscriber.grantPublicIp ( in string  loginName,
in string  password 
) raises (UnknownUserException, ServiceAuthenticationException, SAEException)

The grantPublicIp() method switches the IP address of a subscriber using DHCP from an unauthenticated IP address to an authenticated IP address.

When the operation succeeds, the subscriber object that was in place before the operation becomes invalid, that is the client application of the CORBA remote API can no longer call any methods on this object. The client application must call the getSubscriber() method to request a new subscriber object.

Parameters:
[in] loginName Subscriber's login name.
[in] password Subscriber's password associated with the login name.
Exceptions:
UnknownUserException Raised if the subscriber is not logged in to a subscriber session.
ServiceAuthenticationException Raised if authentication for service activation fails.
SAEException Raised if there is an unspecified error condition within the SAE.

void sae.Subscriber.grantPublicIpAttr ( in string  loginName,
in string  password,
in DhcpAttributes  attr 
) raises (UnknownUserException, ServiceAuthenticationException, SAEException)

The grantPublicIpAttr() method switches the IP address of a subscriber using DHCP from an unauthenticated IP address to an authenticated IP address.

This method requires DHCP attributes in addition to the options required by the grantPublicIp() method.

NOTE: If the operation is successful, the current subscriber object becomes invalid.

Parameters:
[in] loginName Subscriber's login name.
[in] password Subscriber's password associated with the login name.
[in] attr Value of string name for Attr.
Exceptions:
UnknownUserException Raised if the subscriber is not logged in to a subscriber session.
ServiceAuthenticationException Raised if authentication for service activation fails.
SAEException Raised if there is an unspecified error condition within the SAE.

boolean sae.Subscriber.login ( in string  loginName,
in string  password 
) raises (LoginException, SAEException)

The login() method creates a subscriber session.

When the operation succeeds, the subscriber object that was in place before the operation becomes invalid, that is the client application of the CORBA remote API can no longer call any methods on this object. The client application must call the getSubscriber() method to request a new subscriber object.

Parameters:
[in] loginName Subscriber's login name.
[in] password Subscriber's password associated with the login name.
Returns:
false. NOTE: The return value has not been used since version 4.2.
Exceptions:
LoginException Raised if a subscriber login to a subscriber session fails.
SAEException Raised if there is an unspecified error condition within the SAE.

void sae.Subscriber.logout (  )  raises (UnknownUserException, SAEException)

The logout() method ends the current subscriber session and starts an unauthenticated subscriber session.

When the operation succeeds, the subscriber object that was in place before the operation becomes invalid, that is the client application of the CORBA remote API can no longer call any methods on this object. The client application must call the getSubscriber() method to request a new subscriber object.

Exceptions:
UnknownUserException Raised if the subscriber is not logged in to a subscriber session.
SAEException Raised if there is an unspecified error condition within the SAE.

void sae.Subscriber.modifyPersistentSession ( in string  subscriptionName,
in string  sessionName,
in boolean  active 
) raises (UnknownUserException, NonUniqueUserException, UnknownServiceException, SAEException)

The modifyPersistentSession() method modifies a service subscription that automatically starts at subscriber login.

Parameters:
[in] subscriptionName Name of the subscription.
[in] sessionName ID for the service session. An empty string identifies the default service session.
[in] active If true, automatically activates the service session.
Exceptions:
UnknownUserException Raised if the subscriber is not logged in to a subscriber session.
NonUniqueUserException Raised if there is more than one active subscriber session for the specified subscriber ID.
UnknownServiceException Raised if the service is not available.
SAEException Raised if there is an unspecified error condition within the SAE.

void sae.Subscriber.modifyServiceSession ( in string  subscriptionName,
in string  sessionName,
in AttrSeq  activationAttributes 
) raises (UnknownUserException, NonUniqueUserException, UnknownServiceException, UnknownSubscriptionException, UnknownServiceSessionException, ServiceAuthenticationException, OverloadException, SAEException)

The modifyServiceSession() method modifies an active service session.

To authorize the modification, the SAE sends a plug-in event to all authorization plug-ins that are configured for the service to be modified. For example, an increase in bandwidth could require authorization by an Admission Control Plug-In application. An interim update message informs tracking plug-ins of modifications.

Parameters:
[in] subscriptionName Name of the subscription the directory.
[in] sessionName ID for the service session to be modified. An empty string identifies the default service session.
[in] activationAttributes List of attributes (in the form property=value pairs) that are set when the service is modified. The values can include substitutions. If the UpStreamBandwidth or DownStreamBandwidth properties are set, the delta bandwidth (that is, the difference between the value for the active session and the new value) is sent to the authorization plug-in. For example, if the service session was originally authorized with an upstream bandwidth of 64 Kbps, and the session is modified to an upstream bandwidth of 32 Kbps, the method publishes a bandwidth of -32 Kbps to the authorization plug-in. If the controlled bandwidth changes, the interim update contains the new bandwidth. If substitution values have changed for policies, the existing policies are removed from the router, and new policies are installed.
Exceptions:
UnknownUserException Raised if the subscriber is not logged in to a subscriber session.
NonUniqueUserException Raised if there is more than one active subscriber session for the specified subscriber ID.
UnknownServiceException Raised if the service is not available.
UnknownSubscriptionException Raised if the subscription does not exist.
UnknownServiceSessionException Raised if the requested service session does not exist.
ServiceAuthenticationException Raised if authentication for service activation fails.
OverloadException Raised if the SAE is overloaded at the time of the request and does not perform the requested operation.
SAEException Raised if there is an unspecified error condition within the SAE.

ReadResult sae.Subscriber.read ( in Select  subscription,
in Select  service,
in StringSeq  attributes 
) raises (SAEException, UnknownUserException, NonUniqueUserException)

The read() method requests information from a subscriber session.

The information collected by this method depends on the attributes you specify for a subscription, for the service associated with the subscription, and for the subscriber who subscribes to those services. The attributes you provide are Bean properties of classes in the SAE core API.

For information about these properties, see the online documentation for the SAE core API on the SDX software CD at the following location: /SDK/doc/sae/index.html.

Parameters:
[in] subscription Subscription attributes selected. The attribute names are Bean properties of the Subscription class in the SAE core API.
[in] service Service attributes selected. The attribute names are Bean properties of the Service class in the SAE core API.
[in] attributes List of subscriber attributes. The attribute names are Bean properties of the User class in the SAE core API.
Returns:
A ReadResult structure that contains all of the selected data.
Exceptions:
UnknownUserException Raised if a subscriber is not logged in to the subscriber session.
NonUniqueUserException Raised if there is more than one active subscriber session for the specified subscriber ID.
SAEException Raised if there is an unspecified error condition within the SAE.

AttrSeqSeq sae.Subscriber.readService ( in Select  selection  )  raises (SAEException, UnknownUserException, NonUniqueUserException)

The readService() method retrieves service data.

The current subscriber object does not have to be subscribed to the services for this method to retrieve data.

Parameters:
[in] selection Selects attributes to return. The attribute names are Bean properties of the Service class in the SAE core API.
Returns:
List of selected attribute lists. Each list contains attributes for one service.
Exceptions:
UnknownUserException Raised if the subscriber is not logged in to a subscriber session.
NonUniqueUserException Raised if there is more than one active subscriber session for the specified subscriber ID.
SAEException Raised if there is an unspecified error condition within the SAE.

AttrSeq sae.Subscriber.readSubscriber ( in StringSeq  attributes  )  raises (SAEException, UnknownUserException, NonUniqueUserException)

The readSubscriber() method retrieves specified subscriber attributes from the directory.

Parameters:
[in] attributes List of subscriber attributes to retrieve. The attribute names are Bean properties of the User class in the SAE core API. A single asterisk (*) in a list indicates that all attributes are to be returned.
Returns:
List of selected attributes.
Exceptions:
SAEException Raised if there is an unspecified error condition within the SAE.
UnknownUserException Raised if the subscriber is not logged in to the subscriber session.
NonUniqueUserException Raised if there is more than one active subscriber session for the specified subscriber ID.

AttrSeqSeq sae.Subscriber.readSubscription ( in Select  selection  )  raises (SAEException, UnknownUserException, NonUniqueUserException)

The readSubscription() method retrieves specified subscription data from the directory.

Parameters:
[in] selection Selects attributes to return. The attribute names are Bean properties of the Subscription class in the SAE core API.
Returns:
List of selected attribute lists. Each list contains attributes for one subscription.
Exceptions:
UnknownUserException Raised if the subscriber is not logged in to a subscriber session.
NonUniqueUserException Raised if there is more than one active subscriber session for the specified subscriber ID.
SAEException Raised if there is an unspecified error condition within the SAE.

void sae.Subscriber.revokePublicIp (  )  raises (UnknownUserException, SAEException)

The revokePublicIp() method switches the IP address of subscriber using a DHCP connection from an authenticated IP address to an unauthenticated IP address.

NOTE: If the operation is successful, the current subscriber object becomes invalid.

Exceptions:
UnknownUserException Raised if the subscriber is not logged in to a subscriber session.
SAEException Raised if there is an unspecified error condition within the SAE.

void sae.Subscriber.setActivationTrigger ( in string  subscriptionName,
in string  activationTrigger 
) raises (UnknownUserException, NonUniqueUserException, UnknownServiceException, UnknownSubscriptionException, ServiceAuthenticationException, SAEException)

The setActivationTrigger() method changes how a subscription for a service becomes active.

You can set activation to one of the following:

Parameters:
[in] subscriptionName Name of the subscription to be modified.
[in] activationTrigger Mechanism to activate subscription. Valid values are ACTIVATE_ON_LOGIN or MANUAL.
Exceptions:
UnknownUserException Raised if the subscriber is not logged in to a subscriber session.
NonUniqueUserException Raised if there is more than one active subscriber session for the specified subscriber ID.
UnknownServiceException Raised if the service is not available.
UnknownSubscriptionException Raised if the subscription does not exist.
SAEException Raised if there is an unspecified error condition within the SAE.

void sae.Subscriber.setInterimTime ( in string  subscriptionName,
in string  sessionName,
in unsigned long  time 
) raises (UnknownUserException, NonUniqueUserException, UnknownServiceException, SAEException)

The setInterimTime() method sets the interval of the interim update for a service session.

Parameters:
[in] subscriptionName Name of the subscription for the service session.
[in] sessionName ID for the service session. An empty string identifies the default service session.
[in] time Interval for the interim update in seconds.
Exceptions:
UnknownUserException Raised if the subscriber is not logged in to a subscriber session.
NonUniqueUserException Raised if there is more than one active subscriber session for the specified subscriber ID.
UnknownServiceException Raised if the service is not available.
SAEException Raised if there is an unspecified error condition within the SAE.

void sae.Subscriber.setPersistentSession ( in string  subscriptionName,
in string  sessionName,
in AttrSeq  persistentSessionAttributes 
) raises (UnknownUserException, NonUniqueUserException, UnknownServiceException, SAEException)

The setPersistentSession() method identifies a service subscription that is to start automatically at subscriber login (which creates a service session).

Parameters:
[in] subscriptionName Name of the subscription.
[in] sessionName ID of the service session. An empty string identifies the default service session.
[in] persistentSessionAttributes List of attributes stored from one subscriber session to another session for the same subscriber.
Exceptions:
UnknownUserException Raised if the subscriber is not logged in to a subscriber session.
NonUniqueUserException Raised if there is more than one active subscriber session for the specified subscriber ID.
UnknownServiceException Raised if the service is not available.
SAEException Raised if there is an unspecified error condition within the SAE.

void sae.Subscriber.setProperty ( in string  aProperty  )  raises (SAEException, UnknownUserException, NonUniqueUserException)

The setProperty() method sets the property attribute of the subscriber session.

NOTE: Setting properties does not cause subscriber reclassification.

Parameters:
[in] aProperty is typically in <name>=
format.

Exceptions:
UnknownUserException Raised if the subscriber is not logged in to a subscriber session.
NonUniqueUserException Raised if there is more than one active subscriber session for the specified subscriber ID.
SAEException Raised if there is an unspecified error condition within the SAE.

void sae.Subscriber.setSessionTimeout ( in unsigned long  timeout  )  raises (UnknownUserException, NonUniqueUserException, SAEException)

The setSessionTimeout() method specifies the number of seconds after which the subscriber session is automatically deactivated.

The session timeout identifies the maximum length of the session. The time interval starts at the beginning of a session.

Parameters:
[in] timeout Length of the subscriber session in seconds.
Exceptions:
UnknownUserException Raised if the subscriber is not logged in to a subscriber session.
NonUniqueUserException Raised if there is more than one active subscriber session for the specified subscriber ID.
SAEException Raised if there is an unspecified error condition within the SAE.

void sae.Subscriber.setSessionVolumeQuota ( in string  subscriptionName,
in string  sessionName,
in string  sessionVolumeQuota 
) raises (UnknownUserException, NonUniqueUserException, UnknownServiceException, SAEException)

The setSessionVolumeQuota() method sets the volume quota for the session.

Parameters:
[in] subscriptionName Name of the subscription.
[in] sessionName ID for the service session. An empty string indicates the default service session.
[in] sessionVolumeQuota Volume quota for the session in the format: "\<downstreamQuota\>;\<upstreamQuota\>".
Exceptions:
UnknownUserException Raised if the subscriber is not logged in to a subscriber session.
NonUniqueUserException Raised if there is more than one active subscriber session for the specified subscriber ID.
UnknownServiceException Raised if the service is not available.
SAEException Raised if there is an unspecified error condition within the SAE.

void sae.Subscriber.startModifyFragmentSession ( in string  subscriptionName,
in string  sessionName,
in AttrSeq  activationAttributes 
) raises (UnknownUserException, NonUniqueUserException, UnknownServiceException, UnknownSubscriptionException, UnknownServiceSessionException, ServiceAuthenticationException, SAEException)

NOTE: The startModifyFragmentSession() method is only for internal use.

void sae.Subscriber.undoModifyFragmentSession ( in string  subscriptionName,
in string  sessionName,
in AttrSeq  activationAttributes 
) raises (UnknownUserException, NonUniqueUserException, UnknownServiceException, UnknownSubscriptionException, UnknownServiceSessionException, ServiceAuthenticationException, OverloadException, SAEException)

NOTE: The undoModifyFragmentSession() method is only for internal use.

void sae.Subscriber.updateOneTimeScheduleEntryActions ( in long long  eventDate,
in ActionSeq  actions 
) raises (UnknownUserException, SAEException)

The updateOneTimeScheduleEntryActions() method updates a service action scheduled for a single time.

Parameters:
[in] eventDate Time in msec since 1970-01-01.
[in] actions Service actions to be taken at the scheduled time.
Exceptions:
UnknownUserException Raised if the subscriber is not logged in to a subscriber session.
SAEException Raised if there is an unspecified error condition within the SAE.
Since:
4.0
Deprecated:
In 4.1.

void sae.Subscriber.updateScheduleEntry ( in ScheduleEntryId  id,
in ScheduledTime  schedTime,
in ActionExtSeq  actions 
) raises (UnknownUserException, SAEException)

The updateScheduleEntry() method updates the scheduled times and actions for a service schedule that has a specified ID.

Parameters:
[in] id ID of the service schedule entry in the directory.
[in] schedTime Scheduled time for the action(s) to be taken.
[in] actions Service actions to be taken at the scheduled time.
Exceptions:
UnknownUserException Raised if the subscriber is not logged in to a subscriber session.
SAEException Raised if there is an unspecified error condition within the SAE.
Since:
4.1

void sae.Subscriber.updateServiceSessionTimeout ( in string  subscriptionName,
in string  sessionName,
in unsigned long  timeout 
) raises (UnknownUserException, NonUniqueUserException, UnknownServiceException, UnknownSubscriptionException, SAEException)

The updateServiceSessionTimeout() method updates the timeout of the service session for the specified session.

The session timeout count begins at the current time, not from the time the session started. If the session timeout is inactive, it is activated. If the value for timeout is equal to -1, the session timeout is canceled.

Parameters:
[in] subscriptionName Name of the subscription to be updated.
[in] sessionName ID of the service session to be updated.
[in] timeout Length of the service session timeout in seconds.
Exceptions:
UnknownUserException Raised if the subscriber is not logged in to a subscriber session.
NonUniqueUserException Raised if there is more than one active subscriber session for the specified subscriber ID.
UnknownServiceException Raised if the service is not available.
UnknownSubscriptionException Raised if the subscription does not exist.
SAEException Raised if there is an unspecified error condition within the SAE.

void sae.Subscriber.updateSessionTimeout ( in unsigned long  timeout  )  raises (UnknownUserException, NonUniqueUserException, SAEException)

The updateSessionTimeout() method updates the session timeout for the current subscriber.

The session timeout count begins at the current time, not from the time of the session started. If the subscriber session timeout is inactive, it is activated. If the value for timeout is equal to -1, the session timeout is canceled.

Parameters:
[in] timeout Maximum length of the session in seconds.
Exceptions:
UnknownUserException Raised if the subscriber is not logged in to a subscriber session.
NonUniqueUserException Raised if there is more than one active subscriber session for the specified subscriber ID.
SAEException Raised if there is an unspecified error condition within the SAE.


The documentation for this interface was generated from the following file:
Generated on Wed May 8 13:28:16 2013 for SAE API by  doxygen 1.4.7