Core API 7.13

net.juniper.smgt.sae.radiuslib
Interface BasicRadiusPluginEvent

All Known Subinterfaces:
RadiusPluginEvent

public interface BasicRadiusPluginEvent


Field Summary
static long NO_VALUE
           
 
Method Summary
 java.lang.String getAccountingId()
          Retrieves the value of the LDAP attribute accountingUserId.
 java.lang.String getAggrAccountingId()
          Retrieves the accounting ID of the subscriber who started an aggregate service session.
 java.lang.String getAggrAuthUserId()
          Retrieves the user ID that was used to authenticate an aggregate service session.
 java.lang.String getAggrLoginName()
          Retrieves the login name of the subscriber who started an aggregate service session.
 java.lang.String getAggrSessionId()
          Retrieves the accounting session ID of an aggregate service session.
 java.lang.String getAggrUserDn()
          Retrieves the distinguished name (DN) of user profile of the subscriber who started an aggregate service session.
 java.net.InetAddress getAggrUserInetAddress()
          Retrieves the IP address of the subscriber who started an aggregate service session.
 java.lang.String getAuthUserId()
          Retrieves the identifier that the subscriber uses for authentication.
 java.lang.String getCallingStationId()
          Retrieves the Calling-Station-Id Type of assoicated events - Authorization and tracking.
 byte[] getDhcpPacket()
          Retrieves the content of a DHCP discover request.
 java.lang.String getDomain()
          Retrieves the domain for secondary authentication.
 long getDownstreamBandwidth()
          Retrieves the downstream bandwidth (from the network to the subscriber) that is available for the service.
 long getEventTime()
          Retrieves the number of seconds since midnight 1970-01-01 UTC.
 long getEventTimeMillisecond()
          Retrieves the number of milliseconds since midnight 1970-01-01 UTC.
 java.lang.String getHostName()
          Retrieves the name of the host on which the SAE is installed.
 long getIfIndex()
          Retrieves the SNMP index of interface.
 java.lang.String[] getIfRadiusClass()
          Retrieves the RADIUS class attribute of the underlying router interface.
 java.lang.String getIfSessionId()
          Retrieves the identifier for RADIUS accounting of the underlying router interface.
 long getInOctets()
          Retrieves the number of 64-bit upstream (from the subscriber to the network) octets.
 long getInPackets()
          Retrieves the number of 64-bit upstream (from the subscriber to the network) packets.
 java.lang.String getInterfaceAlias()
          Retrieves the alias of the interface that is configured on a JUNOSe router by using the interface ip description command.
 java.lang.String getInterfaceDescr()
          Retrieves the alternative name of the interface that SNMP uses.
 java.lang.String getInterfaceName()
          Retrieves the name of an interface.
 long getInterfaceSpeed()
          Retrieves the speead of the interface.
 long getInterimTime()
          Retrieves the accounting interim time in seconds.
 java.lang.String getLocalNasId()
          Retrieves the identifier that the SAE uses to communicate with the RADIUS server.
 long getLocalNasIp()
          Retrieves the IP address of the SAE that is used to communicate with the RADIUS server.
 java.util.Map getLocalQosProfiles()
           
 java.lang.String getLoginId()
          Retrieves the subscriber's login identifier (in the format that the subscriber enters it).
 java.lang.String getLoginName()
          Retrieves the subscriber's login name.
 java.lang.String getManagerId()
          Retrieves the distinguished name (DN) of the IT administrator.
 java.net.InetAddress getNasInetAddress()
          Retrieves the IP address of the router.
 long getNasIp()
          Retrieves the IP address of the router that is used to communicate with the RADIUS server.
 long getNasPort()
          Retrieves the numeric identifier that the router uses to identify the interface to RADIUS.
 long getOperational()
          Retrieves the flag that identifies whether an interface was operational at the time of an event.
 long getOutOctets()
          Retrieves the number of 64-bit downstream (from the network to the subscriber) octets.
 long getOutPackets()
          Retrieves the number of 64-bit downstream (from the network to the subscriber) packets.
 java.lang.String getPassword()
          Retrieves the password for secondary authentication.
 java.lang.String getPortId()
          Retrieves the identifier of a virtual LAN (VLAN) or virtual circuit.
 java.lang.String getPrimaryUserName()
          Retrieves pppLoginName or publicDhcpUserName.
 java.util.Map getProperties()
          Retrieve the map of properties associated with the current session.
 java.lang.String[] getRadiusClass()
          Deprecated. Use getRadiusClassRaw() instead
 byte[][] getRadiusClassRaw()
          Retrieves the RADIUS class attribute from the service definition.
 java.lang.String getRetailerDn()
          Retrieves the distinguished name (DN) of the retailer that is associated with the domain.
 java.lang.String getRouterName()
          Retrieves the name of the virtual router.
 java.lang.String getServiceBundle()
          Retrieves the service bundle RADIUS VSA.
 java.lang.String getServiceName()
          Retrieves the name of service.
 java.lang.String getServiceScope()
          Retrieves the list of service scopes.
 java.lang.String getServiceSessionName()
          Retrieves the name of service session.
 java.lang.String getServiceSessionTag()
          Retrieves the tag of service session.
 java.lang.String getSessionId()
          Retrieves the RADIUS session ID.
 long getSessionTime()
          Retrieves the length of session in seconds.
 long getSessionTimeout()
          Retrieves the maximum length of the session in seconds.
 java.lang.String getSubscriptionName()
          Retrieves the name of the subscription.
 long getTerminateCause()
          Retrieves the cause of RADIUS termination.
 java.lang.String getUid()
          Retrieves the subscriber ID used for secondary authentication.
 long getUpstreamBandwidth()
          Retrieves the upstream bandwidth (from the subscriber to the network) that is available for the service.
 java.lang.String getUserDn()
          Retrieves the distinguished name (DN) of a user profile.
 java.net.InetAddress getUserInetAddress()
          Retrieves the IP address of the subscriber.
 long getUserIpAddress()
          Retrieves the IP address of the PPP subscriber.
 java.lang.String getUserMacAddress()
          Retrieves the media access control (MAC) address of a DHCP subscriber.
 java.util.Map getUserProperties()
          Retrieve the map of properties associated with the current subscriber session.
 java.lang.String[] getUserRadiusClass()
          Retrieves the RADIUS class of the subscriber session for a service.
 java.lang.String getUserSessionId()
          Retrieves the identifier of RADIUS sessions for subscriber sessions.
 java.lang.String getUserType()
          Retrieves the type of subscriber.
 

