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

A

AccountingData - Class in net.juniper.smgt.sae.scriptservice
Contains accounting data collected when deactivating, modifying or polling a script service session.
AccountingData() - Constructor for class net.juniper.smgt.sae.scriptservice.AccountingData
 
AcctNotAvailException - Exception in net.juniper.smgt.sae.scriptservice
This class is a special ScriptServiceException which is thrown durring deactivation of a script service to indicate that accounting is not available at the moment
AcctNotAvailException(String) - Constructor for exception net.juniper.smgt.sae.scriptservice.AcctNotAvailException
Constructs a new AcctNotAvailException with the specified detail message.
AcctNotAvailException(String, int) - Constructor for exception net.juniper.smgt.sae.scriptservice.AcctNotAvailException
Constructs a new AcctNotAvailException with the specified detail message and retry time
Action - Class in net.juniper.smgt.sae.portal
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 exception net.juniper.smgt.sae.portal.ServiceAuthenticationException
If getReason() returns this value, this exception occurred because it is not allowed to deactivate an "activateOnly" service.
activateSession() - Method in class net.juniper.smgt.sae.scriptservice.NullScriptService
 
activateSession() - Method in interface net.juniper.smgt.sae.scriptservice.ScriptService
Activate the script service session.
ADD_BACKGROUND_RETRY - Static variable in class net.juniper.smgt.sae.portal.Subscription
A ADD_BACKGROUND_RETRY means that while the subscription is activated or deactivated, if a transitory problem happens, a background retry will be scheduled.
addScheduleEntry(ScheduleEntry) - Method in class net.juniper.smgt.sae.portal.User
Adds a ScheuldeEntry for the Subscriber.
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.
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, Map) - Method in class net.juniper.smgt.sae.portal.User
Subscribes the currently logged in user to the service specified by serviceName.
ANONYMOUS_USER - Static variable in exception 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.
append(String, long) - Method in interface net.juniper.smgt.sae.radiuslib.RadiusPacketDelegate
Includes a specified RADIUS attribute and its value in a RADIUS packet.
append(String, String) - Method in interface net.juniper.smgt.sae.radiuslib.RadiusPacketDelegate
Includes a specified RADIUS attribute and its value in a RADIUS packet.
AUTH_PRECLUDES_ACTIVATE_ON_LOGIN - Static variable in exception 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
Constant used when retrieving the data manager base DN.
BasicRadiusPluginEvent - Interface in net.juniper.smgt.sae.radiuslib
 

C

CoA_ACK - Static variable in interface net.juniper.smgt.sae.scriptservice.RadiusResponse
 
CoA_NAK - Static variable in interface net.juniper.smgt.sae.scriptservice.RadiusResponse
 
CommandChannel - Interface in net.juniper.smgt.sae.router.command
This class is used to send command to network device.
CommandException - Exception in net.juniper.smgt.sae.router.command
 
CommandException(String) - Constructor for exception net.juniper.smgt.sae.router.command.CommandException
 

D

DEACTIVATE - Static variable in class net.juniper.smgt.sae.portal.Action
A possible value for this bean's operation property.
deactivateSession() - Method in class net.juniper.smgt.sae.scriptservice.NullScriptService
 
deactivateSession() - Method in interface net.juniper.smgt.sae.scriptservice.ScriptService
Deactivate the script service session.
DEFAULT_SESSION_NAME - Static variable in class net.juniper.smgt.sae.portal.Subscription
The default value for this bean's sessionName property.
deleteScheduleEntry(String) - Method in class net.juniper.smgt.sae.portal.User
Delete the ScheduleEntry for the Subscriber for the given date.
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).
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.
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.
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 in net.juniper.smgt.sae.portal
Encapsulation of a single DHCP option.
DhcpOptions - Interface in net.juniper.smgt.sae.portal
Encapsulation of DHCP options.
DhcpPacket - Interface in net.juniper.smgt.sae.portal
Encapsulation of DHCP packet data.
DhcpProfile - Class in net.juniper.smgt.sae.portal
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
 
discarded() - Method in class net.juniper.smgt.sae.scriptservice.NullScriptService
 
discarded() - Method in interface net.juniper.smgt.sae.scriptservice.ScriptService
Notify that the service session has been discarded.
disconnect() - Method in class net.juniper.smgt.sae.portal.User
Disconnects a user from the SAE.
DISCONNECT_ACK - Static variable in interface net.juniper.smgt.sae.scriptservice.RadiusResponse
 
DISCONNECT_NAK - Static variable in interface net.juniper.smgt.sae.scriptservice.RadiusResponse
 

F

FILTERED_OUT - Static variable in exception 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.
formatRequest(RadiusPacketDelegate, int, RadiusPluginEvent) - Method in interface net.juniper.smgt.sae.radiuslib.RadiusPacketHandler
Formats a RADIUS request packet by including RADIUS attribute identifier-value pairs in the packet.
fragmentDown(String) - Method in class net.juniper.smgt.sae.portal.Subscription
Notify the user that activated the aggregate service that a fragment service session has been deactivated.
fragmentReactivating(String) - Method in class net.juniper.smgt.sae.portal.Subscription
Notify the user that activated the aggregate service that a fragment service session is reactivating.

G

getAccountingData() - Method in class net.juniper.smgt.sae.scriptservice.NullScriptService
 
getAccountingData() - Method in interface net.juniper.smgt.sae.scriptservice.ScriptService
Poll current accounting data.
getAccountingId() - Method in interface net.juniper.smgt.sae.radiuslib.BasicRadiusPluginEvent
Retrieves the value of the LDAP attribute accountingUserId.
getAccountingId() - Method in interface net.juniper.smgt.sae.scriptservice.ServiceSessionInfo
Get the user accounting ID.
getAcctSessionId() - Method in class net.juniper.smgt.sae.portal.Subscription
Returns the accounting session id for the subscription session represented by this bean.
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.
getAggrAccountingId() - Method in interface net.juniper.smgt.sae.radiuslib.BasicRadiusPluginEvent
Retrieves the accounting ID of the subscriber who started an aggregate service session.
getAggrAuthUserId() - Method in interface net.juniper.smgt.sae.radiuslib.BasicRadiusPluginEvent
Retrieves the user ID that was used to authenticate an aggregate service session.
getAggrLoginName() - Method in interface net.juniper.smgt.sae.radiuslib.BasicRadiusPluginEvent
Retrieves the login name of the subscriber who started an aggregate service session.
getAggrSessionId() - Method in interface net.juniper.smgt.sae.radiuslib.BasicRadiusPluginEvent
Retrieves the accounting session ID of an aggregate service session.
getAggrUserDn() - Method in interface net.juniper.smgt.sae.radiuslib.BasicRadiusPluginEvent
Retrieves the distinguished name (DN) of user profile of the subscriber who started an aggregate service session.
getAggrUserInetAddress() - Method in interface net.juniper.smgt.sae.radiuslib.BasicRadiusPluginEvent
Retrieves the IP address of the subscriber who started an aggregate service session.
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.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.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.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.Service
Get the names of the LDAP attributes defined for this service.
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.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
 
