Core API 7.15

net.juniper.smgt.sae.portal
Class Registration

java.lang.Object
  extended by net.juniper.smgt.sae.portal.Registration

public class Registration
extends java.lang.Object

Registration objects represent the information stored in SAE's LDAP directory during calls to the Ssp.registerLogin and Ssp.registerEquipment methods. Each registration object associates a DHCP client device (i.e. its MAC address) with a user profile in SAE's LDAP directory, or, with a set of credentials used to obtain a public IP address, as follows:

  1. Login registration: a login can be registered so that whenever a subscriber's client device receives an IP address (token or public) via DHCP, the subscriber's user profile is logged in to SAE and associated with that IP address. An LDAP distinguished name is stored in the the registration object, and is used to determine which user profile should be logged in. See the Ssp.registerLogin method for details.
  2. Equipment registration: a client device can be registered to receive a public IP address (i.e. not a token IP address) every time it issues a DHCP discover. The login name and password stored in the registration object will be sent to the E-series router and then to a RADIUS server for authentication every time the client device requests a new IP address via DHCP. If the authentication succeeds, the client device will receive a public IP address, rather than a token IP address. See the Ssp.registerEquipment method for details.

See Also:
Ssp.registerLogin(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String), Ssp.registerEquipment(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)

Method Summary
 java.lang.String getDescription()
          Returns the description that was specified at registration time.
 java.lang.String getIntfName()
          Returns the interface name that was specified at registration time.
 java.lang.String getLoginName()
          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.
 java.lang.String getMacAddress()
          Returns the MAC address that uniquely identifies the registered client device.
 java.lang.String getUserDn()
          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.
 java.lang.String getVrName()
          Returns the virtual router name that was specified at registration time.
 java.lang.String toString()
          For debugging only.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

getMacAddress

public java.lang.String getMacAddress()
Returns the MAC address that uniquely identifies the registered client device. This is the MAC address that was specified at registration time.


getLoginName

public java.lang.String getLoginName()
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.


getUserDn

public java.lang.String getUserDn()
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.

Returns:
Null, if this is object represents registered equipment rather than a registered login.
Since:
3.0

getIntfName

public java.lang.String getIntfName()
Returns the interface name that was specified at registration time.


getVrName

public java.lang.String getVrName()
Returns the virtual router name that was specified at registration time.


getDescription

public java.lang.String getDescription()
Returns the description that was specified at registration time.


toString

public java.lang.String toString()
For debugging only. Returns a description of this Registration object.

Overrides:
toString in class java.lang.Object

Core API 7.15