Package net.juniper.smgt.sae.portal

This package is the core SAE API.

See:
Description

Interface Summary

DhcpOption	Encapsulation of a single DHCP option.
DhcpOptions	Encapsulation of DHCP options.
DhcpPacket	Encapsulation of DHCP packet data.

Class Summary

Action	The Action class encapsulated an action that can be taken for a subscriber.
DhcpProfile	Encapsulate DHCP Profile data used to manipulate DHCP addresses for JUNOSe version 5.3 and later.
OneTimeScheduleEntry	The OneTimeScheduleEntry class encapsulates one time event that can be configured by the subscriber to taken.
Registration	Registration objects represent the information stored in SAE's LDAP directory during calls to the Ssp.registerLogin and Ssp.registerEquipment methods.
ScheduledTime	The ScheduledTime class encapsulates the schedule time that is configured for a Schedule Entry.
ScheduleEntry	The ScheduleEntry class encapsulates schedule that can be configured by the subscriber to be taken.
Service	This bean represents a service currently loaded into SAE from the SAE's LDAP directory.
Ssp	The static methods of this class allow an application to log in and log out most types of users, to grant and revoke public IP addresses for DHCP users, to register and unregister equipment and logins for DHCP users, and to modify information in SAE's LDAP directories.
Subscription	This bean represents the relationship between a currently logged in user and a currently loaded service to which the user is subscribed.
TimeSpec	The TimeSpec class encapsulates the time specification used in ScheduledTime
Usage	Usage objects contain statistics that describe the network traffic between a user and a network resource that is controlled by an SAE service.
User	This bean represents a user currently logged in to SAE.

Exception Summary

LoginException	This exception is thrown when an attempt to log a user in to SAE fails, or if an authentication failure occurs while registering or unregistering a login, or if an authentication failure occurs while getting registered logins.
NonUniqueUserException	This exception is thrown when an attempt is made to access the properties of a User or Subscription bean whose userDn property specifies a user logged in more than once to SAE.
OverloadException	This exception is thrown when the COPS interface is currently overloaded.
PortalException	This is the superclass of all exceptions thrown by the Portal API.
ServiceAuthenticationException	This exception is thrown when an attempt to activate or modify a Subscription is rejected, or when an attempt to grant a public IP address fails due to an authentication failure, or when an attempt to user self subscription or user self unsubscription is denied by the subscription authorization plug-in, or when the user attempts to self subscribe to a service loaded to ssp but unvailable for new subscriptions.
SspException	This exception is thrown when an operation fails due to an unexpected error condition in SAE or in an external system upon which SAE depends.
UnknownServiceException	This exception is thrown when an attempt is made to access the properties of a Service bean or a Subscription bean whose serviceName property specifies a service not currently loaded into SAE.
UnknownServiceSessionException	This exception is thrown when an attempt is made to access the non-active subscription session described by this bean.
UnknownSubscriptionException	This exception is thrown if an attempt is made to access the properties of a Subscription bean that is initialized such that the user specified by the bean's userIp or userDn property is not currently subscribed to the service specified by the bean's serviceName property.
UnknownUserException	This exception is thrown when an attempt is made to access the properties of a User or Subscription bean whose userIp or userDn property specifies a user not currently logged in to SAE.
UnsupportedException	UnsupportedException.java Created: Mon Dec 3 12:18:29 2007

Package net.juniper.smgt.sae.portal Description

This package is the core SAE API. For an introduction to this API and examples of its use, please refer to the Service Deployment System Developer's Guide.

Overview

The core SAE API consists of the following beans:

• User - Represents a user currently logged in to SAE.
• Service - Represents a service definition currently loaded into SAE from an LDAP directory.
• Subscription - Represents the relationship between a user and a service to which the user has subscribed.

In addition, the methods of the Ssp class provide functionality that can not be represented as bean properties.

Using the API's beans

Every instance of the User, Service, and Subscription beans requires initialization. After instantiating one of these beans, the following properties must be set before any other property is accessed:

• User: set the userIp or the userDn property.
• Service: set the serviceName property.
• Subscription: set the userIp or userDn property, and the serviceName property.