net.juniper.smgt.sae.radiuslib
Interface RadiusPluginEvent

All Superinterfaces:

BasicRadiusPluginEvent

public interface RadiusPluginEvent

extends BasicRadiusPluginEvent

This interface provides a group of getter and setter methods which dynamically access RADIUS attribute values in a plug-in event.

Field Summary

Fields inherited from interface net.juniper.smgt.sae.radiuslib.BasicRadiusPluginEvent

NO_VALUE

Method Summary

boolean	setAcctInterimTime(long interval) Sets the accounting interim time.
boolean	setAuthVirtualRouterName(String vrName) Sets the name of the JUNOSe virtual router on which the address pool is located.
boolean	setIdleTimeout(long idleTimeout) Sets the idle timeout for a service session.
boolean	setLoadServices(String services) Sets the list of services to which the subscriber has access.
boolean	setPoolName(String poolName) Sets the name of the address pool on a JUNOSe router from which an address is assigned.
boolean	setProperty(String property) Sets the session property in the form <name> = <value>.
boolean	setRadiusClass(String radiusClass) Sets the RADIUS class attribute.
boolean	setReplyMessage(String message) Sets message string that a plug-in returns to the SAE during authorization.
boolean	setServiceBundle(String serviceBundle) Sets the service bundle RADIUS VSA.
boolean	setSessionTimeout(long timeout) Sets the maximum length of a session in seconds.
boolean	setSessionVolumeQuota(String sessionVolumeQuota) Sets the total volume of data in megabytes (MB) that a subscriber is allowed to upload or download.
boolean	setSubstitution(String substitution) Sets the parameter substitution in the form <name> = <expression>.
boolean	setTerminateTime(String time) Sets the time to end a subscriber session.
boolean	setUserIpAddress(long ipAddress) Sets the IP address of a PPP subscriber.

Methods inherited from interface net.juniper.smgt.sae.radiuslib.BasicRadiusPluginEvent

getAccountingId, getAggrAccountingId, getAggrAuthUserId, getAggrLoginName, getAggrSessionId, getAggrUserDn, getAggrUserInetAddress, getAuthUserId, getDhcpPacket, getDomain, getDownstreamBandwidth, getEventTime, getEventTimeMillisecond, getHostName, getIfIndex, getIfRadiusClass, getIfSessionId, getInOctets, getInPackets, getInterfaceAlias, getInterfaceDescr, getInterfaceName, getInterfaceSpeed, getInterimTime, getLocalNasId, getLocalNasIp, getLoginId, getLoginName, getManagerId, getNasInetAddress, getNasIp, getNasPort, getOperational, getOutOctets, getOutPackets, getPassword, getPortId, getPrimaryUserName, getRadiusClass, getRetailerDn, getRouterName, getServiceBundle, getServiceName, getServiceScope, getServiceSessionName, getServiceSessionTag, getSessionId, getSessionTime, getSessionTimeout, getSubscriptionName, getTerminateCause, getUid, getUpstreamBandwidth, getUserDn, getUserInetAddress, getUserIpAddress, getUserMacAddress, getUserRadiusClass, getUserSessionId, getUserType

Method Detail

setServiceBundle

public boolean setServiceBundle(String serviceBundle)

Sets the service bundle RADIUS VSA.

Types of associated events - UserAuthorization, DhcpAuthorization.

Parameters:

serviceBundle - RADIUS service bundle VSA.

Returns:

true if the attribute can be set in this plug-in event. Otherwise returns false.

setRadiusClass

public boolean setRadiusClass(String radiusClass)

Sets the RADIUS class attribute. This method can be called multiple times to set different values. This attribute is not supported on JUNOS routing platforms.

Types of associated events - UserAuthorization, DhcpAuthorization, ServiceAuthorization.

Parameters:

radiusClass - RADIUS class attribute.

Returns:

true if the attribute can be set in this plug-in event. Otherwise returns false.

setSessionTimeout

