|
Core API 4.3 | |||||||||
| PREV PACKAGE NEXT PACKAGE | FRAMES NO FRAMES | |||||||||
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 SSP'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 SSP from the SSP's LDAP directory. |
| Ssp | The static methods of this class allow a portal JSP page 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 SSP'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 SSP service. |
| User | This bean represents a user currently logged in to SSP. |
| Exception Summary | |
| LoginException | This exception is thrown when an attempt to log a user in to SSP 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 SSP. |
| 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 SSP or in an external system upon which SSP 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 SSP. |
| UnknownServiceSessionException | This exception is thrown when an attempt to modify the non-active subscription session discrebed 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 SSP.
|
This package is the core SAE Portal API; it is the only package needed when developing portals for residential subscribers. For an introduction to this API and examples of its use, please refer to the Service Selection Center Developer's Guide.
This API documentation is intended for portal designers who are writing portal web pages using JavaServer Pages (JSP) technology, and who have some familiarity with the Java programming language. There are many JSP and Java tutorials available on the web. One starting place is the official Java website at java.sun.com, and more specifically its JSP information at java.sun.com/products/jsp.
User - Represents a user currently logged in to SSP.
Service - Represents a service definition currently loaded into SSP from an LDAP directory.
Subscription - Represents the relationship between a user and a service to which the user has subscribed.
Ssp class provide functionality that can not be represented as
bean properties.
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.
userIp property of the User bean can be set to a user's IP address as follows:
<jsp:setProperty name="aBeanName" property="userIp" value="<%=request.getRemoteAddr()%>" />This will obtain the user's IP address from the implicit JSP
request object (representing the user's HTTP request) and assign it to a bean's userIp property.
|
Core API 4.3 | |||||||||
| PREV PACKAGE NEXT PACKAGE | FRAMES NO FRAMES | |||||||||