sae.SAEAccess Interface Reference

Interface to access the SAE core API. More...

import "saeaccess.idl";

Inheritance diagram for sae.SAEAccess:
sae.SAEFeature

List of all members.

Public Member Functions

Subscriber getSubscriber (in SubscriberId sid) raises (UnknownUserException, NonUniqueUserException)
 The getSubscriber() method retrieves a single subscriber object by matching the specified attributes.
SubscriberSeq getSubscriberSet (in SubscriberId sid, in unsigned long how_many, out SubscriberIterator iter, out unsigned long total)
 The getSubscriberSet() method retrieves 0 or more subscriber objects by using the subscriber ID.
SubscriberSeq findSubscriber (in string filter, in unsigned long how_many, out SubscriberIterator iter, out unsigned long total) raises (SAEException)
 The findSubscriber() method identifies one or more subscribers by using an LDAP filter.
SubscriberSeq getSubscriberFilter (in SubscriberId sid, in string filter, in unsigned long how_many, out SubscriberIterator iter, out unsigned long total) raises (SAEException)
 The getSubscriberFilter() method retrieves references to all subscriber sessions that match a specified subscriber ID and the search-filter criteria.
void registerLogin (in string macAddress, in wstring loginDescription, in string loginName, in string password, in string vrName, in string interfaceName) raises (LoginException, SAEException)
 The registerLogin() method creates login registration objects in the directory for subscribers who use DHCP.
void registerLoginCredentials (in string macAddress, in wstring loginDescription, in string loginName, in string password, in string vrName, in string interfaceName) raises (LoginException, SAEException)
 The registerLoginCredentials() method passes the MAC address of the client device, the subscriber's login name, and the associated password to the SAE to identify the client device that is connecting to the network using DHCP.
void registerNextLogin (in string macAddress, in wstring loginDescription, in string loginName, in string password, in string vrName, in string interfaceName) raises (LoginException, SAEException)
 The registerNextLogin() method creates temporary login registration objects in memory for subscribers who use DHCP.
void unregisterLogin (in string macAddress, in string loginName, in string password) raises (LoginException, SAEException)
 The unregisterLogin() method deletes registration objects from the directory.
void registerEquipment (in string macAddress, in wstring equipmentDescription, in string loginName, in string password, in string vrName, in string interfaceName) raises (SAEException)
 The registerEquipment() method creates an entry in the directory for permanent IP addresses assigned to DHCP connections.
void registerEquipmentAttr (in string macAddress, in wstring equipmentDescription, in string loginName, in string password, in string vrName, in string interfaceName, in DhcpAttributes attr) raises (SAEException)
 The registerEquipmentAttr() method creates an entry in the directory for permanent IP addresses assigned to DHCP connections.
void unregisterEquipment (in string macAddress, in string loginName, in string password) raises (SAEException)
 The unregisterEquipment() method removes entries from the directory for permanent IP addresses that are assigned to DHCP connections.
boolean loginUser (in string userIp, in string loginName, in string password) raises (LoginException, SAEException)
 The loginUser() method creates an interface subscriber session for subscribers who log in using static IP addresses.
RegistrationSeq getRegisteredLogins (in string login, in string password) raises (LoginException, SAEException)
 The getRegisteredLogins() method retrieves from the directory a list of all the registered logins that use the specified login name.
RegistrationSeq getRegisteredEquipment (in string login, in string password) raises (LoginException, SAEException)
 The getRegisteredEquipment() method retrieves a list of a subscriber's client devices that use a DHCP connection and are registered to automatically obtain an authenticated IP address.

Detailed Description

Interface to access the SAE core API.

Descendant of sae.SAEFeature. Accessible through the ServiceActivationEngine interface SAEFeature.getFeature.


Member Function Documentation

SubscriberSeq sae.SAEAccess.findSubscriber ( in string  filter,
in unsigned long  how_many,
out SubscriberIterator  iter,
out unsigned long  total 
) raises (SAEException)

The findSubscriber() method identifies one or more subscribers by using an LDAP filter.

It returns the same items as getSubscriberSet().

Although similar to the getSubscriberSet() method, it uses an LDAP filter rather than a subscriber ID and takes as an argument the number of objects that the method should return.

NOTE: Use this method only when necessary, because it searches all active subscriber sessions and takes a significant amount of time to complete.

Parameters:
[in] filter Simplified LDAP search filter that can access attributes of the subscriber session. For more information about simplified LDAP filters, see the documentation for the Select() method.
[in] how_many Maximum number of session objects returned.
[out] iter Iterator to retrieve the remaining sessions, if more sessions than the specified number are returned. If the total number of sessions is less than or equal to how_many, no iter is returned.
[out] total Number of specified subscriber sessions.
Returns:
List of subscriber sessions.
Exceptions:
SAEException Raised if the filter cannot be parsed.
RegistrationSeq sae.SAEAccess.getRegisteredEquipment ( in string  login,
in string  password 
) raises (LoginException, SAEException)