Field Detail

NO_VALUE

static final long NO_VALUE
See Also:
Constant Field Values
Method Detail

getLocalNasIp

long getLocalNasIp()
Retrieves the IP address of the SAE that is used to communicate with the RADIUS server.

Types of associated events - Authorization and tracking.

Returns:
IP address of the SAE.

getLocalNasId

java.lang.String getLocalNasId()
Retrieves the identifier that the SAE uses to communicate with the RADIUS server.

Types of associated events - Authorization and tracking.

Returns:
SAE identifier.

getAuthUserId

java.lang.String getAuthUserId()
Retrieves the identifier that the subscriber uses for authentication.

Types of associated events - Tracking

Returns:
Identifier that the subscriber uses for authentication; null if the attribute is not available in this plug-in event.

getHostName

java.lang.String getHostName()
Retrieves the name of the host on which the SAE is installed.

Types of associated events - Authorization and tracking.

Returns:
Name of the host on which the SAE is installed.

getRouterName

java.lang.String getRouterName()
Retrieves the name of the virtual router.

Types of associated events - Authorization and tracking.

Returns:
Name of the virtual router.

getInterfaceName

java.lang.String getInterfaceName()
Retrieves the name of an interface. For example fastethernet 3/1.

Types of associated events - Authorization and tracking.

Returns:
Name of the interface.

getInterfaceAlias

java.lang.String getInterfaceAlias()
Retrieves the alias of the interface that is configured on a JUNOSe router by using the interface ip description command.

Types of associated events - Authorization and tracking.

Returns:
Alias for the interface.

getInterfaceDescr

java.lang.String getInterfaceDescr()
Retrieves the alternative name of the interface that SNMP uses.

Types of associated events - Authorization and tracking.

Returns:
Alternative name of the interface that SNMP uses.

getInterfaceSpeed

long getInterfaceSpeed()
Retrieves the speead of the interface.

Types of associated events - Authorization and tracking.

Returns:
speed of interface.

getPortId

java.lang.String getPortId()
Retrieves the identifier of a virtual LAN (VLAN) or virtual circuit. This attribute is not supported on JUNOS routing platforms.

Types of associated events - Authorization and tracking.

Returns:
Identifier of the VLAN or virtual circuit.

getNasPort

long getNasPort()
Retrieves the numeric identifier that the router uses to identify the interface to RADIUS.

Types of associated events - Authorization and tracking.