public boolean setSessionTimeout(long timeout)

Sets the maximum length of a session in seconds.

Types of associated events - UserAuthorization, ServiceAuthorization.

Parameters:

timeout - the session timeout (in seconds)

Returns:

true if the attribute can be set in this plug-in event. Otherwise returns false.

setLoadServices

public boolean setLoadServices(String services)

Sets the list of services to which the subscriber has access.

Types of associated events - UserAuthorization.

Parameters:

services - List of services to which the subscriber has access.

Returns:

true if the attribute can be set in this plug-in event. Otherwise returns false.

setProperty

public boolean setProperty(String property)

Sets the session property in the form <name> = <value>. This method can be called multiple times to set different values.

Types of associated events - UserAuthorization, ServiceAuthorization.

Parameters:

property - Session property.

Returns:

true if the attribute can be set in this plug-in event. Otherwise returns false.

setSubstitution

public boolean setSubstitution(String substitution)

Sets the parameter substitution in the form <name> = <expression>. This method can be called multiple times to set different values.

Types of associated events - UserAuthorization, ServiceAuthorization.

Parameters:

substitution - Substitution.

Returns:

true if the attribute can be set in this plug-in event. Otherwise returns false.

setTerminateTime

public boolean setTerminateTime(String time)

Sets the time to end a subscriber session.

Parameters:

time - Time to end a subscriber session.

Returns:

true if the attribute can be set in this plug-in event. Otherwise returns false.

setAcctInterimTime

public boolean setAcctInterimTime(long interval)

Sets the accounting interim time. Calling this method overrides the global accounting interim time and the accounting interim time set in a service definition.

Types of associated events - UserAuthorization, ServiceAuthorization.

Parameters:

interval - Interim accounting interval (in seconds).

Returns:

true if the attribute can be set in this plug-in event. Otherwise returns false.

setSessionVolumeQuota

public boolean setSessionVolumeQuota(String sessionVolumeQuota)

Sets the total volume of data in megabytes (MB) that a subscriber is allowed to upload or download.

Types of associated events - ServiceAuthorization.

Parameters:

sessionVolumeQuota - Total volume of data in megabytes (MB) that a subscriber is allowed to upload or download.

Returns:

true if the attribute can be set in this plug-in event. Otherwise returns false.

setIdleTimeout

public boolean setIdleTimeout(long idleTimeout)

Sets the idle timeout for a service session.

Types of associated events - ServiceAuthorization.

Parameters:

idleTimeout - Idle timeout for a service session (in seconds).

Returns:

true if the attribute can be set in this plug-in event. Otherwise returns false.

setUserIpAddress

public boolean setUserIpAddress(long ipAddress)

Sets the IP address of a PPP subscriber.

Types of associated events - DhcpAuthorization.

Parameters:

ipAddress - IP address of the PPP subscriber.

Returns:

true if the attribute can be set in this plug-in event. Otherwise returns false.

setPoolName

public boolean setPoolName(String poolName)

Sets the name of the address pool on a JUNOSe router from which an address is assigned. It is not supported on JUNOS routing platforms.

Types of associated events - DhcpAuthorization.

Parameters:

poolName - Name of the address pool.

Returns:

true if the attribute can be set in this plug-in event. Otherwise returns false.

setAuthVirtualRouterName

public boolean setAuthVirtualRouterName(String vrName)

Sets the name of the JUNOSe virtual router on which the address pool is located. This attribute is not supported on JUNOS routing platforms.

Types of associated events - DhcpAuthorization.

Parameters:

vrName - Name of the virtual router.

Returns:

true if the attribute can be set in this plug-in event. Otherwise returns false.

setReplyMessage

public boolean setReplyMessage(String message)

Sets message string that a plug-in returns to the SAE during authorization.

Types of associated events - Authorization.

Parameters:

message - Message string that a plug-in returns to the SAE during authorization.

Returns:

true if the attribute can be set in this plug-in event. Otherwise returns false.