The getRegisteredEquipment() method retrieves a list of a subscriber's client devices that use a DHCP connection and are registered to automatically obtain an authenticated IP address.

Parameters:
[in] login Subscriber's login name.
[in] password Subscriber's password associated with the login name.
Returns:
List of registration objects.
Exceptions:
LoginException Raised if a subscriber login to a subscriber session fails.
SAEException Raised if there is an unspecified error condition within the SAE.
RegistrationSeq sae.SAEAccess.getRegisteredLogins ( in string  login,
in string  password 
) raises (LoginException, SAEException)

The getRegisteredLogins() method retrieves from the directory a list of all the registered logins that use the specified login name.

A registered login allows subscribers who use DHCP to have a subscriber session automatically created when their client devices connect to the network using DHCP.

Parameters:
[in] login Subscriber's login name.
[in] password Subscriber's password associated with the login name.
Returns:
List of objects for registered logins that use the specified login name.
Exceptions:
LoginException Raised if a subscriber login to a subscriber session fails.
SAEException Raised if there is an unspecified error condition within the SAE.
Subscriber sae.SAEAccess.getSubscriber ( in SubscriberId  sid  )  raises (UnknownUserException, NonUniqueUserException)

The getSubscriber() method retrieves a single subscriber object by matching the specified attributes.

Parameters:
[in] sid ID of the subscriber session.
Returns:
Single subscriber object.
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.
SubscriberSeq sae.SAEAccess.getSubscriberFilter ( in SubscriberId  sid,
in string  filter,
in unsigned long  how_many,
out SubscriberIterator  iter,
out unsigned long  total 
) raises (SAEException)

The getSubscriberFilter() method retrieves references to all subscriber sessions that match a specified subscriber ID and the search-filter criteria.

The method first selects the objects that match the subscriber ID, and then filters these objects to obtain the result.

The getSubscriberFilter() method is a combination of the getSubscriberSet() and findSubscriber() methods. The method returns the same items as getSubscriberSet().

Parameters:
[in] sid ID of the subscriber sessions.
[in] filter Simplified LDAP search filter that can access attributes of the subscriber session. For more information about simplified LDAP filters, see the documentation for the Select() method.
[in] how_many Maximum number of session objects returned.
[in] iter Iterator to retrieve the remaining sessions if more sessions than the specified number are returned. If the total number of sessions is less than or equal how_many, no iter is returned.
[in] total Number of selected subscriber sessions.
Returns:
List of subscriber sessions.
Exceptions:
SAEException Raised if the filter cannot be parsed.
SubscriberSeq sae.SAEAccess.getSubscriberSet ( in SubscriberId  sid,
in unsigned long  how_many,
out SubscriberIterator  iter,
out unsigned long  total 
)

The getSubscriberSet() method retrieves 0 or more subscriber objects by using the subscriber ID.

The method takes the same arguments as the getSubscriber() method, plus the number of objects that the method should return. If no subscriber is found, the returned sequence can be empty.

Parameters:
[in] sid ID of the subscriber session.
[in] how_many Maximum number of session objects returned.
[out] iter Iterator to retrieve the remaining sessions, if more session than the specified number are returned. If the total number of sessions is less than or equal to how_many, no iter is returned.
[out] total Number of selected subscriber sessions.
Returns:
List of subscriber sessions.
boolean sae.SAEAccess.loginUser ( in string  userIp,
in string  loginName,
in string  password 
) raises (LoginException, SAEException)

The loginUser() method creates an interface subscriber session for subscribers who log in using static IP addresses.

For subscribers who use a different method to log in, use the login() method of the Subscriber interface.

Parameters:
[in] userIp Subscriber's static IP address.
[in] loginName Subscriber's login name.
[in] password Subscriber's password associated with the login name.
Returns:
false
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.SAEAccess.registerEquipment ( in string  macAddress,
in wstring  equipmentDescription,
in string  loginName,
in string  password,
in string  vrName,
in string  interfaceName 
) raises (SAEException)

The registerEquipment() method creates an entry in the directory for permanent IP addresses assigned to DHCP connections.

The information stored in the directory is used to obtain an authenticated IP address.


NOTE: The registerEquipment() method can be used only with JUNOSe routers.

Parameters:
[in] macAddress MAC address of the client device.
[in] equipmentDescription Description of the client device.
[in] loginName Subscriber's login name.
[in] password Subscriber's password associated with the login name.
[in] vrName Name of the virtual router that manages the subscriber associated with the client device.
[in] interfaceName Name of the managed interface that handles the subscriber associated with the client device.
Exceptions:
SAEException Raised if there is an unspecified error condition within the SAE.
void sae.SAEAccess.registerEquipmentAttr ( in string  macAddress,
in wstring  equipmentDescription,
in string  loginName,
in string  password,
in string  vrName,
in string  interfaceName,
in DhcpAttributes  attr 
) raises (SAEException)