Returns:
Numeric identifier that the router uses to identify the interface to RADIUS.

getIfRadiusClass

java.lang.String[] getIfRadiusClass()
Retrieves the RADIUS class attribute of the underlying router interface. This attribute is not supported on JUNOS routing platforms.

Types of associated events - Authorization and tracking.

Returns:
RADIUS class attribute of the underlying router interface.

getServiceBundle

java.lang.String getServiceBundle()
Retrieves the service bundle RADIUS VSA.

Types of associated events - Authorization and tracking.

Returns:
Service bundle RADIUS VSA.

getCallingStationId

java.lang.String getCallingStationId()
Retrieves the Calling-Station-Id

Type of assoicated events - Authorization and tracking.

Returns:
Calling-Station-Id

getUserIpAddress

long getUserIpAddress()
Retrieves the IP address of the PPP subscriber.

Types of associated events - Authorization and tracking.

Returns:
IP address of the PPP subscriber.

getLoginName

java.lang.String getLoginName()
Retrieves the subscriber's login name.

Types of associated events - Authorization and tracking.

Returns:
Login name of the subscriber.

getLoginId

java.lang.String getLoginId()
Retrieves the subscriber's login identifier (in the format that the subscriber enters it).

Types of associated events - Authorization.

Returns:
Login identifier for the subscriber; null if the attribute is not available in this plug-in event.

getRadiusClass

java.lang.String[] getRadiusClass()
Deprecated. Use getRadiusClassRaw() instead

Retrieves the RADIUS class attribute from the service definition. This attribute can occur multiple times. This attribute is not supported on JUNOS routing platforms.

Types of associated events - Tracking, ServiceAuthorization.

Returns:
RADIUS class attribute in the service definition; an empty String array if the attribute is not available in this plug-in event.

getRadiusClassRaw

byte[][] getRadiusClassRaw()
Retrieves the RADIUS class attribute from the service definition. This attribute can occur multiple times. This attribute is not supported on JUNOS routing platforms.

Types of associated events - Tracking, ServiceAuthorization.

Returns:
RADIUS class attribute in the service definition; an empty array if the attribute is not available in this plug-in event.

getAccountingId

java.lang.String getAccountingId()
Retrieves the value of the LDAP attribute accountingUserId.

Types of associated events - Authorization and tracking.

Returns:
Value of the LDAP attribute accountingUserId.

getUserDn

java.lang.String getUserDn()
Retrieves the distinguished name (DN) of a user profile.

Types of associated events - Authorization and tracking.

Returns:
DN of the user profile.

getEventTime

long getEventTime()
Retrieves the number of seconds since midnight 1970-01-01 UTC.

Types of associated events - Authorization and tracking.

Returns:
Number of seconds since midnight 1970-01-01 UTC.

getEventTimeMillisecond

long getEventTimeMillisecond()
Retrieves the number of milliseconds since midnight 1970-01-01 UTC.

Types of associated events - Authorization and tracking.

Returns:
Number of milliseconds since midnight 1970-01-01 UTC.

getNasIp

long getNasIp()
Retrieves the IP address of the router that is used to communicate with the RADIUS server. This attribute is not supported on JUNOS routing platforms.

Types of associated events - Authorization and tracking.

Returns:
Router IP address for RADIUS communication.

getUserMacAddress

java.lang.String getUserMacAddress()
Retrieves the media access control (MAC) address of a DHCP subscriber. This attribute is not supported on JUNOS routing platforms.

Types of associated events - Authorization and tracking.

Returns:
MAC address of the DHCP subscriber.

getDhcpPacket

byte[] getDhcpPacket()
Retrieves the content of a DHCP discover request. This attribute is not supported on JUNOS routing platforms.

Types of associated events - Authorization and tracking.

Returns:
Content of the DHCP discover request; an empty byte array if the attribute has no value.

getUserType

java.lang.String getUserType()
Retrieves the type of subscriber.

Types of associated events - Authorization and tracking.

Returns:
Subscriber type.

getDownstreamBandwidth

long getDownstreamBandwidth()
Retrieves the downstream bandwidth (from the network to the subscriber) that is available for the service.

Types of associated events - ServiceAuthorization, ServiceTracking.

Returns:
Downstream bandwidth for the service; NO_VALUE if the attribute is not available in this plug-in event.

getUpstreamBandwidth

long getUpstreamBandwidth()
Retrieves the upstream bandwidth (from the subscriber to the network) that is available for the service.

Types of associated events - ServiceAuthorization, ServiceTracking.