getAttributeValues(String) - Method in interface net.juniper.smgt.sae.radiuslib.RadiusPacketDelegate
Retrieves the attribute values from a RADIUS packet that has a specified identifier for an attribute.
getAttributeValues(String) - Method in interface net.juniper.smgt.sae.scriptservice.RadiusResponse
Retrieves the attribute values from a RADIUS packet that has a specified identifier for an attribute.
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).
getAuthUserId() - Method in interface net.juniper.smgt.sae.radiuslib.BasicRadiusPluginEvent
Retrieves the identifier that the subscriber uses for authentication.
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.DhcpOption
 
getBytes() - Method in interface net.juniper.smgt.sae.portal.DhcpOptions
Format set of DHCP options into TLV encoded byte array.
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.
getCallingStationId() - Method in class net.juniper.smgt.sae.portal.User
Returns the Calling-Station-Id associated with the primary interface of the subscriber
getCallingStationId() - Method in interface net.juniper.smgt.sae.radiuslib.BasicRadiusPluginEvent
Retrieves the Calling-Station-Id Type of assoicated events - Authorization and tracking.
getCallingStationId() - Method in interface net.juniper.smgt.sae.scriptservice.ServiceSessionInfo
Get Calling-Station-Id associated with the primary interface
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.
getCollectionTimestamp() - Method in class net.juniper.smgt.sae.portal.Usage
The time at which these usage statistics were collected from the network in milliseconds since 1970-01-01T00:00:00 UTC.
getCommandChannel() - Method in interface net.juniper.smgt.sae.scriptservice.ServiceSessionInfo
Returns the CommandChannel this service session attached to.
getCommandSyntax() - Method in interface net.juniper.smgt.sae.router.command.CommandChannel
Get command channel syntax
getCommandSyntax() - Method in class net.juniper.smgt.sae.router.command.UnsupportedCommandChannel
 
getCurrentIp() - Method in exception 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
 
getDebugLog() - Method in interface net.juniper.smgt.sae.scriptservice.ServiceSessionInfo
Returns a LogWriter object that can be used to print messages to the DEBUG log.
getDelegateTimeSpec() - Method in class net.juniper.smgt.sae.portal.TimeSpec
For internal use.
getDeprecatedProperties() - Static method in class net.juniper.smgt.sae.portal.Service
return a set of deprecated properties.
getDeprecatedProperties() - Static method in class net.juniper.smgt.sae.portal.Subscription
return a set of deprecated properties.
getDeprecatedProperties() - Static method in class net.juniper.smgt.sae.portal.User
return a set of deprecated properties.
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.
getDhcpPacket() - Method in interface net.juniper.smgt.sae.radiuslib.BasicRadiusPluginEvent
Retrieves the content of a DHCP discover request.
getDhcpPacket() - Method in interface net.juniper.smgt.sae.scriptservice.ServiceSessionInfo
Get DHCP options returned for DHCP users.
getDomain() - Method in interface net.juniper.smgt.sae.radiuslib.BasicRadiusPluginEvent
Retrieves the domain for secondary authentication.
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.
getDownstreamBandwidth() - Method in interface net.juniper.smgt.sae.radiuslib.BasicRadiusPluginEvent
Retrieves the downstream bandwidth (from the network to the subscriber) that is available for the service.
getDownStreamBandwidth() - Method in interface net.juniper.smgt.sae.scriptservice.ServiceSessionInfo
Get the service down stream bandwidth.
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.
getEffectivePeriod() - Method in class net.juniper.smgt.sae.portal.TimeSpec
 
getErrorLog() - Method in interface net.juniper.smgt.sae.scriptservice.ServiceSessionInfo
Returns a LogWriter object that can be used to print messages to the ERROR log.
getEventTime() - Method in class net.juniper.smgt.sae.portal.OneTimeScheduleEntry
Gets the time for the event using the given milliseconds time value.
getEventTime() - Method in interface net.juniper.smgt.sae.radiuslib.BasicRadiusPluginEvent
Retrieves the number of seconds since midnight 1970-01-01 UTC.
getEventTimeMillisecond() - Method in interface net.juniper.smgt.sae.radiuslib.BasicRadiusPluginEvent
Retrieves the number of milliseconds since midnight 1970-01-01 UTC.
getGiAddr() - Method in interface net.juniper.smgt.sae.portal.DhcpPacket
 
getHighWord(long) - Static method in class net.juniper.smgt.sae.radiuslib.RadiusPluginUtil
Retrieves the high 32 bits of a long value.
getHostName() - Method in interface net.juniper.smgt.sae.radiuslib.BasicRadiusPluginEvent
Retrieves the name of the host on which the SAE is installed.
getHostName() - Method in interface net.juniper.smgt.sae.scriptservice.ServiceSessionInfo
Get the host name.
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
 
getIfIndex() - Method in interface net.juniper.smgt.sae.radiuslib.BasicRadiusPluginEvent
Retrieves the SNMP index of interface.
getIfRadiusClass() - Method in interface net.juniper.smgt.sae.radiuslib.BasicRadiusPluginEvent
Retrieves the RADIUS class attribute of the underlying router interface.
getIfRadiusClass() - Method in interface net.juniper.smgt.sae.scriptservice.ServiceSessionInfo
Get the RadiusClass.
getIfSessionId() - Method in interface net.juniper.smgt.sae.radiuslib.BasicRadiusPluginEvent
Retrieves the identifier for RADIUS accounting of the underlying router interface.
getInfoLog() - Method in interface net.juniper.smgt.sae.scriptservice.ServiceSessionInfo
Returns a LogWriter object that can be used to print messages to the INFO log.
getInOctets() - Method in interface net.juniper.smgt.sae.radiuslib.BasicRadiusPluginEvent
Retrieves the number of 64-bit upstream (from the subscriber to the network) octets.
getInPackets() - Method in interface net.juniper.smgt.sae.radiuslib.BasicRadiusPluginEvent
Retrieves the number of 64-bit upstream (from the subscriber to the network) packets.
getInt() - Method in interface net.juniper.smgt.sae.portal.DhcpOption
 
getInterfaceAlias() - Method in interface net.juniper.smgt.sae.radiuslib.BasicRadiusPluginEvent
Retrieves the alias of the interface that is configured on a JUNOSe router by using the interface ip description command.
getInterfaceAlias() - Method in interface net.juniper.smgt.sae.scriptservice.ServiceSessionInfo
Get the interface alias, i.e. alternative description of managed interface.
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.
getInterfaceDescr() - Method in interface net.juniper.smgt.sae.radiuslib.BasicRadiusPluginEvent
Retrieves the alternative name of the interface that SNMP uses.
getInterfaceDescr() - Method in interface net.juniper.smgt.sae.scriptservice.ServiceSessionInfo
Get the interface description, i.e. a textual description of the managed interface.
getInterfaceName() - Method in interface net.juniper.smgt.sae.radiuslib.BasicRadiusPluginEvent
Retrieves the name of an interface.
getInterfaceName() - Method in interface net.juniper.smgt.sae.scriptservice.ServiceSessionInfo
Get the interface name.
getInterfaceSpeed() - Method in interface net.juniper.smgt.sae.radiuslib.BasicRadiusPluginEvent
Retrieves the speead of the interface.
getInterfaceSpeed() - Method in interface net.juniper.smgt.sae.scriptservice.ServiceSessionInfo
Get the interface speed
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.
getInterimTime() - Method in interface net.juniper.smgt.sae.radiuslib.BasicRadiusPluginEvent
Retrieves the accounting interim time in seconds.
getInterval() - Method in exception net.juniper.smgt.sae.scriptservice.AcctNotAvailException
 
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.
getLocalNasId() - Method in interface net.juniper.smgt.sae.radiuslib.BasicRadiusPluginEvent
Retrieves the identifier that the SAE uses to communicate with the RADIUS server.
getLocalNasIp() - Method in interface net.juniper.smgt.sae.radiuslib.BasicRadiusPluginEvent
Retrieves the IP address of the SAE that is used to communicate with the RADIUS server.
getLocalQosProfiles() - Method in class net.juniper.smgt.sae.portal.User
Get a map of local profiles.
getLocalQosProfiles() - Method in interface net.juniper.smgt.sae.radiuslib.BasicRadiusPluginEvent
 