The registerEquipmentAttr() method creates an entry in the directory for permanent IP addresses assigned to DHCP connections.

The information stored in the directory is used to obtain an authenticated IP address. The registerEquipmentAttr() method uses DHCP attributes for device registration in addition to the attributes used by the registerEquipment() method.

The registerEquipmentAttr() method can be used only with JUNOSe routers.

Parameters:
[in] macAddress MAC address of the client device.
[in] equipmentDescription Description of the client device.
[in] loginName Subscriber's login name.
[in] password Subscriber's password associated with the login name.
[in] vrName Name of the virtual router that manages the subscriber associated with the client device.
[in] interfaceName Name of the managed interface that handles the subscriber associated with the client device.
[in] attr Value of string name for Attr.
Exceptions:
SAEException Raised if there is an unspecified error condition within the SAE.
void sae.SAEAccess.registerLogin ( in string  macAddress,
in wstring  loginDescription,
in string  loginName,
in string  password,
in string  vrName,
in string  interfaceName 
) raises (LoginException, SAEException)

The registerLogin() method creates login registration objects in the directory for subscribers who use DHCP.

The SAE authenticates the specified loginName and password, and loads the associated user profile. The name of this profile is stored in the directory with the MAC address as the key. The next time the client device connects to the router, the SAE loads the registered user profile. Another authentication is not required.

The creation of a subscriber session when the client device is activated takes effect the next time that the client device requests an IP address.

Parameters:
[in] macAddress MAC address of the client device.
[in] loginDescription Description of the subscriber session.
[in] loginName Subscriber's login name.
[in] password Subscriber's password associated with the login name.
[in] vrName Name of the virtual router that manages the subscriber associated with the client device.
[in] interfaceName Name of the managed interface that handles the subscriber associated with the client device.
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.SAEAccess.registerLoginCredentials ( in string  macAddress,
in wstring  loginDescription,
in string  loginName,
in string  password,
in string  vrName,
in string  interfaceName 
) raises (LoginException, SAEException)

The registerLoginCredentials() method passes the MAC address of the client device, the subscriber's login name, and the associated password to the SAE to identify the client device that is connecting to the network using DHCP.

The SAE stores the specified loginName and password in the directory with the MAC address as the key. The next time that the client device connects to the router, the SAE uses the loginName and password to log in the subscriber and authenticate a user session.

The creation of a subscriber session when the client device is activated takes effect the next time that the client device requests an IP address.

Parameters:
[in] macAddress MAC address of the client device.
[in] loginDescription Description of the subscriber session.
[in] loginName Subscriber's login name.
[in] password Subscriber's password associated with the login name.
[in] vrName Name of the virtual router that manages the subscriber associated with the client device.
[in] interfaceName Name of the managed interface that handles the subscriber associated with the client device.
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.SAEAccess.registerNextLogin ( in string  macAddress,
in wstring  loginDescription,
in string  loginName,
in string  password,
in string  vrName,
in string  interfaceName 
) raises (LoginException, SAEException)

The registerNextLogin() method creates temporary login registration objects in memory for subscribers who use DHCP.

The SDX software removes the temporary object either the next time the subscriber logs in or after a certain time elapses, depending on which event occurs first.

The method passes credentials for subscribers to the SAE. These credentials are used to obtain an authenticated IP address only for the next subscriber session.

Parameters:
[in] macAddress MAC address of the client device.
[in] loginDescription Description of the subscriber session.
[in] loginName Subscriber's login name.
[in] password Subscriber's password associated with the login name.
[in] vrName Name of the virtual router that manages the subscriber associated with the client device.
[in] interfaceName Managed interface that handles the subscriber associated with the client device.
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.SAEAccess.unregisterEquipment ( in string  macAddress,
in string  loginName,
in string  password 
) raises (SAEException)

The unregisterEquipment() method removes entries from the directory for permanent IP addresses that are assigned to DHCP connections.

The method disables client device registration for subscribers who have registered their client device and who use a DHCP connection.

The unregisterEquipment() method can be used only with JUNIOSe routers.

Parameters:
[in] macAddress MAC address of a client device.
[in] loginName Subscriber's login name.
[in] password Subscriber's password associated with the login name.
Exceptions:
SAEException Raised if there is an unspecified error condition within the SAE.
void sae.SAEAccess.unregisterLogin ( in string  macAddress,
in string  loginName,
in string  password 
) raises (LoginException, SAEException)

The unregisterLogin() method deletes registration objects from the directory.

The method passes to the SAE the MAC address of the client device and the subscriber's login name and password. The SAE removes registration information from the directory for subscribers who connect using DHCP and have registered their client device.

Parameters:
[in] macAddress MAC address of the client device.
[in] loginName Subscriber's login name.
[in] password Subscriber's password associated with the login name.
Exceptions:
LoginException Raised if a subscriber login to a subscriber session fails.
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 23 Dec 2014 for SAE API by  doxygen 1.6.1