Returns:
Upstream bandwidth for the service; NO_VALUE if the attribute is not available in this plug-in event.

getInOctets

long getInOctets()
Retrieves the number of 64-bit upstream (from the subscriber to the network) octets.

Types of associated events - StopServiceTracking, InterimServiceTracking.

Returns:
Number of 64-bit upstream octets; NO_VALUE if the attribute is not available in this plug-in event.

getOutOctets

long getOutOctets()
Retrieves the number of 64-bit downstream (from the network to the subscriber) octets.

Types of associated events - StopServiceTracking, InterimServiceTracking.

Returns:
Number of 64-bit downstream octets; NO_VALUE if the attribute is not available in this plug-in event.

getInPackets

long getInPackets()
Retrieves the number of 64-bit upstream (from the subscriber to the network) packets.

Types of associated events - StopServiceTracking, InterimServiceTracking.

Returns:
Number of 64-bit upstream packets; NO_VALUE if the attribute is not available in this plugin event.

getOutPackets

long getOutPackets()
Retrieves the number of 64-bit downstream (from the network to the subscriber) packets.

Types of associated events - StopServiceTracking, InterimServiceTracking.

Returns:
Number of 64-bit downstream packets; NO_VALUE if the attribute is not available in this plugin event.

getServiceName

java.lang.String getServiceName()
Retrieves the name of service.

Types of associated events - ServiceAuthorization, SubscriptionAuthorization, ServiceTracking.

Returns:
Name of the service; null if the attribute is not available in this plug-in event.

getServiceScope

java.lang.String getServiceScope()
Retrieves the list of service scopes.

Types of associated events - ServiceAuthorization, ServiceTracking.

Returns:
List of service scopes; null if the attribute is not available in this plug-in event.

getServiceSessionName

java.lang.String getServiceSessionName()
Retrieves the name of service session.

Types of associated events - ServiceTracking.

Returns:
Name of service session; null if the attribute is not available in this plug-in event.

getServiceSessionTag

java.lang.String getServiceSessionTag()
Retrieves the tag of service session.

Types of associated events - ServiceTracking.

Returns:
Tag for the service session; null if the attribute is not available in this plug-in event.

getSessionTimeout

long getSessionTimeout()
Retrieves the maximum length of the session in seconds.

Types of associated events - ServiceAuthorization, UserAuthorization, Tracking.

Returns:
Maximum length of the session in seconds; NO_VALUE if the attribute is not available in this plug-in event.

getSubscriptionName

java.lang.String getSubscriptionName()
Retrieves the name of the subscription.

Types of associated events - ServiceTracking.

Returns:
Name of the subscription; null if the attribute is not available in this plug-in event.

getIfSessionId

java.lang.String getIfSessionId()
Retrieves the identifier for RADIUS accounting of the underlying router interface. This attribute is not supported on JUNOS routing platforms.

Types of associated events - Tracking.

Returns:
Identifier for RADIUS accounting of the underlying router interface; null if the attribute is not available in this plug-in event.

getUserRadiusClass

java.lang.String[] getUserRadiusClass()
Retrieves the RADIUS class of the subscriber session for a service.

Types of associated events - ServiceTracking.

Returns:
RADIUS class of the subscriber session for a service; an empty String array if the attribute is not available in this plug-in event.

getUserSessionId

java.lang.String getUserSessionId()
Retrieves the identifier of RADIUS sessions for subscriber sessions.

Types of associated events - ServiceAuthorization.

Returns:
Identifier of RADIUS sessions for subscriber sessions; null if the attribute is not available in this plug-in event.

getPrimaryUserName

java.lang.String getPrimaryUserName()
Retrieves pppLoginName or publicDhcpUserName. This attribute is not supported on JUNOS routing platforms.

Types of associated events - Authorization and tracking.

Returns:
pppLoginName or publicDhcpUserName

getSessionId

java.lang.String getSessionId()
Retrieves the RADIUS session ID.

Types of associated events - Authorization and tracking.

Returns:
RADIUS session ID.

getSessionTime

long getSessionTime()
Retrieves the length of session in seconds.

Types of associated events - StopTracking, InterimTracking.

Returns:
Length of session in seconds; NO_VALUE if the attribute is not available in this plug-in event.

getTerminateCause

long getTerminateCause()
Retrieves the cause of RADIUS termination.

Types of associated events - StopTracking.

Returns:
Cause of RADIUS termination; NO_VALUE if the attribute is not available in this plug-in event.

getUid