getLocalQosProfiles() - Method in interface net.juniper.smgt.sae.scriptservice.ServiceSessionInfo
 
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.
getLoginId() - Method in interface net.juniper.smgt.sae.radiuslib.BasicRadiusPluginEvent
Retrieves the subscriber's login identifier (in the format that the subscriber enters it).
getLoginName() - Method in exception 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.
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 interface net.juniper.smgt.sae.radiuslib.BasicRadiusPluginEvent
Retrieves the subscriber's login name.
getLoginName() - Method in interface net.juniper.smgt.sae.scriptservice.ServiceSessionInfo
Get the user's login name.
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.
getLogWriter(String, byte) - Static method in class net.juniper.smgt.lib.logging.LogWriter
Use this static method to get a new LogWriter for a specified group and priority.
getLowWord(long) - Static method in class net.juniper.smgt.sae.radiuslib.RadiusPluginUtil
Retrieves the low 32 bits of a long value.
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.
getManagerId() - Method in interface net.juniper.smgt.sae.radiuslib.BasicRadiusPluginEvent
Retrieves the distinguished name (DN) of the IT administrator.
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 exception net.juniper.smgt.sae.portal.OverloadException
Returns an English language message explaining the underlying reason why a Portal API operation failed.
getMessage() - Method in exception net.juniper.smgt.sae.portal.SspException
Returns an English language message explaining the underlying reason why a Portal API operation failed.
getMessage() - Method in exception net.juniper.smgt.sae.portal.UnsupportedException
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.
getNasInetAddress() - Method in interface net.juniper.smgt.sae.radiuslib.BasicRadiusPluginEvent
Retrieves the IP address of the router.
getNasInetAddress() - Method in interface net.juniper.smgt.sae.scriptservice.ServiceSessionInfo
Get the IP address the virtual router uses for accounting purposes.
getNasIp() - Method in class net.juniper.smgt.sae.portal.User
Returns the IP address of the router which this user is connected.
getNasIp() - Method in interface net.juniper.smgt.sae.radiuslib.BasicRadiusPluginEvent
Retrieves the IP address of the router that is used to communicate with the RADIUS server.
getNasPort() - Method in interface net.juniper.smgt.sae.radiuslib.BasicRadiusPluginEvent
Retrieves the numeric identifier that the router uses to identify the interface to RADIUS.
getNasPort() - Method in interface net.juniper.smgt.sae.scriptservice.ServiceSessionInfo
Get NAS-Port, i.e. a numerical index that identifies the layer 2 interface.
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.
getOperational() - Method in interface net.juniper.smgt.sae.radiuslib.BasicRadiusPluginEvent
Retrieves the flag that identifies whether an interface was operational at the time of an event.
getOption(int) - Method in interface net.juniper.smgt.sae.portal.DhcpOptions
 
getOutOctets() - Method in interface net.juniper.smgt.sae.radiuslib.BasicRadiusPluginEvent
Retrieves the number of 64-bit downstream (from the network to the subscriber) octets.
getOutPackets() - Method in interface net.juniper.smgt.sae.radiuslib.BasicRadiusPluginEvent
Retrieves the number of 64-bit downstream (from the network to the subscriber) packets.
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.
getParameterSubstitutions(List) - Method in interface net.juniper.smgt.sae.scriptservice.ServiceSessionInfo
Get the requested parameter substitutions from the acquisition path.
getPassword() - Method in interface net.juniper.smgt.sae.radiuslib.BasicRadiusPluginEvent
Retrieves the password for secondary authentication.
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.
getPortId() - Method in interface net.juniper.smgt.sae.radiuslib.BasicRadiusPluginEvent
Retrieves the identifier of a virtual LAN (VLAN) or virtual circuit.
getPortId() - Method in interface net.juniper.smgt.sae.scriptservice.ServiceSessionInfo
Get NAS-Port-ID, i.e. a name of the interface including layer 2 access information.
getPrimaryUserName() - Method in class net.juniper.smgt.sae.portal.User
Return the primary user name of this User Session.
getPrimaryUserName() - Method in interface net.juniper.smgt.sae.radiuslib.BasicRadiusPluginEvent
Retrieves pppLoginName or publicDhcpUserName.
getPrimaryUserName() - Method in interface net.juniper.smgt.sae.scriptservice.ServiceSessionInfo
Get the primary user name.
getProperties() - Method in class net.juniper.smgt.sae.portal.Subscription
Deprecated. use getPropertyMap instead
getProperties() - Method in class net.juniper.smgt.sae.portal.User
Deprecated. use getPropertyMap instead
getProperties() - Method in interface net.juniper.smgt.sae.radiuslib.BasicRadiusPluginEvent
Retrieve the map of properties associated with the current session.
getPropertyMap() - Method in class net.juniper.smgt.sae.portal.Subscription
Get a map of service session properties.
getPropertyMap() - Method in class net.juniper.smgt.sae.portal.User
Get a map of user session properties.
getPublicDhcpUserName() - Method in class net.juniper.smgt.sae.portal.User
Deprecated. Use getPrimaryUserName instead
getRadiusClass() - Method in class net.juniper.smgt.sae.portal.DhcpProfile
Gets the value of radiusClass
getRadiusClass() - Method in class net.juniper.smgt.sae.portal.User
Returns radius class attribute from authorization plug-ins.
getRadiusClass() - Method in interface net.juniper.smgt.sae.radiuslib.BasicRadiusPluginEvent
Deprecated. Use BasicRadiusPluginEvent.getRadiusClassRaw() instead
getRadiusClassRaw() - Method in interface net.juniper.smgt.sae.radiuslib.BasicRadiusPluginEvent
Retrieves the RADIUS class attribute from the service definition.
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.
getRadiusSessionId() - Method in class net.juniper.smgt.sae.portal.Subscription
Returns the Radius service session ID e.g.
getRaw() - Method in interface net.juniper.smgt.sae.portal.DhcpPacket
 
getReason() - Method in exception 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.
getResponseCode() - Method in interface net.juniper.smgt.sae.scriptservice.RadiusResponse
 
