Core API 5.0
A B D F G H I L M N O P R S T U

A

Action - class net.juniper.smgt.sae.portal.Action.
The Action class encapsulated an action that can be taken for a subscriber.
Action() - Constructor for class net.juniper.smgt.sae.portal.Action
Default constrcutor
Action(int, String) - Constructor for class net.juniper.smgt.sae.portal.Action
Constrcutor with eventDate and actions
Action(int, String, Attr[]) - Constructor for class net.juniper.smgt.sae.portal.Action
Constrcutor with eventDate and actions
ACTIVATE - Static variable in class net.juniper.smgt.sae.portal.Action
A possible value for this bean's operation property.
ACTIVATE_ON_LOGIN - Static variable in class net.juniper.smgt.sae.portal.Subscription
A possible value for this bean's activationTrigger property.
ACTIVATE_ONLY - Static variable in class net.juniper.smgt.sae.portal.ServiceAuthenticationException
If getReason() returns this value, this exception occurred because it is not allowed to deactivate an "activateOnly" service.
addScheduleEntry(ScheduleEntry) - Method in class net.juniper.smgt.sae.portal.User
Adds a ScheuldeEntry for the Subscriber.
addSubscription(String, String, String) - Method in class net.juniper.smgt.sae.portal.User
Subscribes the currently logged in user to the service specified by serviceName.
addSubscription(String, String, String, String) - Static method in class net.juniper.smgt.sae.portal.Ssp
Deprecated. Use the method User.addSubscription of class User instead.
ANONYMOUS_USER - Static variable in class net.juniper.smgt.sae.portal.ServiceAuthenticationException
If getReason() returns this value, this exception occurred because an anonymous user attempted to modify a subscription or add a subbscription or delete a subscription.
AUTH_PRECLUDES_ACTIVATE_ON_LOGIN - Static variable in class net.juniper.smgt.sae.portal.ServiceAuthenticationException
If getReason() returns this value, this exception occurred because an attempt was made to make a subscription to a service that requires authentication an activate-on-login subscription.

B

BASEDN - Static variable in class net.juniper.smgt.sae.portal.Ssp
 

D

DEACTIVATE - Static variable in class net.juniper.smgt.sae.portal.Action
A possible value for this bean's operation property.
DEFAULT_SESSION_NAME - Static variable in class net.juniper.smgt.sae.portal.Subscription
The default value for this bean's sessionName property.
deleteScheduleEntry(long) - Method in class net.juniper.smgt.sae.portal.User
Deprecated. Use deleteScheduleEntry(String id) instead. Convert long date to string date using String.valueOf(date).
deleteScheduleEntry(String) - Method in class net.juniper.smgt.sae.portal.User
Delete the ScheduleEntry for the Subscriber for the given date.
deleteSubscription(String, String, String) - Method in class net.juniper.smgt.sae.portal.User
Unsubscribes the currently logged in user from the service specified by serviceName.
deleteSubscription(String, String, String, String) - Static method in class net.juniper.smgt.sae.portal.Ssp
Deprecated. Use the method User.deleteSubscription of class User instead.
DENY - Static variable in class net.juniper.smgt.sae.portal.Action
A possible value for this bean's operation property.
DENY_AND_DEACTIVATE - Static variable in class net.juniper.smgt.sae.portal.Action
A possible value for this bean's operation property.
DhcpOption - interface net.juniper.smgt.sae.portal.DhcpOption.
Encapsulation of a single DHCP option.
DhcpOptions - interface net.juniper.smgt.sae.portal.DhcpOptions.
Encapsulation of DHCP options.
DhcpPacket - interface net.juniper.smgt.sae.portal.DhcpPacket.
Encapsulation of DHCP packet data.
DhcpProfile - class net.juniper.smgt.sae.portal.DhcpProfile.
Encapsulate DHCP Profile data used to manipulate DHCP addresses for JUNOSe version 5.3 and later.
DhcpProfile() - Constructor for class net.juniper.smgt.sae.portal.DhcpProfile
 

F

FILTERED_OUT - Static variable in class net.juniper.smgt.sae.portal.ServiceAuthenticationException
If getReason() returns this value, this exception occurred because it is not allowed to activate or deactivate a subscription filtered out by RADIUS auth plug-in through the portal API.

G

getActions() - Method in class net.juniper.smgt.sae.portal.ScheduleEntry
Sets the actions to be taken at the event time.
getActivationTrigger() - Method in class net.juniper.smgt.sae.portal.Subscription
Returns either Subscription.ACTIVATE_ON_LOGIN or Subscription.MANUAL, indicating when this subscription will be activated.
getActiveSessionNames() - Method in class net.juniper.smgt.sae.portal.Subscription
Returns the names of all currently active sessions associated with this subscription.
getActiveSubscriptionNames() - Method in class net.juniper.smgt.sae.portal.User
Returns the name of every service that is currently activated for this user.
getAllUserDn() - Static method in class net.juniper.smgt.sae.portal.Ssp
Get set of DNs, which identify a currently loaded user session
getAllUserIp() - Static method in class net.juniper.smgt.sae.portal.Ssp
Get set of IP addresses, which identify a currently loaded user session
getAttribute(String) - Method in class net.juniper.smgt.sae.portal.Subscription
Returns the value of the named attribute from this subscription's entry in SAE's LDAP user directory.
getAttribute(String) - Method in class net.juniper.smgt.sae.portal.Service
Returns the value of the named attribute from this service's entry in SAE's LDAP service directory.
getAttribute(String) - Method in class net.juniper.smgt.sae.portal.User
Returns the value of the named attribute from this user's entry in SAE's LDAP user directory.
getAttributeNames() - Method in class net.juniper.smgt.sae.portal.Subscription
Get the names of the LDAP attributes defined for the current service session profile.
getAttributeNames() - Method in class net.juniper.smgt.sae.portal.Service
Get the names of the LDAP attributes defined for this service.
getAttributeNames() - Method in class net.juniper.smgt.sae.portal.User
Get the names of the LDAP attributes defined for the profile of the current user.
getAttributes() - Method in class net.juniper.smgt.sae.portal.Action
 