java.lang.String getUid()
Retrieves the subscriber ID used for secondary authentication.

Types of associated events - Authorization.

Returns:
Subscriber ID used for secondary authentication; null if the attribute is not available in this plug-in event.

getDomain

java.lang.String getDomain()
Retrieves the domain for secondary authentication.

Types of associated events - Authorization.

Returns:
Domain for secondary authentication; null if the attribute is not available in this plug-in event.

getRetailerDn

java.lang.String getRetailerDn()
Retrieves the distinguished name (DN) of the retailer that is associated with the domain.

Types of associated events - Authorization.

Returns:
Retailer DN associated with the domain; null if the attribute is not available in this plug-in event.

getPassword

java.lang.String getPassword()
Retrieves the password for secondary authentication.

Types of associated events - Authorization.

Returns:
Password for secondary authentication; null if the attribute is not available in this plug-in event.

getIfIndex

long getIfIndex()
Retrieves the SNMP index of interface. This attribute is not supported on JUNOS routing platforms.

Types of associated events - InterfaceTracking.

Returns:
SNMP index of the interface; NO_VALUE if the attribute is not available in this plug-in event.

getUserInetAddress

java.net.InetAddress getUserInetAddress()
Retrieves the IP address of the subscriber. This method is equivalent to getUserIpAddress() for IPv4, but it allows extension to IPv6 (which is not yet supported in the SDX software).

Types of associated events - Authorization and tracking.

Returns:
IP address of the subscriber.

getNasInetAddress

java.net.InetAddress getNasInetAddress()
Retrieves the IP address of the router. This method is equivalent to getNasIp() for IPv4, but it allows extension to IPv6 (which is not yet supported in the SDX software).

Types of associated events - Authorization and tracking.

Returns:
IP address of the router.

getAggrSessionId

java.lang.String getAggrSessionId()
Retrieves the accounting session ID of an aggregate service session. This attribute includes the ID of the SAE that started the session.

Types of associated events - ServiceTracking.

Returns:
Accounting session ID of the aggregate service session; null if the attribute is not available in this plug-in event.

getAggrLoginName

java.lang.String getAggrLoginName()
Retrieves the login name of the subscriber who started an aggregate service session.

Types of associated events - ServiceTracking.

Returns:
Login name of the subscriber; null if the attribute is not available in this plug-in event.

getAggrUserDn

java.lang.String getAggrUserDn()
Retrieves the distinguished name (DN) of user profile of the subscriber who started an aggregate service session.

Types of associated events - ServiceTracking.

Returns:
DN of user profile; null if the attribute is not available in this plug-in event.

getAggrUserInetAddress

java.net.InetAddress getAggrUserInetAddress()
Retrieves the IP address of the subscriber who started an aggregate service session.

Types of associated events - ServiceTracking.

Returns:
IP address of the subscriber; null if the attribute is not available in this plug-in event.

getAggrAccountingId

java.lang.String getAggrAccountingId()
Retrieves the accounting ID of the subscriber who started an aggregate service session.

Types of associated events - ServiceTracking.

Returns:
Accounting ID of the subscriber; null if the attribute is not available in this plug-in event.

getAggrAuthUserId

java.lang.String getAggrAuthUserId()
Retrieves the user ID that was used to authenticate an aggregate service session.

Types of associated events - ServiceTracking.

Returns:
User ID; null if the attribute is not available in this plug-in event.

getInterimTime

long getInterimTime()
Retrieves the accounting interim time in seconds.

Types of associated events - Tracking.

Returns:
Accounting interim time in seconds; NO_VALUE if the attribute is not available in this plug-in event.

getManagerId

java.lang.String getManagerId()
Retrieves the distinguished name (DN) of the IT administrator.

Types of associated events - Tracking.

Returns:
DN of the IT administrator; null if the attribute is not available in this plug-in event.

getOperational

long getOperational()
Retrieves the flag that identifies whether an interface was operational at the time of an event.

Types of associated events - StopServiceTracking, InterimServiceTracking.

Returns:
Flag that identifies whether an interface was operational at the time of the event; NO_VALUE if the attribute is not available in this plug-in event.

getProperties

java.util.Map getProperties()
Retrieve the map of properties associated with the current session.

Returns:
a Map of session properties

getUserProperties

java.util.Map getUserProperties()
Retrieve the map of properties associated with the current subscriber session.

Returns:
map of subscriber properties for service events, null for subscriber events.

getLocalQosProfiles

java.util.Map getLocalQosProfiles()

Core API 7.13