getRetailerDn() - Method in interface net.juniper.smgt.sae.radiuslib.BasicRadiusPluginEvent
Retrieves the distinguished name (DN) of the retailer that is associated with the domain.
getRouterDynRadiusAddr() - Method in interface net.juniper.smgt.sae.scriptservice.ServiceSessionInfo
 
getRouterName() - Method in interface net.juniper.smgt.sae.radiuslib.BasicRadiusPluginEvent
Retrieves the name of the virtual router.
getRouterName() - Method in interface net.juniper.smgt.sae.scriptservice.ServiceSessionInfo
Get the router name.
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.
getServiceAttribute(String) - Method in interface net.juniper.smgt.sae.scriptservice.ServiceSessionInfo
Get the value for the named attribute of the service.
getServiceAttributeNames() - Method in interface net.juniper.smgt.sae.scriptservice.ServiceSessionInfo
Get the names of the attributes of the service.
getServiceBundle() - Method in class net.juniper.smgt.sae.portal.DhcpProfile
Gets the value of serviceBundle
getServiceBundle() - Method in class net.juniper.smgt.sae.portal.User
Returns service bundle attribute from authorization plug-ins.
getServiceBundle() - Method in interface net.juniper.smgt.sae.radiuslib.BasicRadiusPluginEvent
Retrieves the service bundle RADIUS VSA.
getServiceBundle() - Method in interface net.juniper.smgt.sae.scriptservice.ServiceSessionInfo
Get ServiceBundle string associated with authenticated lifecyle handle.
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.
getServiceDirectory() - Method in interface net.juniper.smgt.sae.scriptservice.ServiceSessionInfo
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.Service
Returns the service name with which this bean was initialized.
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 interface net.juniper.smgt.sae.radiuslib.BasicRadiusPluginEvent
Retrieves the name of service.
getServiceName() - Method in interface net.juniper.smgt.sae.scriptservice.ServiceSessionInfo
Get the service name.
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.
getServiceScope() - Method in interface net.juniper.smgt.sae.radiuslib.BasicRadiusPluginEvent
Retrieves the list of service scopes.
getServiceSessionAcctSessionId() - Method in class net.juniper.smgt.sae.portal.Subscription
Returns the accounting session id for the subscription session represented by this bean.
getServiceSessionName() - Method in interface net.juniper.smgt.sae.radiuslib.BasicRadiusPluginEvent
Retrieves the name of service session.
getServiceSessionName() - Method in interface net.juniper.smgt.sae.scriptservice.ServiceSessionInfo
Get the session name.
getServiceSessionTag() - Method in interface net.juniper.smgt.sae.radiuslib.BasicRadiusPluginEvent
Retrieves the tag of service session.
getServiceSessionTag() - Method in interface net.juniper.smgt.sae.scriptservice.ServiceSessionInfo
Get the service session tag.
getSessionHandle() - Method in class net.juniper.smgt.sae.portal.User
Returns this user's session handle (e.g.
getSessionId() - Method in class net.juniper.smgt.sae.portal.Service
Returns the user's session ID from the user bean which this bean was initialized (e.g.
getSessionId() - Method in class net.juniper.smgt.sae.portal.Subscription
Returns the session ID with which this bean was initialized (e.g.
getSessionId() - Method in class net.juniper.smgt.sae.portal.User
Returns this user's session ID (e.g.
getSessionId() - Method in interface net.juniper.smgt.sae.radiuslib.BasicRadiusPluginEvent
Retrieves the RADIUS session ID.
getSessionId() - Method in interface net.juniper.smgt.sae.scriptservice.ServiceSessionInfo
Get the session id.
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.
getSessionTime() - Method in interface net.juniper.smgt.sae.radiuslib.BasicRadiusPluginEvent
Retrieves the length of session in seconds.
getSessionTimeout() - Method in interface net.juniper.smgt.sae.radiuslib.BasicRadiusPluginEvent
Retrieves the maximum length of the session in seconds.
getSessionVolumeQuota() - Method in class net.juniper.smgt.sae.portal.Subscription
Returns the session volume quota for the subscription session represented by this bean.
getSessionVolumeQuota() - Method in interface net.juniper.smgt.sae.scriptservice.ServiceSessionInfo
Get the session volume quota.
getSourceBean() - Method in exception net.juniper.smgt.sae.portal.NonUniqueUserException
Returns the User bean that threw this exception.
getSourceBean() - Method in exception 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 exception net.juniper.smgt.sae.portal.UnknownServiceException
Returns the Service bean that threw this exception.
getSourceBean() - Method in exception net.juniper.smgt.sae.portal.UnknownServiceSessionException
Returns the Subscription bean that threw this exception.
getSourceBean() - Method in exception net.juniper.smgt.sae.portal.UnknownSubscriptionException
Returns the Subscription bean that threw this exception.
getSourceBean() - Method in exception net.juniper.smgt.sae.portal.UnknownUserException
Returns the User 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.
getStartTime() - Method in interface net.juniper.smgt.sae.scriptservice.ServiceSessionInfo
Get the start time.
getState() - Method in class net.juniper.smgt.sae.scriptservice.NullScriptService
 
getState() - Method in interface net.juniper.smgt.sae.scriptservice.ScriptService
Return opaque state data that will be stored persistently on the router.
getString() - Method in interface net.juniper.smgt.sae.portal.DhcpOption
 
getSubOptions() - Method in interface net.juniper.smgt.sae.portal.DhcpOption
 
getSubscriptionAndServiceSessionNames() - Method in class net.juniper.smgt.sae.portal.User
Returns the name of every service to which this user is subscribed to and the name of subscriptions of active service sessions to which this user is not subscribed to but has an active session (i.e. fragment session from an aggregate service session).
getSubscriptionAttributes() - Method in class net.juniper.smgt.sae.portal.Subscription
Returns the Map of attributes defined for the subscription currently represented by this bean.
getSubscriptionName() - Method in class net.juniper.smgt.sae.portal.Subscription
Returns the subscription name with which this bean was initialized (e.g.
getSubscriptionName() - Method in interface net.juniper.smgt.sae.radiuslib.BasicRadiusPluginEvent
Retrieves the name of the subscription.
getSubscriptionName() - Method in interface net.juniper.smgt.sae.scriptservice.ServiceSessionInfo
Get the subscription name.
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.
getSubstitutions() - Method in interface net.juniper.smgt.sae.scriptservice.ServiceSessionInfo
Get the substitutions.
getTerminateCause() - Method in interface net.juniper.smgt.sae.radiuslib.BasicRadiusPluginEvent
Retrieves the cause of RADIUS termination.
getTerminateCause() - Method in interface net.juniper.smgt.sae.scriptservice.ServiceSessionInfo
Gets the reason the service session was stopped
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.
getUid() - Method in interface net.juniper.smgt.sae.radiuslib.BasicRadiusPluginEvent
Retrieves the subscriber ID used for secondary authentication.
getUpStreamBandwidth() - Method in class net.juniper.smgt.sae.portal.Subscription
Return the service up stream bandwidth for the subscription session represented by this bean.
getUpstreamBandwidth() - Method in interface net.juniper.smgt.sae.radiuslib.BasicRadiusPluginEvent
Retrieves the upstream bandwidth (from the subscriber to the network) that is available for the service.
getUpStreamBandwidth() - Method in interface net.juniper.smgt.sae.scriptservice.ServiceSessionInfo
Get the service up stream bandwidth.
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.
getUserDirectory() - Method in interface net.juniper.smgt.sae.scriptservice.ServiceSessionInfo
Returns a javax.naming.DirContext object that can be used 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.Service
Returns the LDAP dististinguished name with which this bean was initialized (e.g.
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.User
Returns the LDAP distinguished name with which this bean was initialized (e.g.
getUserDn() - Method in interface net.juniper.smgt.sae.radiuslib.BasicRadiusPluginEvent
Retrieves the distinguished name (DN) of a user profile.
getUserDn() - Method in interface net.juniper.smgt.sae.scriptservice.ServiceSessionInfo
Get the LDAP distinguished name of the loaded user profile assigned to the user.
getUserInetAddress() - Method in interface net.juniper.smgt.sae.radiuslib.BasicRadiusPluginEvent
Retrieves the IP address of the subscriber.
getUserInetAddress() - Method in interface net.juniper.smgt.sae.scriptservice.ServiceSessionInfo
Get the InetAddress associated with PPP or DHCP user.
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.Subscription
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.
getUserIpAddress() - Method in interface net.juniper.smgt.sae.radiuslib.BasicRadiusPluginEvent
Retrieves the IP address of the PPP subscriber.
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.
getUserMacAddress() - Method in interface net.juniper.smgt.sae.radiuslib.BasicRadiusPluginEvent
Retrieves the media access control (MAC) address of a DHCP subscriber.
getUserMacAddress() - Method in interface net.juniper.smgt.sae.scriptservice.ServiceSessionInfo
Get MAC address of DHCP user.
getUserName() - Method in class net.juniper.smgt.sae.portal.DhcpProfile
Gets the value of userName
getUserProperties() - Method in interface net.juniper.smgt.sae.radiuslib.BasicRadiusPluginEvent
Retrieve the map of properties associated with the current subscriber session.
getUserRadiusClass() - Method in interface net.juniper.smgt.sae.radiuslib.BasicRadiusPluginEvent
Retrieves the RADIUS class of the subscriber session for a service.
getUserRadiusClass() - Method in interface net.juniper.smgt.sae.scriptservice.ServiceSessionInfo
Get radius class.
getUserSession() - Method in class net.juniper.smgt.sae.portal.User
Returns the UserSession object that this bean has been initialized to provide access to.
getUserSessionId() - Method in interface net.juniper.smgt.sae.radiuslib.BasicRadiusPluginEvent
Retrieves the identifier of RADIUS sessions for subscriber sessions.
getUserSessionId() - Method in interface net.juniper.smgt.sae.scriptservice.ServiceSessionInfo
Get the user session ID.
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.
getUserType() - Method in interface net.juniper.smgt.sae.radiuslib.BasicRadiusPluginEvent
Retrieves the type of subscriber.
getUserType() - Method in interface net.juniper.smgt.sae.scriptservice.ServiceSessionInfo
Get the user type.
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.
getVirtualRouterName() - Method in class net.juniper.smgt.sae.portal.User
Return the virtual router name with which this bean was initialized.
getVpnId() - Method in class net.juniper.smgt.sae.portal.User
 
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 exception 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
Deprecated. Use the method User.grantPublicIp of class User instead.
grantPublicIp(String, String, String, DhcpProfile) - Static method in class net.juniper.smgt.sae.portal.Ssp
Deprecated. Use the method User.grantPublicIp of class User instead.
grantPublicIp(String, String) - Method in class net.juniper.smgt.sae.portal.User
Assigns a public IP address to the specified user.
grantPublicIp(String, String, DhcpProfile) - Method in class net.juniper.smgt.sae.portal.User
Assigns a public IP address to the specified user.

H

handleInputError(short, String) - Method in class net.juniper.smgt.sae.portal.ScheduledTime
 
handleResponse(RadiusPacketDelegate, int, RadiusPluginEvent) - Method in interface net.juniper.smgt.sae.radiuslib.RadiusPacketHandler
Retrieves attribute values from a RADIUS authorization response packet and updates the plug-in event with these values.
hasTimeInRange(long, long) - Method in class net.juniper.smgt.sae.portal.ScheduledTime
 

I

IGNORE_REASON - Static variable in class net.juniper.smgt.sae.portal.Subscription
A IGNORE_REASON means that while the subscription is activated, the reason for deactivating parameter is ignored.
INHERITED_SUBSCRIPTION - Static variable in exception 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.
initSessionInfo(ServiceSessionInfo) - Method in class net.juniper.smgt.sae.scriptservice.NullScriptService
 
initSessionInfo(ServiceSessionInfo) - Method in interface net.juniper.smgt.sae.scriptservice.ScriptService
Provide session information to the script service.
initState(ServiceSessionInfo, byte[]) - Method in class net.juniper.smgt.sae.scriptservice.NullScriptService
 
initState(ServiceSessionInfo, byte[]) - Method in interface net.juniper.smgt.sae.scriptservice.ScriptService
Initialize a recovered script service session after synchronization of the state.
inOctets - Variable in class net.juniper.smgt.sae.scriptservice.AccountingData
 
inPackets - Variable in class net.juniper.smgt.sae.scriptservice.AccountingData
 
INVISIBLE - Static variable in exception 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.
isAcctOffRequest(int) - Static method in class net.juniper.smgt.sae.radiuslib.RadiusPluginUtil
Checks whether the action that the method receives is for an Accounting-Off request.
isAcctOnOffRequest(int) - Static method in class net.juniper.smgt.sae.radiuslib.RadiusPluginUtil
Checks whether the action that the method receives is for an Accounting-On or Accounting-Off request.
isAcctOnRequest(int) - Static method in class net.juniper.smgt.sae.radiuslib.RadiusPluginUtil
Checks whether the action that the method receives is for an Accounting-On request.
isAcctRequest(int) - Static method in class net.juniper.smgt.sae.radiuslib.RadiusPluginUtil
Checks whether the action that the method receives is for an accounting request.
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.
isAuthRequest(int) - Static method in class net.juniper.smgt.sae.radiuslib.RadiusPluginUtil
Checks whether the action that the method receives is for an authorization request.
isAuthResp(int) - Static method in class net.juniper.smgt.sae.radiuslib.RadiusPluginUtil
Checks whether the action that the method receives is for an authorization response.
isBeingRemoved() - Method in interface net.juniper.smgt.sae.scriptservice.ServiceSessionInfo
Returns true if this service session is being removed if true - the script service must be cleaned up there will be no furthur attempts to collect accounting
isCorbaCall(boolean) - Method in class net.juniper.smgt.sae.portal.Subscription
 
isCurrentlyAvailable() - Method in class net.juniper.smgt.sae.portal.Subscription
Returns true if the user's subscription to the service is currently available.
isDhcpAuthRequest(int) - Static method in class net.juniper.smgt.sae.radiuslib.RadiusPluginUtil
Checks whether the action that the method receives is for a DHCP authorization request.
isDhcpAuthResp(int) - Static method in class net.juniper.smgt.sae.radiuslib.RadiusPluginUtil
Checks whether the action that the method receives is for a DHCP authorization response.
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.Subscription
Returns true 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
Deprecated. ISP services are no longer supported
isLoggingIn() - Method in interface net.juniper.smgt.sae.scriptservice.ServiceSessionInfo
Returns true if this user session is in the process of activating the automatically on login services
isLoggingOut() - Method in interface net.juniper.smgt.sae.scriptservice.ServiceSessionInfo
Returns true if this user session is in the process of or has previously been logged out
isOperational() - Method in class net.juniper.smgt.sae.portal.Usage
 
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
Deprecated. Use isAddressUser and getPrimaryUserName instead
isStartRequest(int) - Static method in class net.juniper.smgt.sae.radiuslib.RadiusPluginUtil
Checks whether the action that the method receives is for a start request.
isStartStopRequest(int) - Static method in class net.juniper.smgt.sae.radiuslib.RadiusPluginUtil
Checks whether the action that the method receives is for a start or stop request.
isStopRequest(int) - Static method in class net.juniper.smgt.sae.radiuslib.RadiusPluginUtil
Checks whether the action that the method receives is for a stop request.
isSubscribed() - Method in class net.juniper.smgt.sae.portal.Subscription
Returns true if the user is subscribed to the service.
isSupported() - Method in interface net.juniper.smgt.sae.router.command.CommandChannel
Check if command channel is available
isSupported() - Method in class net.juniper.smgt.sae.router.command.UnsupportedCommandChannel
 
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.
isSvcAcctRequest(int) - Static method in class net.juniper.smgt.sae.radiuslib.RadiusPluginUtil
Checks whether the action that the method receives is for a service session start, stop or interim request.
isSvcAuthRequest(int) - Static method in class net.juniper.smgt.sae.radiuslib.RadiusPluginUtil
Checks whether the action that the method receives is for a service authorization request.
isSvcAuthResp(int) - Static method in class net.juniper.smgt.sae.radiuslib.RadiusPluginUtil
Checks whether the action that the method receives is for a service session authorization response.
isSvcStartRequest(int) - Static method in class net.juniper.smgt.sae.radiuslib.RadiusPluginUtil
Checks whether the action that the method receives is for a service session start request.
isSvcStopRequest(int) - Static method in class net.juniper.smgt.sae.radiuslib.RadiusPluginUtil
Checks whether the action that the method receives is for a service session stop request.
isTokenDhcpUser() - Method in class net.juniper.smgt.sae.portal.User
Deprecated. Use isAddressUser and getPrimaryUserName instead
isUnauthenticated() - Method in class net.juniper.smgt.sae.portal.User
Returns true only if the user is unauthenticated.
isUserAcctRequest(int) - Static method in class net.juniper.smgt.sae.radiuslib.RadiusPluginUtil
Checks whether the action that the method receives is for a subscriber session start, stop or interim request.
isUserAuthRequest(int) - Static method in class net.juniper.smgt.sae.radiuslib.RadiusPluginUtil
Checks whether the action that the method receives is for a user authorization request.
isUserAuthResp(int) - Static method in class net.juniper.smgt.sae.radiuslib.RadiusPluginUtil
Checks whether the action that the method receives is for a subscriber session authorization response.
isUserStartRequest(int) - Static method in class net.juniper.smgt.sae.radiuslib.RadiusPluginUtil
Checks whether the action that the method receives is for a subscriber session start request.
isUserStopRequest(int) - Static method in class net.juniper.smgt.sae.radiuslib.RadiusPluginUtil
Checks whether the action that the method receives is for a subscriber session stop request.
iterator() - Method in interface net.juniper.smgt.sae.portal.DhcpOptions
 

L

login(String, String) - Method in class net.juniper.smgt.sae.portal.User
Logs a user into SAE.
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 in net.juniper.smgt.sae.portal
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.
logout() - Method in class net.juniper.smgt.sae.portal.User
Logs a user out of 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
Deprecated. Use the method User.logout of class User instead.
LogWriter - Class in net.juniper.smgt.lib.logging
This class prints messages to a log.

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.
modifySession(ServiceSessionInfo) - Method in class net.juniper.smgt.sae.scriptservice.NullScriptService
 
modifySession(ServiceSessionInfo) - Method in interface net.juniper.smgt.sae.scriptservice.ScriptService
Modify the script service session.
MUTEX_GROUPS - Static variable in exception 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.lib.logging - package net.juniper.smgt.lib.logging
 
net.juniper.smgt.sae.portal - package net.juniper.smgt.sae.portal
This package is the core SAE API.
net.juniper.smgt.sae.radiuslib - package net.juniper.smgt.sae.radiuslib
 
net.juniper.smgt.sae.router.command - package net.juniper.smgt.sae.router.command
 
net.juniper.smgt.sae.scriptservice - package net.juniper.smgt.sae.scriptservice
 
NO_BACKGROUND_RETRY - Static variable in class net.juniper.smgt.sae.portal.Subscription
A NO_BACKGROUND_RETRY means that while the subscription is activated or deactivated, if a transitory problem happens, no background retry will be scheduled.
NO_SESSION_MODIFICATION - Static variable in exception 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.
NO_VALUE - Static variable in interface net.juniper.smgt.sae.radiuslib.BasicRadiusPluginEvent
 
NonUniqueUserException - Exception in net.juniper.smgt.sae.portal
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.
NullScriptService - Class in net.juniper.smgt.sae.scriptservice
No-op implementation of the ScriptService interface.
NullScriptService() - Constructor for class net.juniper.smgt.sae.scriptservice.NullScriptService
 

O

OneTimeScheduleEntry - Class in net.juniper.smgt.sae.portal
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
outOctets - Variable in class net.juniper.smgt.sae.scriptservice.AccountingData
 
outPackets - Variable in class net.juniper.smgt.sae.scriptservice.AccountingData
 
OverloadException - Exception in net.juniper.smgt.sae.portal
This exception is thrown when the COPS interface is currently overloaded.

P

PERSISTENT_ACTIVATION - Static variable in exception net.juniper.smgt.sae.portal.ServiceAuthenticationException
If getReason() returns this value, this exception occurred when failed to a add a persistent activation.
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 in net.juniper.smgt.sae.portal
This is the superclass of all exceptions thrown by the Portal API.
println(String) - Method in class net.juniper.smgt.lib.logging.LogWriter
Append the string to the Buffer and then flush the whole Buffer as a single string to the log.
println(String, Throwable) - Method in class net.juniper.smgt.lib.logging.LogWriter
 
printStackTrace(PrintWriter) - Method in exception net.juniper.smgt.sae.portal.PortalException
For debugging only.
PUBLIC_IP_AUTHENTICATION - Static variable in exception 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.
pushCommand(String, int) - Method in interface net.juniper.smgt.sae.router.command.CommandChannel
send the command to network device.
pushCommand(String, int) - Method in class net.juniper.smgt.sae.router.command.UnsupportedCommandChannel
 

R

RadiusPacketDelegate - Interface in net.juniper.smgt.sae.radiuslib
This interface provides methods to include an identifier for a RADIUS attribute and a value for that attribute in a RADIUS packet.
RadiusPacketFailedAccessException - Exception in net.juniper.smgt.sae.radiuslib
This exception is raised when a string that represents an identifier for a RADIUS attribute does not correspond to a valid RADIUS attribute, or when the value of a RADIUS attribute is different from the expected type.
RadiusPacketFailedAccessException(String) - Constructor for exception net.juniper.smgt.sae.radiuslib.RadiusPacketFailedAccessException
Creates a RadiusPacketFailedAccessException that includes a specified message to provide information about the error.
RadiusPacketFailedAccessException(Throwable) - Constructor for exception net.juniper.smgt.sae.radiuslib.RadiusPacketFailedAccessException
Creates a RadiusPacketFailedAccessException that provides information about the cause of the error.
RadiusPacketHandler - Interface in net.juniper.smgt.sae.radiuslib
This interface is intended to be implemented by a system integrator to define RADIUS attributes to be sent to a RADIUS server when various types of requests are made, and to define which attributes should be retrieved from a RADIUS authorization response for update to the plug-in event.
RadiusPluginEvent - Interface in net.juniper.smgt.sae.radiuslib
This interface provides a group of getter and setter methods which dynamically access RADIUS attribute values in a plug-in event.
RadiusPluginUtil - Class in net.juniper.smgt.sae.radiuslib
This class provides static methods to handle (interpret or decode) encoded actions which are numeric representations of a RADIUS request or response.
RadiusPluginUtil() - Constructor for class net.juniper.smgt.sae.radiuslib.RadiusPluginUtil
 
RadiusResponse - Interface in net.juniper.smgt.sae.scriptservice
 
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 in net.juniper.smgt.sae.portal
Registration objects represent the information stored in SAE's LDAP directory during calls to the Ssp.registerLogin and Ssp.registerEquipment methods.
reset - Variable in class net.juniper.smgt.sae.scriptservice.AccountingData
This boolean should be set if the accounting data has been reset since the time of the last collection
Response - Interface in net.juniper.smgt.sae.router.command
The response from network device for command sent through command channel
revokePublicIp(String) - Static method in class net.juniper.smgt.sae.portal.Ssp
Deprecated. Use the method User.revokePublicIp of class User instead.
revokePublicIp() - Method in class net.juniper.smgt.sae.portal.User
Revokes the public IP address held by the specified user.

S

ScheduledTime - Class in net.juniper.smgt.sae.portal
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 in net.juniper.smgt.sae.portal
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
ScriptService - Interface in net.juniper.smgt.sae.scriptservice
The ScriptService interface defines an SPI that must be implemented by the script service.
ScriptServiceException - Exception in net.juniper.smgt.sae.scriptservice
ScriptServiceException is a user exception the script service implementation can throw while activating, deactivating, modifying, or polling accounting info of the service fails.
ScriptServiceException(String) - Constructor for exception net.juniper.smgt.sae.scriptservice.ScriptServiceException
 
sendDynamicRadius(InetSocketAddress, byte, int, Map, String, InetSocketAddress, String, int) - Method in interface net.juniper.smgt.sae.scriptservice.ServiceSessionInfo
Send dynamic authorization request to radius client
Service - Class in net.juniper.smgt.sae.portal
This bean represents a service currently loaded into SAE from the SAE's LDAP directory.
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
 
SERVICE_AUTHORIZATION - Static variable in exception 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 exception net.juniper.smgt.sae.portal.ServiceAuthenticationException
If getReason() returns this value, this exception occurred because the service is not currently available for subscription.
ServiceAuthenticationException - Exception in net.juniper.smgt.sae.portal
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.
ServiceSessionInfo - Interface in net.juniper.smgt.sae.scriptservice
Provide information of a service session to a script service.
setAcctInterimTime(long) - Method in interface net.juniper.smgt.sae.radiuslib.RadiusPluginEvent
Sets the accounting interim time.
setAcctSessionId(String) - Method in class net.juniper.smgt.sae.portal.Subscription
Specifies an accounting session id to be used the next time the subscription session represented by this bean is activated (i.e.
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.
setActive(boolean, int, int) - Method in class net.juniper.smgt.sae.portal.Subscription
Activates or deactivates this subscription session.
setAggregateAccountingId(String) - Method in class net.juniper.smgt.sae.portal.Subscription
Specifies the accounting ID of the user that started the aggregate service session.
setAggregateAuthUserId(String) - Method in class net.juniper.smgt.sae.portal.Subscription
Specifies the authentication user ID that was used to authenticate the aggregate service session.
setAggregateFragmentIsLocal(boolean) - Method in class net.juniper.smgt.sae.portal.Subscription
The aggregate service session sets this flag based on the user ref expression retrieved from the fragment service definition.
setAggregateFragmentSessionId(String) - Method in class net.juniper.smgt.sae.portal.Subscription
The aggregate service session sets the fragment session id to be used by the drone session when notifying the aggregate service session about fragment down.
setAggregateLoginName(String) - Method in class net.juniper.smgt.sae.portal.Subscription
Specifies the login name of the user that started the aggregate service session.
setAggregateServiceName(String) - Method in class net.juniper.smgt.sae.portal.Subscription
Specifies the name of the aggregate service in the fragment service.
setAggregateSessionId(String) - Method in class net.juniper.smgt.sae.portal.Subscription
Specifies the session ID of the aggregate service session in the fragment service.
setAggregateSessionName(String) - Method in class net.juniper.smgt.sae.portal.Subscription
Specifies the name of the aggregate service session in the fragment service.
setAggregateUserDn(String) - Method in class net.juniper.smgt.sae.portal.Subscription
Specifies the DN of the user profile of the user that started the aggregate service session.
setAggregateUserIdType(String) - Method in class net.juniper.smgt.sae.portal.Subscription
Specifies how to look up the user.
setAggregateUserIp(String) - Method in class net.juniper.smgt.sae.portal.Subscription
Specifies the IP address of the user that started the aggregate service session.
setAggregateUserSessionId(String) - Method in class net.juniper.smgt.sae.portal.Subscription
Specifies the RADIUS session ID of the user that started the aggregate service session.
setAggregateVr(String) - Method in class net.juniper.smgt.sae.portal.Subscription
Specifies the virtual router that contains the user session of the aggregate service.
setAttributes(Attr[]) - Method in class net.juniper.smgt.sae.portal.Action
 
setAuthVirtualRouterName(String) - Method in interface net.juniper.smgt.sae.radiuslib.RadiusPluginEvent
Sets the name of the JUNOSe virtual router on which the address pool is located.
setBackground(boolean) - Method in class net.juniper.smgt.sae.portal.Subscription
Specifies background action to be used the next time the subscription session represented by this bean is activated (i.e.
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.
setEffectivePeriod(String) - Method in class net.juniper.smgt.sae.portal.TimeSpec
 
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
 
setIdleTimeout(long) - Method in interface net.juniper.smgt.sae.radiuslib.RadiusPluginEvent
Sets the idle timeout for a service session.
setInterimTime(int) - Method in class net.juniper.smgt.sae.portal.Subscription
Specifies the interval, in seconds, between service interim records to be used the next time the subscription session represented by this bean is activated.
setLeaseTime(int) - Method in class net.juniper.smgt.sae.portal.DhcpProfile
Sets the value of leaseTime
setLoadServices(String) - Method in interface net.juniper.smgt.sae.radiuslib.RadiusPluginEvent
Sets the list of services to which the subscriber has access.
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.
setPoolName(String) - Method in interface net.juniper.smgt.sae.radiuslib.RadiusPluginEvent
Sets the name of the address pool on a JUNOSe router from which an address is assigned.
setProperties(Set) - Method in class net.juniper.smgt.sae.portal.Subscription
Set the service session properties.
setProperty(String) - Method in interface net.juniper.smgt.sae.radiuslib.RadiusPluginEvent
Sets the session property in the form <name> = <value>.
setRadiusClass(String) - Method in class net.juniper.smgt.sae.portal.DhcpProfile
Sets the value of radiusClass
setRadiusClass(String) - Method in interface net.juniper.smgt.sae.radiuslib.RadiusPluginEvent
Sets the RADIUS class attribute.
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
setReplyMessage(String) - Method in interface net.juniper.smgt.sae.radiuslib.RadiusPluginEvent
Sets message string that a plug-in returns to the SAE during authorization.
setRequireAggregateSubscription(boolean) - Method in class net.juniper.smgt.sae.portal.Subscription
If set to 'true', the activation of the fragment requires that the service is subscribed by the hosting user session.
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
setServiceBundle(String) - Method in interface net.juniper.smgt.sae.radiuslib.RadiusPluginEvent
Sets the service bundle RADIUS VSA.
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.Service
Determines which service will be described by all subsequent reads of this bean's properties.
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.
setServiceSessionVolumeQuota(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.
setSessionId(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.
setSessionId(String) - Method in class net.juniper.smgt.sae.portal.Subscription
Setting this property specifies which user's service will be described or affected by all subsequent reads or writes of this bean's properties.
setSessionId(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.
setSessionInterimTime(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.
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.
setSessionTimeout(long) - Method in interface net.juniper.smgt.sae.radiuslib.RadiusPluginEvent
Sets the maximum length of a session in seconds.
setSessionVolumeQuota(String) - Method in class net.juniper.smgt.sae.portal.Subscription
Specifies a session volume quota to be used the next time the subscription session represented by this bean is activated.
setSessionVolumeQuota(String) - Method in interface net.juniper.smgt.sae.radiuslib.RadiusPluginEvent
Sets the total volume of data in megabytes (MB) that a subscriber is allowed to upload or download.
setSubscriptionActivationOrder(String) - Method in class net.juniper.smgt.sae.portal.Subscription
Specifies the relative order of automatically activation of the subscription to be added.
setSubscriptionActivationTrigger(String) - Method in class net.juniper.smgt.sae.portal.Subscription
Specifies the action of the subscription to be added.
setSubscriptionDeletedFlag(String) - Method in class net.juniper.smgt.sae.portal.Subscription
Specifies the deleted flag of the subscription to be added.
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.
setSubscriptionStatus(String) - Method in class net.juniper.smgt.sae.portal.Subscription
Specifies the status of the subscription to be added.
setSubscriptionSubstitutions(String[]) - Method in class net.juniper.smgt.sae.portal.Subscription
Specifies the substitutions of the subscription to be added.
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.
setSubstitution(String) - Method in interface net.juniper.smgt.sae.radiuslib.RadiusPluginEvent
Sets the parameter substitution in the form <name> = <expression>.
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.
setTerminateTime(String) - Method in interface net.juniper.smgt.sae.radiuslib.RadiusPluginEvent
Sets the time to end a subscriber session.
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.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.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.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.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.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.User
Determines which user will be described or affected by all subsequent calls to this bean's methods.
setUserIpAddress(long) - Method in interface net.juniper.smgt.sae.radiuslib.RadiusPluginEvent
Sets the IP address of a PPP subscriber.
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
setVirtualRouterName(String) - Method in class net.juniper.smgt.sae.portal.User
Set the virtual router name.
setWebMessage(String) - Method in exception 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 in net.juniper.smgt.sae.portal
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.
SspException - Exception in net.juniper.smgt.sae.portal
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.
stopService(int) - Method in interface net.juniper.smgt.sae.scriptservice.ServiceSessionInfo
Deactivate the service session.
Subscription - Class in net.juniper.smgt.sae.portal
This bean represents the relationship between a currently logged in user and a currently loaded service to which the user is subscribed.
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
 
SUBSCRIPTION_AUTHORIZATION - Static variable in exception 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.
SYNTAX_JUNOSCRIPT - Static variable in interface net.juniper.smgt.sae.router.command.CommandChannel
command channel syntax
SYNTAX_SNMP - Static variable in interface net.juniper.smgt.sae.router.command.CommandChannel
 

T

TimeSpec - Class in net.juniper.smgt.sae.portal
The TimeSpec class encapsulates the time specification used in ScheduledTime
TimeSpec() - Constructor for class net.juniper.smgt.sae.portal.TimeSpec
Default constrcutor
TimeSpec(String, String, String, String, String, String, String) - Constructor for class net.juniper.smgt.sae.portal.TimeSpec
Constructor with all the Time spec attributes EXCEPT effectivePeriod
TimeSpec(String, String, String, String, String, String, String, String) - Constructor for class net.juniper.smgt.sae.portal.TimeSpec
Constructor with all the time spec attributes INCLUDING effective period.
TimeSpec(long) - Constructor for class net.juniper.smgt.sae.portal.TimeSpec
Constrcutor using a date
TimeSpec(TimeSpec) - Constructor for class net.juniper.smgt.sae.portal.TimeSpec
Constrcutor using portal TimeSpec
toString() - Method in class net.juniper.smgt.sae.portal.Action
For debugging only.
toString(Attr[]) - Method in class net.juniper.smgt.sae.portal.Action
For debugging only.
toString() - Method in interface net.juniper.smgt.sae.portal.DhcpOption
 
toString() - Method in class net.juniper.smgt.sae.portal.DhcpProfile
 
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.ScheduledTime
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.Service
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.TimeSpec
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.User
For debugging only.
toString() - Method in interface net.juniper.smgt.sae.router.command.Response
 
TRANSIENT_EXCEPTION - Static variable in exception net.juniper.smgt.sae.portal.ServiceAuthenticationException
If getReason() returns this value, this exception occurred when activation or deactivation failed due to a transitory problem.

U

UnknownServiceException - Exception in net.juniper.smgt.sae.portal
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 in net.juniper.smgt.sae.portal
This exception is thrown when an attempt is made to access the non-active subscription session described by this bean.
UnknownSubscriptionException - Exception in net.juniper.smgt.sae.portal
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 in net.juniper.smgt.sae.portal
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.
UnsupportedCommandChannel - Class in net.juniper.smgt.sae.router.command
dummy command channel for those router drivers who doesn't support it yet
UnsupportedCommandChannel() - Constructor for class net.juniper.smgt.sae.router.command.UnsupportedCommandChannel
 
UnsupportedException - Exception in net.juniper.smgt.sae.portal
UnsupportedException.java Created: Mon Dec 3 12:18:29 2007
UnsupportedException(String) - Constructor for exception net.juniper.smgt.sae.portal.UnsupportedException
 
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 in net.juniper.smgt.sae.portal
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 in net.juniper.smgt.sae.portal
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 C D F G H I L M N O P R S T U
Core API 7.6