getAuthDeniedReasons() - Method in class net.juniper.smgt.sae.portal.User
Those users who connect via authenticated PPP or DHCP, and whose automatic login (based on the PPP or DHCP session information, or on a registered login) was denied due to an authorization failure, will be assigned a copy of the unauthenticated user profile, and a set of messages explaining why the automatic login was denied will be available via this method (there may be more than one reason authorization was denied).
getAutoSubscriptions() - Method in class net.juniper.smgt.sae.portal.User
Returns subscriptions to be activated on login, set by RADIUS auth plugin.
getAvailableServiceNames() - Method in class net.juniper.smgt.sae.portal.User
Returns the names of every service currently available for this user session
getAvailableSubscriptionNames() - Method in class net.juniper.smgt.sae.portal.User
Returns the name of every service that is currently available to this user.
getBootFileName() - Method in class net.juniper.smgt.sae.portal.DhcpProfile
Gets the value of bootFileName Set the value of the "file" field in the DHCP message.
getBytes() - Method in interface net.juniper.smgt.sae.portal.DhcpOptions
Format set of DHCP options into TLV encoded byte array.
getBytes() - Method in interface net.juniper.smgt.sae.portal.DhcpOption
 
getBytesFromUser() - Method in class net.juniper.smgt.sae.portal.Usage
The number of bytes sent across the network from the user to the service (i.e.
getBytesToUser() - Method in class net.juniper.smgt.sae.portal.Usage
The number of bytes sent across the network from the service (i.e.
getCategory() - Method in class net.juniper.smgt.sae.portal.Service
Returns the category of this service (e.g.
getCode() - Method in interface net.juniper.smgt.sae.portal.DhcpOption
 
getCollectionTime() - Method in class net.juniper.smgt.sae.portal.Usage
The time and date at which these usage statistics were collected from the network.
getCurrentIp() - Method in class net.juniper.smgt.sae.portal.LoginException
Returns the IP address of the user who failed to login to SAE, or null.
getDayOfMonth() - Method in class net.juniper.smgt.sae.portal.TimeSpec
 
getDayOfWeek() - Method in class net.juniper.smgt.sae.portal.TimeSpec
 
getDelegateTimeSpec() - Method in class net.juniper.smgt.sae.portal.TimeSpec
For internal use.
getDescription() - Method in class net.juniper.smgt.sae.portal.Registration
Returns the description that was specified at registration time.
getDescriptionOrServiceName() - Method in class net.juniper.smgt.sae.portal.Service
Returns the description of this service (e.g.
getDesignAndGraphics() - Method in class net.juniper.smgt.sae.portal.Service
Returns the `design and graphics' string for this service (e.g.
getDhcpOptions() - Method in class net.juniper.smgt.sae.portal.DhcpProfile
Gets the value of dhcpOptions Set the value of the "options" field in the DHCP message.
getDhcpPacket() - Method in class net.juniper.smgt.sae.portal.User
Return information about DHCP request.
getDomainName() - Method in class net.juniper.smgt.sae.portal.Service
Returns the domain name of this service (e.g.
getDownStreamBandwidth() - Method in class net.juniper.smgt.sae.portal.Subscription
Return the service down stream bandwidth for the subscription session represented by this bean.
getDurationActive() - Method in class net.juniper.smgt.sae.portal.Subscription
Returns the number of milliseconds that have passed since this subscription was activated (i.e.
getEventTime() - Method in class net.juniper.smgt.sae.portal.OneTimeScheduleEntry
Gets the time for the event using the given milliseconds time value.
getGiAddr() - Method in interface net.juniper.smgt.sae.portal.DhcpPacket
 
getHour() - Method in class net.juniper.smgt.sae.portal.TimeSpec
 
getId() - Method in class net.juniper.smgt.sae.portal.OneTimeScheduleEntry
 
getId() - Method in class net.juniper.smgt.sae.portal.ScheduleEntry
 
getInt() - Method in interface net.juniper.smgt.sae.portal.DhcpOption
 
getInterfaceAttributeNames() - Method in class net.juniper.smgt.sae.portal.User
Get the names of attributes of the interface which this user is connected.
getInterfaceAttributes() - Method in class net.juniper.smgt.sae.portal.User
Get all attributes of the interface which this user is connected.
getInterimTime() - Method in class net.juniper.smgt.sae.portal.Subscription
Returns the interval, in seconds, between service interim records used in the active subscription session represented by this bean.
getIntfAlias() - Method in class net.juniper.smgt.sae.portal.User
Returns the alias of the router interface to which this user is connected, as it is configured in the E-series router.
getIntfName() - Method in class net.juniper.smgt.sae.portal.Registration
Returns the interface name that was specified at registration time.
getIntfName() - Method in class net.juniper.smgt.sae.portal.User
Returns the name of the router interface to which this user is connected.
getIntfUserDns(String) - Static method in class net.juniper.smgt.sae.portal.Ssp
Returns the LDAP distinguished name (as a String) of every logged in interface user whose LDAP distinguished name contains searchString.
getIpAddress() - Method in interface net.juniper.smgt.sae.portal.DhcpOption
 
getIpAddresses() - Method in interface net.juniper.smgt.sae.portal.DhcpOption
 
getLeaseTime() - Method in class net.juniper.smgt.sae.portal.DhcpProfile
Gets the value of leaseTime.
getLength() - Method in interface net.juniper.smgt.sae.portal.DhcpOption
 
getLoadSubscriptions() - Method in class net.juniper.smgt.sae.portal.User
Returns the filter for "loaded" subscriptions, set by RADIUS auth plugin.
getLocationName() - Method in class net.juniper.smgt.sae.portal.Service
Deprecated. Returns the location name with which this bean was initialized. The value of some Service properties will vary according to the location where the service is used.
getLocationName() - Method in class net.juniper.smgt.sae.portal.User
Return's the name of the user's current location.
getLoginDomain() - Method in class net.juniper.smgt.sae.portal.User
Returns this user's login domain (e.g.
getLoginId() - Method in class net.juniper.smgt.sae.portal.User
Returns this user's login ID (e.g.
getLoginName() - Method in class net.juniper.smgt.sae.portal.Registration
If this is a registered login, this method returns the login name specified at registration time to identify the user profile that will be automatically logged in every time the client device obtains a new IP address via DHCP; if this is registered equipment, this method returns the login name specified at registration time that will be sent to the E-series router to obtain a public IP address every time the registered equipment requests a new IP address via DHCP.
getLoginName() - Method in class net.juniper.smgt.sae.portal.LoginException
Returns the login name used during the failed attempt to login to SAE, or during the failed attempt to register or unregister a login, or during the failed attempt to get registered logins.
getLoginTime() - Method in class net.juniper.smgt.sae.portal.User
Returns the time & date that this user logged in to SAE.
getLoginTimestamp() - Method in class net.juniper.smgt.sae.portal.User
Returns the time that this user logged in to SAE in milliseconds since 1970-01-01T00:00:00 UTC.
getMacAddress() - Method in class net.juniper.smgt.sae.portal.Registration
Returns the MAC address that uniquely identifies the registered client device.
getMacAddress() - Method in class net.juniper.smgt.sae.portal.User
Returns the user's MAC address as a string (e.g.
getMaxSessionTime() - Method in class net.juniper.smgt.sae.portal.Service
Returns the number of seconds that the service may be active before SAE will automatically deactivate it.
getMessage() - Method in class net.juniper.smgt.sae.portal.OverloadException
Returns an English language message explaining the underlying reason why a Portal API operation failed.
getMessage() - Method in class net.juniper.smgt.sae.portal.SspException
Returns an English language message explaining the underlying reason why a Portal API operation failed.
getMinute() - Method in class net.juniper.smgt.sae.portal.TimeSpec
 
getMonth() - Method in class net.juniper.smgt.sae.portal.TimeSpec
 
getMultiSubscriptionName() - Method in class net.juniper.smgt.sae.portal.Subscription
Returns the suffix of the subscription name with which this bean was initialized.
getName() - Method in class net.juniper.smgt.sae.portal.User
Returns this user's full name (e.g.
getNasIp() - Method in class net.juniper.smgt.sae.portal.User
Returns the IP address of the router which this user is connected.
getNumConcurrentGroupSessions() - Method in class net.juniper.smgt.sae.portal.User
Return the number of concurrent logins of the group of the current user profile.
getNumConcurrentSessions() - Method in class net.juniper.smgt.sae.portal.User
Return the number of concurrent logins of the current user profile.
getOperation() - Method in class net.juniper.smgt.sae.portal.Action
Gets the value for this bean's operation property.
getOption(int) - Method in interface net.juniper.smgt.sae.portal.DhcpOptions
 
getPacketsFromUser() - Method in class net.juniper.smgt.sae.portal.Usage
The number of IP packets sent across the network from the user to the service (i.e.
getPacketsToUser() - Method in class net.juniper.smgt.sae.portal.Usage
The number of IP packets sent across the network from the service (i.e.
getPersistentSessionNames() - Method in class net.juniper.smgt.sae.portal.Subscription
 
getPersonalSubscriptionNames() - Method in class net.juniper.smgt.sae.portal.User
Returns the name of every service to which this user is personally subscribed.
getPolicyParameters() - Method in class net.juniper.smgt.sae.portal.Subscription
Returns a List of substitutions which define the values which this subscription would use for the policy parameters if activated.
getPublicDhcpUserName() - Method in class net.juniper.smgt.sae.portal.User
Returns the user name that was passed from SAE to an E-series router, and then authenticated via RADIUS, before this user's current public IP address was granted.
getRadiusClass() - Method in class net.juniper.smgt.sae.portal.User
Returns radius class attribute from authorization plug-ins.
getRadiusClass() - Method in class net.juniper.smgt.sae.portal.DhcpProfile
Gets the value of radiusClass
getRadiusFramedIpAddress() - Method in class net.juniper.smgt.sae.portal.DhcpProfile
Gets the value of radiusFramedIpAddress The attribute radiusFramedIpAddress is one of the possible selectors for a DHCP address pool.
getRadiusFramedPool() - Method in class net.juniper.smgt.sae.portal.DhcpProfile
Gets the value of radiusFramedPool The attribute radiusFramedPool is one of the possible selectors for a DHCP address pool.
getRaw() - Method in interface net.juniper.smgt.sae.portal.DhcpPacket
 
getReason() - Method in class net.juniper.smgt.sae.portal.ServiceAuthenticationException
Returns the reason code that explains the reason for this exception.
getRegisteredEquipment(String, String) - Static method in class net.juniper.smgt.sae.portal.Ssp
Returns a list of all the equipment that was registered using the specified loginName and password.
getRegisteredLogins(String, String) - Static method in class net.juniper.smgt.sae.portal.Ssp
Returns a list of all the registered logins with the specified login name that are stored in the SAE's LDAP directory.
getRemainingSessionTime() - Method in class net.juniper.smgt.sae.portal.Subscription
Returns the time in seconds that remain before this subscription will be automatically deactivated by SAE.
getRemainingSessionTime() - Method in class net.juniper.smgt.sae.portal.User
Returns the time in seconds that remain before this user will be automatically logged out from SAE.
getReplyMessages() - Method in class net.juniper.smgt.sae.portal.Subscription
Return the "reply messages" from the authorization plug-in for the current user session.
getReplyMessages() - Method in class net.juniper.smgt.sae.portal.User
Return the "reply messages" from the authorization plug-in for the current user session.
getRuntimeParameters() - Method in class net.juniper.smgt.sae.portal.Subscription
Returns a List of substitutions which define the runtime values (e.g.
getScheduledTime() - Method in class net.juniper.smgt.sae.portal.OneTimeScheduleEntry
 
getScheduledTime() - Method in class net.juniper.smgt.sae.portal.ScheduleEntry
Gets the time for the event using the given milliseconds time value
getScheduleEntries() - Method in class net.juniper.smgt.sae.portal.User
Get all schedule enteries for the Subscriber.
getScheduleEntry(long) - Method in class net.juniper.smgt.sae.portal.User
Deprecated. Use getScheduleEntry(String id) instead. Convert long date to string date using String.valueOf(date).
getScheduleEntry(String) - Method in class net.juniper.smgt.sae.portal.User
Get the ScheduleEntry for the Subscriber for the given date.
getScheduleEntryEventDates() - Method in class net.juniper.smgt.sae.portal.User
Get list of dates for the Subscriber for the Subscriber's schedules.
getScheduleEntryIds() - Method in class net.juniper.smgt.sae.portal.User
Get list of ids for the Subscriber for the Subscriber's schedules.
getScopes() - Method in class net.juniper.smgt.sae.portal.User
Return a list of the DN of the user's current scopes dn sorted by scope's precedence and seperated by "\n".
getServerName() - Method in class net.juniper.smgt.sae.portal.DhcpProfile
Gets the value of serverName Set the value of the "sname" field in the DHCP message.
getServiceBundle() - Method in class net.juniper.smgt.sae.portal.User
Returns service bundle attribute from authorization plug-ins.
getServiceBundle() - Method in class net.juniper.smgt.sae.portal.DhcpProfile
Gets the value of serviceBundle
getServiceDirectory() - Static method in class net.juniper.smgt.sae.portal.Ssp
Returns a javax.naming.DirContext object that can be used to access the directory that stores SAE's service definitions, as specified by the following SAE configuration parameters: Service repository address (i.e.
getServiceName() - Method in class net.juniper.smgt.sae.portal.Action
Gets the value for this bean's serviceName property.
getServiceName() - Method in class net.juniper.smgt.sae.portal.Subscription
Returns the service name with which this bean was initialized (e.g.
getServiceName() - Method in class net.juniper.smgt.sae.portal.Service
Returns the service name with which this bean was initialized.
getServiceNames() - Static method in class net.juniper.smgt.sae.portal.Ssp
Deprecated. This method ignores service scopes and returns service names, that may not be valid for a given user. Use User.getAvailableServiceNames() instead.
getServiceParameters() - Method in class net.juniper.smgt.sae.portal.Subscription
Returns a List of substitutions which define the operational values which this subscription would use for the service parameters if activated.
getSessionName() - Method in class net.juniper.smgt.sae.portal.Subscription
Returns the subscription session name with which this bean was initialized.
getSessionTag() - Method in class net.juniper.smgt.sae.portal.Subscription
Return the session tag for the subscription session represented by this bean.
getSessionVolumeQuota() - Method in class net.juniper.smgt.sae.portal.Subscription
Returns the session volume quota for the subscription session represented by this bean.
getSourceBean() - Method in class net.juniper.smgt.sae.portal.NonUniqueUserException
Returns the User bean that threw this exception.
getSourceBean() - Method in class net.juniper.smgt.sae.portal.UnknownServiceSessionException
Returns the Subscription bean that threw this exception.
getSourceBean() - Method in class net.juniper.smgt.sae.portal.UnknownUserException
Returns the User bean that threw this exception.
getSourceBean() - Method in class net.juniper.smgt.sae.portal.ServiceAuthenticationException
Returns the Subscription bean that threw this exception during an attempt to activate or modify a subscription, or null.
getSourceBean() - Method in class net.juniper.smgt.sae.portal.UnknownServiceException
Returns the Service bean that threw this exception.
getSourceBean() - Method in class net.juniper.smgt.sae.portal.UnknownSubscriptionException
Returns the Subscription bean that threw this exception.
getSspPassword() - Method in class net.juniper.smgt.sae.portal.User
Returns the password attribute from this user's profile in LDAP, exactly as it is stored in the SAE's LDAP directory (i.e.
getString() - Method in interface net.juniper.smgt.sae.portal.DhcpOption
 
getSubOptions() - Method in interface net.juniper.smgt.sae.portal.DhcpOption
 
getSubscriptionName() - Method in class net.juniper.smgt.sae.portal.Subscription
Returns the subscription name with which this bean was initialized (e.g.
getSubscriptionNames() - Method in class net.juniper.smgt.sae.portal.User
Returns the name of every service to which this user is subscribed.
getSubscriptionPassword() - Method in class net.juniper.smgt.sae.portal.Subscription
Returns the password that will be used for authentication the next time this subscription is activated, if the subscribed service requires authentication.
getSubscriptionUsername() - Method in class net.juniper.smgt.sae.portal.Subscription
Returns the username that will be used for authentication the next time this subscription is activated, if the subscribed service requires authentication.
getSubstitutions() - Method in class net.juniper.smgt.sae.portal.Subscription
Returns the set of susbtitutions defined for the subscription session currently represented by this bean.
getTimeSpec(int) - Method in class net.juniper.smgt.sae.portal.ScheduledTime
 
getTimeZone() - Method in class net.juniper.smgt.sae.portal.TimeSpec
 
getType() - Method in class net.juniper.smgt.sae.portal.Service
Returns the type of this service.
getUpStreamBandwidth() - Method in class net.juniper.smgt.sae.portal.Subscription
Return the service up stream bandwidth for the subscription session represented by this bean.
getUrl() - Method in class net.juniper.smgt.sae.portal.Service
Returns the URL of this service (e.g.
getUsage() - Method in class net.juniper.smgt.sae.portal.Subscription
Returns statistics describing the network traffic between the user and the subscribed service (i.e.
getUserDirectory() - Static method in class net.juniper.smgt.sae.portal.Ssp
Returns a javax.naming.DirContext object that can be to access the directory that stores SAE's user profiles, as specified by the following SAE configuration parameters: User repository address (i.e.
getUserDn() - Method in class net.juniper.smgt.sae.portal.Registration
If this is a registered login, this method returns the LDAP Distinguished Name of the user profile that will be automatically logged in every time the client device obtains a new IP address via DHCP; if this is registered equipment, this method returns null.
getUserDn() - Method in class net.juniper.smgt.sae.portal.Subscription
Returns the LDAP dististinguished name with which this bean was initialized (e.g.
getUserDn() - Method in class net.juniper.smgt.sae.portal.Service
Returns the LDAP dististinguished name with which this bean was initialized (e.g.
getUserDn() - Method in class net.juniper.smgt.sae.portal.User
Returns the LDAP distinguished name with which this bean was initialized (e.g.
getUserIp() - Method in class net.juniper.smgt.sae.portal.Subscription
Returns the IP address with which this bean was initialized (e.g.
getUserIp() - Method in class net.juniper.smgt.sae.portal.Service
Returns the IP address with which this bean was initialized (e.g.
getUserIp() - Method in class net.juniper.smgt.sae.portal.User
Returns the IP address with which this bean was initialized (e.g.
getUserIpByInterface(String, String) - Static method in class net.juniper.smgt.sae.portal.Ssp
Return a list of IP addresses of user sessions currently active on given interface.
getUserName() - Method in class net.juniper.smgt.sae.portal.DhcpProfile
Gets the value of userName
getUserSessionsByIntfIndex(int, String) - Static method in class net.juniper.smgt.sae.portal.Ssp
Return a list of user sessions currently active on given interface defined by its index and virtual router name.
getUserSessionsByIntfName(String, String) - Static method in class net.juniper.smgt.sae.portal.Ssp
Return a list of user sessions currently active on given interface defined by its index and virtual router name.
getUserSessionsByPrimaryUserName(String) - Static method in class net.juniper.smgt.sae.portal.Ssp
Return a list of user sessions currently active associated to the given primary user name.
getVirtualRouterName() - Method in class net.juniper.smgt.sae.portal.DhcpProfile
Gets the value of virtualRouterName The attribute is used to select the virtual router context in which the DHCP address will be managed.
getVrName() - Method in class net.juniper.smgt.sae.portal.Registration
Returns the virtual router name that was specified at registration time.
getVrName() - Method in class net.juniper.smgt.sae.portal.User
Returns the name of the virtual router to which this user is connected.
getWebMessage() - Method in class net.juniper.smgt.sae.portal.SspException
Returns an English language message explaining the underlying reason why a Portal API operation failed.
getYear() - Method in class net.juniper.smgt.sae.portal.TimeSpec
 
grantPublicIp(String, String, String) - Static method in class net.juniper.smgt.sae.portal.Ssp
Assigns a public IP address to the specified user.
grantPublicIp(String, String, String, DhcpProfile) - Static method in class net.juniper.smgt.sae.portal.Ssp
Assigns a public IP address to the specified user.

H

handleInputError(short, String) - Method in class net.juniper.smgt.sae.portal.ScheduledTime
 
hasTimeInRange(long, long) - Method in class net.juniper.smgt.sae.portal.ScheduledTime
 

I

INHERITED_SUBSCRIPTION - Static variable in class net.juniper.smgt.sae.portal.ServiceAuthenticationException
If getReason() returns this value, this exception occurred because an attempt was made to alter a subscription that the user inherited from another user profile.
INVISIBLE - Static variable in class net.juniper.smgt.sae.portal.ServiceAuthenticationException
If getReason() returns this value, this exception occurred because it is not allowed to activate or deactivate a subscription to a "invisible" service through the portal API.
isActivateOnly() - Method in class net.juniper.smgt.sae.portal.Service
Returns true if this service is defined as an activate only service.
isActive() - Method in class net.juniper.smgt.sae.portal.Subscription
Returns true if this subscription is currently active.
isAnonymous() - Method in class net.juniper.smgt.sae.portal.User
Returns true if the user is anonymous.
isAuthenticationRequired() - Method in class net.juniper.smgt.sae.portal.Service
Returns true if this service requires a subscription-specific username and password before being activated.
isCurrentlyAvailable() - Method in class net.juniper.smgt.sae.portal.Subscription
Returns true if the user's subscription to the service is currently available.
isInitialized() - Method in class net.juniper.smgt.sae.portal.Subscription
Returns true if this bean has been fully initialized.
isInitialized() - Method in class net.juniper.smgt.sae.portal.Service
Returns true only if this bean has been fully initialized.
isInitialized() - Method in class net.juniper.smgt.sae.portal.User
Returns true only if this bean has been fully initialized.
isInvisible() - Method in class net.juniper.smgt.sae.portal.Service
Returns true if the attribute category of this service is marked as invisible.
isIspServiceActive() - Method in class net.juniper.smgt.sae.portal.User
Returns true only if this user currently has a service of type Service.ISP active.
isOperational() - Method in class net.juniper.smgt.sae.portal.Usage
 
ISP - Static variable in class net.juniper.smgt.sae.portal.Service
A possible value for a Service bean's type property.
isPersistentActivation() - Method in class net.juniper.smgt.sae.portal.Subscription
Check if a selected service is to be persistently activated.
isPersistentSession() - Method in class net.juniper.smgt.sae.portal.Subscription
Check if a selected session is persistent.
isPppUser() - Method in class net.juniper.smgt.sae.portal.User
Deprecated. This method has been deprecated. Returns true only if the user is connected via authenticated PPP.
isPublicDhcpUser() - Method in class net.juniper.smgt.sae.portal.User
Returns true only if the user is connected via DHCP, and currently has a public IP address.
isSuspended() - Method in class net.juniper.smgt.sae.portal.Subscription
Returns true if the user's subscription to the service is currently suspended for any reason (e.g.
isTokenDhcpUser() - Method in class net.juniper.smgt.sae.portal.User
Returns true only if the user is connected via DHCP, and currently has a 'token' IP address.
isUnauthenticated() - Method in class net.juniper.smgt.sae.portal.User
Returns true only if the user is unauthenticated.
iterator() - Method in interface net.juniper.smgt.sae.portal.DhcpOptions
 

L

loginDhcpUser(String, String, String, boolean) - Static method in class net.juniper.smgt.sae.portal.Ssp
Deprecated. This method has been replaced by the loginUser, registerLogin, and registerNextLogin methods.
LoginException - exception net.juniper.smgt.sae.portal.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.
loginUser(String, String, String) - Static method in class net.juniper.smgt.sae.portal.Ssp
Logs a user into SAE.
logoutDhcpUser(String) - Static method in class net.juniper.smgt.sae.portal.Ssp
Deprecated. This method has been replaced by the logoutUser and unregisterLogin methods.
logoutUser(String) - Static method in class net.juniper.smgt.sae.portal.Ssp
Logs a user out of SAE.

M

MANUAL - Static variable in class net.juniper.smgt.sae.portal.Subscription
A possible value for this bean's activationTrigger property.
modify() - Method in class net.juniper.smgt.sae.portal.Subscription
Modifies this subscription session.
MUTEX_GROUPS - Static variable in class net.juniper.smgt.sae.portal.ServiceAuthenticationException
If getReason() returns this value, this exception occurred because service mutex groups are currently configured to forbid the attempted subscription activation or modification.

N

net.juniper.smgt.sae.portal - package net.juniper.smgt.sae.portal
This package is the core SAE Portal API; it is the only package needed when developing portals for residential subscribers.
NO_SESSION_MODIFICATION - Static variable in class net.juniper.smgt.sae.portal.ServiceAuthenticationException
If getReason() returns this value, this exception occurred because it is not allowed to modify an active session of an ISP service.
NonUniqueUserException - exception net.juniper.smgt.sae.portal.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.
NORMAL - Static variable in class net.juniper.smgt.sae.portal.Service
A possible value for a Service bean's type property.

O

OneTimeScheduleEntry - class net.juniper.smgt.sae.portal.OneTimeScheduleEntry.
The OneTimeScheduleEntry class encapsulates one time event that can be configured by the subscriber to taken.
OneTimeScheduleEntry() - Constructor for class net.juniper.smgt.sae.portal.OneTimeScheduleEntry
Default constrcutor
OneTimeScheduleEntry(long, Action[]) - Constructor for class net.juniper.smgt.sae.portal.OneTimeScheduleEntry
Constrcutor with eventDate and actions
OverloadException - exception net.juniper.smgt.sae.portal.OverloadException.
This exception is thrown when the COPS interface is currently overloaded.

P

pollUsage() - Method in class net.juniper.smgt.sae.portal.Subscription
Collects statistics describing the network traffic between the user and the subscribed service (i.e.
PortalException - exception net.juniper.smgt.sae.portal.PortalException.
This is the superclass of all exceptions thrown by the Portal API.
printStackTrace(PrintWriter) - Method in class net.juniper.smgt.sae.portal.PortalException
For debugging only.
PUBLIC_IP_AUTHENTICATION - Static variable in class net.juniper.smgt.sae.portal.ServiceAuthenticationException
If getReason() returns this value, this exception occurred because the E-series router failed to authenticate the public IP address credentials that are required for a DHCP user to obtain a public IP address.

R

registerCurrentEquipment(String) - Static method in class net.juniper.smgt.sae.portal.Ssp
Deprecated. This method has been replaced by the registerEquipment and grantPublicIpmethods.
registerEquipment(String, String, String, String, String, String) - Static method in class net.juniper.smgt.sae.portal.Ssp
Registers the specified client device.
registerEquipment(String, String, String, String, String, String, DhcpProfile) - Static method in class net.juniper.smgt.sae.portal.Ssp
Register Equipment.
registerLogin(String, String, String, String, String, String) - Static method in class net.juniper.smgt.sae.portal.Ssp
Creates a persistent SAE login.
registerLoginCredentials(String, String, String, String, String, String) - Static method in class net.juniper.smgt.sae.portal.Ssp
Creates a persistent SAE login.
registerNextLogin(String, String, String, String, String, String) - Static method in class net.juniper.smgt.sae.portal.Ssp
Creates a semi-persistent SAE login.
Registration - class net.juniper.smgt.sae.portal.Registration.
Registration objects represent the information stored in SAE's LDAP directory during calls to the Ssp.registerLogin and Ssp.registerEquipment methods.
revokePublicIp(String) - Static method in class net.juniper.smgt.sae.portal.Ssp
Revokes the public IP address held by the specified user.

S

ScheduledTime - class net.juniper.smgt.sae.portal.ScheduledTime.
The ScheduledTime class encapsulates the schedule time that is configured for a Schedule Entry.
ScheduledTime() - Constructor for class net.juniper.smgt.sae.portal.ScheduledTime
Default constrcutor
ScheduledTime(TimeSpec, TimeSpec) - Constructor for class net.juniper.smgt.sae.portal.ScheduledTime
constrcutor with all the attributes
ScheduleEntry - class net.juniper.smgt.sae.portal.ScheduleEntry.
The ScheduleEntry class encapsulates schedule that can be configured by the subscriber to be taken.
ScheduleEntry() - Constructor for class net.juniper.smgt.sae.portal.ScheduleEntry
Default constrcutor
ScheduleEntry(String, ScheduledTime, Action[]) - Constructor for class net.juniper.smgt.sae.portal.ScheduleEntry
Constrcutor with eventDate and actions
Service - class net.juniper.smgt.sae.portal.Service.
This bean represents a service currently loaded into SAE from the SAE's LDAP directory.
SERVICE_AUTHORIZATION - Static variable in class net.juniper.smgt.sae.portal.ServiceAuthenticationException
If getReason() returns this value, this exception occurred because a service authorization plug-in forbid the attempted service activation or service session modification.
SERVICE_UNAVAILABLE - Static variable in class net.juniper.smgt.sae.portal.ServiceAuthenticationException
If getReason() returns this value, this exception occurred because the service is not currently available for subscription.
Service() - Constructor for class net.juniper.smgt.sae.portal.Service
The default bean constructor.
Service(User) - Constructor for class net.juniper.smgt.sae.portal.Service
 
ServiceAuthenticationException - exception net.juniper.smgt.sae.portal.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.
setActions(Action[]) - Method in class net.juniper.smgt.sae.portal.ScheduleEntry
Sets the actions to be taken at the event time.
setActivationTrigger(String) - Method in class net.juniper.smgt.sae.portal.Subscription
This method modifies the user's profile in the SAE's LDAP directory to specify when this subscription will be activated.
setActive(boolean) - Method in class net.juniper.smgt.sae.portal.Subscription
Activates or deactivates this subscription session.
setAttributes(Attr[]) - Method in class net.juniper.smgt.sae.portal.Action
 
setBootFileName(String) - Method in class net.juniper.smgt.sae.portal.DhcpProfile
Sets the value of bootFileName
setDayOfMonth(String) - Method in class net.juniper.smgt.sae.portal.TimeSpec
 
setDayOfWeek(String) - Method in class net.juniper.smgt.sae.portal.TimeSpec
 
setDhcpOptions(String) - Method in class net.juniper.smgt.sae.portal.DhcpProfile
Sets the value of dhcpOptions
setDownStreamBandwidth(int) - Method in class net.juniper.smgt.sae.portal.Subscription
Specifies a service down stream bandwidth to be used the next time the subscription session represented by this bean is activated (i.e.
setEventTime(long) - Method in class net.juniper.smgt.sae.portal.OneTimeScheduleEntry
Sets the time for the event using the given milliseconds time value.
setHour(String) - Method in class net.juniper.smgt.sae.portal.TimeSpec
 
setId(String) - Method in class net.juniper.smgt.sae.portal.ScheduleEntry
 
setInterimTime(int) - Method in class net.juniper.smgt.sae.portal.Subscription
Specifies the interval, in seconds, between service interim records to be used in the subscription session represented by this bean.
setLeaseTime(int) - Method in class net.juniper.smgt.sae.portal.DhcpProfile
Sets the value of leaseTime
setLocationName(String) - Method in class net.juniper.smgt.sae.portal.Service
Deprecated. Determines which localized version of the service definition will be described by all subsequent reads of this bean's properties. The value of some Service properties will vary according to the location where the service is used. If you are using location-specific service definitions it is critical to set both the locationName and serviceName properties before reading any other properties. If you are not using localized versions of services, this property can be safely ignored. If you are using localized versions of services, the required location name can be obtained from an initialized User bean.
setMinute(String) - Method in class net.juniper.smgt.sae.portal.TimeSpec
 
setMonth(String) - Method in class net.juniper.smgt.sae.portal.TimeSpec
 
setOperation(int) - Method in class net.juniper.smgt.sae.portal.Action
Sets the value for this bean's operation property.
setOperational(boolean) - Method in class net.juniper.smgt.sae.portal.Usage
 
setPersistentActivation(boolean) - Method in class net.juniper.smgt.sae.portal.Subscription
Creates or deletes a persistent activation.
setPersistentSession(boolean) - Method in class net.juniper.smgt.sae.portal.Subscription
Creates or deletes a persistent service session.
setRadiusClass(String) - Method in class net.juniper.smgt.sae.portal.DhcpProfile
Sets the value of radiusClass
setRadiusFramedIpAddress(int) - Method in class net.juniper.smgt.sae.portal.DhcpProfile
Sets the value of radiusFramedIpAddress
setRadiusFramedPool(String) - Method in class net.juniper.smgt.sae.portal.DhcpProfile
Sets the value of radiusFramedPool
setScheduledTime(ScheduledTime) - Method in class net.juniper.smgt.sae.portal.ScheduleEntry
Sets the time for the event using the given milliseconds time value.
setServerName(String) - Method in class net.juniper.smgt.sae.portal.DhcpProfile
Sets the value of serverName
setServiceBundle(String) - Method in class net.juniper.smgt.sae.portal.DhcpProfile
Sets the value of serviceBundle
setServiceName(String) - Method in class net.juniper.smgt.sae.portal.Action
Sets the value for this bean's serviceName property.
setServiceName(String) - Method in class net.juniper.smgt.sae.portal.Subscription
Setting this property specifies which of the user's subscribed services will be described or affected by all subsequent reads or writes of this bean's properties.
setServiceName(String) - Method in class net.juniper.smgt.sae.portal.Service
Determines which service will be described by all subsequent reads of this bean's properties.
setSessionName(String) - Method in class net.juniper.smgt.sae.portal.Subscription
Setting this property specifies which subscription session will be described or affected by all subsequent reads or writes of this bean's properties.
setSessionTag(String) - Method in class net.juniper.smgt.sae.portal.Subscription
Tag a service session.
setSessionTimeout(int) - Method in class net.juniper.smgt.sae.portal.Subscription
Specifies a session timeout to be used the next time the subscription session represented by this bean is activated (i.e.
setSessionTimeout(int) - Method in class net.juniper.smgt.sae.portal.User
Set the Session Timeout for the current user session.
setSessionVolumeQuota(String) - Method in class net.juniper.smgt.sae.portal.Subscription
Specifies a session volume quota to be used in the subscription session represented by this bean.
setSubscriptionPassword(String) - Method in class net.juniper.smgt.sae.portal.Subscription
If the subscribed service requires authentication, then the subscription username and subscription password properties must be set before this subscription is activated.
setSubscriptionUsername(String) - Method in class net.juniper.smgt.sae.portal.Subscription
If the subscribed service requires authentication, then the subscription username and subscription password properties must be set before this subscription is activated.
setSubstitutions(String[]) - Method in class net.juniper.smgt.sae.portal.Subscription
Sets the substitutions to be used the next time the subscription session represented by this bean is activated (i.e.
setTimeSpec(TimeSpec, int) - Method in class net.juniper.smgt.sae.portal.ScheduledTime
 
setTimeStamp(long) - Method in class net.juniper.smgt.sae.portal.User
Set the time stamp.
setTimeZone(String) - Method in class net.juniper.smgt.sae.portal.TimeSpec
 
setUpStreamBandwidth(int) - Method in class net.juniper.smgt.sae.portal.Subscription
Specifies a service up stream bandwidth to be used the next time the subscription session represented by this bean is activated (i.e.
setUserDn(String) - Method in class net.juniper.smgt.sae.portal.Subscription
Setting this property specifies which interface user's subscription will be described or affected by all subsequent reads or writes of this bean's properties.
setUserDn(String) - Method in class net.juniper.smgt.sae.portal.Service
Setting this property specifies which interface user's service will be described or affected by all subsequent reads or writes of this bean's properties.
setUserDn(String) - Method in class net.juniper.smgt.sae.portal.User
Determines which interface user will be described or affected by all subsequent calls to this bean's methods.
setUserIp(String) - Method in class net.juniper.smgt.sae.portal.Subscription
Setting this property specifies which user's subscription will be described or affected by all subsequent reads or writes of this bean's properties.
setUserIp(String) - Method in class net.juniper.smgt.sae.portal.Service
Setting this property specifies which user's service will be described or affected by all subsequent reads or writes of this bean's properties.
setUserIp(String) - Method in class net.juniper.smgt.sae.portal.User
Determines which user will be described or affected by all subsequent calls to this bean's methods.
setUserName(String) - Method in class net.juniper.smgt.sae.portal.DhcpProfile
Sets the value of userName
setVirtualRouterName(String) - Method in class net.juniper.smgt.sae.portal.DhcpProfile
Sets the value of virtualRouterName
setWebMessage(String) - Method in class net.juniper.smgt.sae.portal.SspException
Sets an English language message explaining the underlying reason why a Portal API operation failed.
setYear(String) - Method in class net.juniper.smgt.sae.portal.TimeSpec
 
Ssp - class net.juniper.smgt.sae.portal.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 SAE's LDAP directories.
SspException - exception net.juniper.smgt.sae.portal.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.
Subscription - class net.juniper.smgt.sae.portal.Subscription.
This bean represents the relationship between a currently logged in user and a currently loaded service to which the user is subscribed.
SUBSCRIPTION_AUTHORIZATION - Static variable in class net.juniper.smgt.sae.portal.ServiceAuthenticationException
If getReason() returns this value, this exception occurred because a subscription authorization plug-in forbid the attempted service self subscription or self unsubscription.
Subscription() - Constructor for class net.juniper.smgt.sae.portal.Subscription
The default bean constructor.
Subscription(User) - Constructor for class net.juniper.smgt.sae.portal.Subscription
 

T

TimeSpec - class net.juniper.smgt.sae.portal.TimeSpec.
The TimeSpec class encapsulates the time specification used in ScheduledTime
TimeSpec() - Constructor for class net.juniper.smgt.sae.portal.TimeSpec
Default constrcutor
TimeSpec(long) - Constructor for class net.juniper.smgt.sae.portal.TimeSpec
Constrcutor using a date
TimeSpec(String, String, String, String, String, String, String) - Constructor for class net.juniper.smgt.sae.portal.TimeSpec
Constrcutor with all the time spec attributes
TimeSpec(TimeSpec) - Constructor for class net.juniper.smgt.sae.portal.TimeSpec
Constrcutor using portal TimeSpec
toString() - Method in class net.juniper.smgt.sae.portal.OneTimeScheduleEntry
For debugging only.
toString() - Method in class net.juniper.smgt.sae.portal.Registration
For debugging only.
toString() - Method in class net.juniper.smgt.sae.portal.TimeSpec
For debugging only.
toString() - Method in class net.juniper.smgt.sae.portal.ScheduledTime
For debugging only.
toString() - Method in class net.juniper.smgt.sae.portal.Action
For debugging only.
toString() - Method in class net.juniper.smgt.sae.portal.ScheduleEntry
For debugging only.
toString() - Method in class net.juniper.smgt.sae.portal.Usage
For debugging only.
toString() - Method in class net.juniper.smgt.sae.portal.Subscription
For debugging only.
toString() - Method in class net.juniper.smgt.sae.portal.Service
For debugging only.
toString() - Method in class net.juniper.smgt.sae.portal.User
For debugging only.
toString() - Method in class net.juniper.smgt.sae.portal.DhcpProfile
 
toString(Attr[]) - Method in class net.juniper.smgt.sae.portal.Action
For debugging only.

U

UnknownServiceException - exception net.juniper.smgt.sae.portal.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 - exception net.juniper.smgt.sae.portal.UnknownServiceSessionException.
This exception is thrown when an attempt to modify the non-active subscription session discrebed by this bean.
UnknownSubscriptionException - exception net.juniper.smgt.sae.portal.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 - exception net.juniper.smgt.sae.portal.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.
unRegisterCurrentEquipment(String) - Static method in class net.juniper.smgt.sae.portal.Ssp
Deprecated. This method has been replaced by the unregisterEquipment and revokePublicIp methods.
unregisterEquipment(String, String, String) - Static method in class net.juniper.smgt.sae.portal.Ssp
Unregisters the specified client device.
unregisterLogin(String, String, String) - Static method in class net.juniper.smgt.sae.portal.Ssp
Cancels a persistent SAE login.
updatedScheduleEntry(String, ScheduledTime, Action[]) - Method in class net.juniper.smgt.sae.portal.User
Updates the scheduled time and actions of the ScheduleEntry for the Subscriber for the given date.
updatedScheduleEntryActions(long, Action[]) - Method in class net.juniper.smgt.sae.portal.User
Deprecated. Use updatedScheduleEntryActions(String id, Action[] aActions) instead. Convert long date to string date using String.valueOf(date).
updateSessionTimeout(int) - Method in class net.juniper.smgt.sae.portal.Subscription
Update the session timeout used in the subscription session represented by this bean.
updateSessionTimeout(int) - Method in class net.juniper.smgt.sae.portal.User
Update the session timeout for the user session object that this bean has been initialized to provide access to.
Usage - class net.juniper.smgt.sae.portal.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 - class net.juniper.smgt.sae.portal.User.
This bean represents a user currently logged in to SAE.
User() - Constructor for class net.juniper.smgt.sae.portal.User
The default bean constructor.

A B D F G H I L M N O P R S T U
Core API 5.0