net.sf.jradius.session
Interface JRadiusSession

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

RadiusSession

public interface JRadiusSession
extends java.io.Serializable

Defines a Radius Session. This bean is here to help with the handling of Radius Sessions (an authentication event followed by accounting).

Author:

David Bird

Field Summary

static int	ACCT_STARTED
static int	ACCT_STOPPED
static int	AUTH_ACCEPTED
static int	AUTH_PENDING
static int	AUTH_REJECTED
static int	RADIUS_ERROR
static long	serialVersionUID
static int	UNKNOWN_STATE

Method Summary

void	addAccessAcceptAttribtues(AttributeList attrs)
void	addLogMessage(JRadiusRequest request, java.lang.String message)
void	commitLogEntries(int result)
void	commitLogEntry(RadiusLogEntry entry, int result)
void	ensureSessionState(JRadiusRequest request, int state)
java.lang.String	getCalledStationId()
java.lang.String	getCallingStationId()
java.lang.String	getClientIPAddress()
java.lang.String	getConnectInfo()
java.lang.String	getFramedIPAddress()
java.lang.Long	getGigaWordsIn()
java.lang.Long	getGigaWordsOut()
java.lang.Long	getIdleTimeout()
java.lang.Long	getInterimInterval()
java.lang.String	getJRadiusKey()
java.util.Date	getLastInterimTime()
JRadiusRequest	getLastRadiusRequest()
java.lang.String	getLocationCity()
java.lang.String	getLocationCountryCode()
java.lang.String	getLocationID()
java.lang.String	getLocationName()
java.lang.String	getLocationStateProvince()
java.lang.String	getLocationType()
RadiusLogEntry	getLogEntry(JRadiusEvent event, java.lang.String key)
RadiusLogEntry	getLogEntry(JRadiusRequest request)
java.lang.Long	getMaxBandwidthDown()
java.lang.Long	getMaxBandwidthUp()
java.lang.Long	getMaxOctetsDown()
java.lang.Long	getMaxOctetsTotal()
java.lang.Long	getMaxOctetsUp()
java.lang.Long	getMinBandwidthDown()
java.lang.Long	getMinBandwidthUp()
java.lang.String	getNasIdentifier()
java.lang.String	getNasIPAddress()
java.lang.String	getNasType()
java.lang.Long	getOctetsIn()
java.lang.Long	getOctetsOut()
java.lang.Long	getPacketsIn()
java.lang.Long	getPacketsOut()
java.lang.String	getPassword()
java.lang.String	getPaymentType()
java.lang.String	getProxyToRealm()
byte[]	getRadiusClass()
java.lang.String	getRealm()
java.lang.String	getRedirectURL()
java.lang.String	getServiceClass()
java.lang.String	getServiceName()
java.lang.Long	getServiceType()
java.lang.String	getSessionId()
java.lang.String	getSessionKey()
int	getSessionState()
java.lang.Long	getSessionTime()
java.lang.Long	getSessionTimeout()
java.util.Date	getStartTime()
java.util.Date	getStopTime()
java.lang.Long	getTerminateCause()
long	getTimeStamp()
java.lang.Long	getTotalOctetsIn()
java.lang.Long	getTotalOctetsOut()
java.lang.String	getUsername()
void	initSession(JRadiusRequest request) This method is kicked off by the InitSessionHandler after a new PPRadiusSession has been created.
boolean	isNewSession()
boolean	isSecured()
void	onAccounting(JRadiusRequest request) Updates the session with attributes from the accounting request.
void	onAuthorization(JRadiusRequest request)
boolean	onNoAccountingStatusType(JRadiusRequest request)
void	onPostAuthentication(JRadiusRequest request)
void	onPostProcessing(JRadiusRequest request)
boolean	onPreProcessing(JRadiusRequest request)
void	setCalledStationId(java.lang.String calledStationId)
void	setCallingStationId(java.lang.String callingStationId)
void	setClientIPAddress(java.lang.String clientIPAddress)
void	setConnectInfo(java.lang.String connectInfo)
void	setFramedIPAddress(java.lang.String framedIPAddress)
void	setGigaWordsIn(java.lang.Long gigaWordsIn)
void	setGigaWordsOut(java.lang.Long gigaWordsOut)
void	setIdleTimeout(java.lang.Long idleTimeout)
void	setInterimInterval(java.lang.Long interimInterval)
void	setJRadiusKey(java.lang.String jRadiusKey)
void	setLastInterimTime(java.util.Date lastInterimTime)
void	setLastRadiusRequest(JRadiusRequest lastRadiusRequest)
void	setLocationCity(java.lang.String locationCity)
void	setLocationCountryCode(java.lang.String locationCountryCode)
void	setLocationID(java.lang.String locationID)
void	setLocationName(java.lang.String locationName)
void	setLocationStateProvince(java.lang.String locationStateProvince)
void	setLocationType(java.lang.String locationType)
void	setMaxBandwidthDown(java.lang.Long maxBandwidthDown)
void	setMaxBandwidthUp(java.lang.Long maxBandwidthUp)
void	setMaxOctetsDown(java.lang.Long maxOctetsDown)
void	setMaxOctetsTotal(java.lang.Long maxOctetsTotal)
void	setMaxOctetsUp(java.lang.Long maxOctetshUp)
void	setMinBandwidthDown(java.lang.Long minBandwidthDown)
void	setMinBandwidthUp(java.lang.Long minBandwidthUp)
void	setNasIdentifier(java.lang.String nasIdentifier)
void	setNasIPAddress(java.lang.String nasIPAddress)
void	setNasType(java.lang.String nasType)
void	setNewSession(boolean newSession)
void	setOctetsIn(java.lang.Long octetsIn)
void	setOctetsOut(java.lang.Long octetsOut)
void	setPacketsIn(java.lang.Long packetsIn)
void	setPacketsOut(java.lang.Long packetsOut)
void	setPassword(java.lang.String password)
void	setPaymentType(java.lang.String paymentType)
void	setProxyToRealm(java.lang.String proxyToRealm)
void	setRadiusClass(byte[] radiusClass)
void	setRealm(java.lang.String realm)
void	setRedirectURL(java.lang.String redirectURL)
void	setSecured(boolean secured)
void	setServiceClass(java.lang.String serviceClass)
void	setServiceName(java.lang.String serviceName)
void	setServiceType(java.lang.Long serviceType)
void	setSessionId(java.lang.String sessionId)
void	setSessionKey(java.lang.String sessionKey)
void	setSessionState(int sessionState)
void	setSessionTime(java.lang.Long sessionTime)
void	setSessionTimeout(java.lang.Long sessionTimeout)
void	setStartTime(java.util.Date startTime)
void	setStopTime(java.util.Date stopTime)
void	setTerminateCause(java.lang.Long terminateCause)
void	setTimeStamp(long timeStamp)
void	setUsername(java.lang.String username)
java.lang.String	toString()

Field Detail

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

RADIUS_ERROR

static final int RADIUS_ERROR

See Also:

Constant Field Values

UNKNOWN_STATE

static final int UNKNOWN_STATE

See Also:

Constant Field Values

AUTH_PENDING

static final int AUTH_PENDING

See Also:

Constant Field Values

AUTH_ACCEPTED

static final int AUTH_ACCEPTED

See Also:

Constant Field Values

AUTH_REJECTED

static final int AUTH_REJECTED

See Also:

Constant Field Values

ACCT_STARTED

static final int ACCT_STARTED

See Also:

Constant Field Values

ACCT_STOPPED

static final int ACCT_STOPPED

See Also:

Constant Field Values

Method Detail

getLogEntry

RadiusLogEntry getLogEntry(JRadiusEvent event,
                           java.lang.String key)

getLogEntry

RadiusLogEntry getLogEntry(JRadiusRequest request)
                           throws RadiusException

Throws:

RadiusException

addLogMessage

void addLogMessage(JRadiusRequest request,
                   java.lang.String message)
                   throws RadiusException

Throws:

RadiusException

commitLogEntries

void commitLogEntries(int result)

commitLogEntry

void commitLogEntry(RadiusLogEntry entry,
                    int result)

initSession

void initSession(JRadiusRequest request)
                 throws RadiusException

This method is kicked off by the InitSessionHandler after a new PPRadiusSession has been created.

Parameters:

request - The JRadiusRequest

Throws:

RadiusException

onPostProcessing

void onPostProcessing(JRadiusRequest request)
                      throws RadiusException

Throws:

RadiusException

onAuthorization

void onAuthorization(JRadiusRequest request)
                     throws RadiusException

Throws:

RadiusException

onPreProcessing

boolean onPreProcessing(JRadiusRequest request)
                        throws RadiusException

Throws:

RadiusException

onPostAuthentication

void onPostAuthentication(JRadiusRequest request)
                          throws RadiusException

Throws:

RadiusException

onAccounting

void onAccounting(JRadiusRequest request)
                  throws RadiusException

Updates the session with attributes from the accounting request. This method is fired off during post processing.

Parameters:

request -

Throws:

RadiusException

onNoAccountingStatusType

boolean onNoAccountingStatusType(JRadiusRequest request)
                                 throws RadiusException

Throws:

RadiusException

addAccessAcceptAttribtues

void addAccessAcceptAttribtues(AttributeList attrs)

ensureSessionState

void ensureSessionState(JRadiusRequest request,
                        int state)
                        throws RadiusException

Throws:

RadiusException

getUsername

java.lang.String getUsername()

Returns:

Returns the username.

setUsername

void setUsername(java.lang.String username)

Parameters:

username - The username to set.

getRealm

java.lang.String getRealm()

Returns:

Returns the realm.

setRealm

void setRealm(java.lang.String realm)

Parameters:

realm - The realm to set.

getPassword

java.lang.String getPassword()

Returns:

Returns the password.

setPassword

void setPassword(java.lang.String password)

Parameters:

password - The password to set.

getSessionKey

java.lang.String getSessionKey()

Returns:

Returns the sessionKey.

setSessionKey

void setSessionKey(java.lang.String sessionKey)

Parameters:

sessionKey - The sessionKey to set.

getSessionId

java.lang.String getSessionId()

Returns:

Returns the sessionId.

setSessionId

void setSessionId(java.lang.String sessionId)

Parameters:

sessionId - The sessionId to set.

getServiceType

java.lang.Long getServiceType()

Returns:

Returns the serviceType.

setServiceType

void setServiceType(java.lang.Long serviceType)

Parameters:

serviceType - The serviceType to set.

getIdleTimeout

java.lang.Long getIdleTimeout()

Returns:

Returns the idleTimeout.

setIdleTimeout

void setIdleTimeout(java.lang.Long idleTimeout)

Parameters:

idleTimeout - The idleTimeout to set.

getInterimInterval

java.lang.Long getInterimInterval()

Returns:

Returns the interimInterval.

setInterimInterval

void setInterimInterval(java.lang.Long interimInterval)

Parameters:

interimInterval - The interimInterval to set.

getSessionTimeout

java.lang.Long getSessionTimeout()

Returns:

Returns the sessionTimeout.

setSessionTimeout

void setSessionTimeout(java.lang.Long sessionTimeout)

Parameters:

sessionTimeout - The sessionTimeout to set.

getSessionTime

java.lang.Long getSessionTime()

Returns:

Returns the sessionTime.

setSessionTime

void setSessionTime(java.lang.Long sessionTime)

Parameters:

sessionTime - The sessionTime to set.

getStartTime

java.util.Date getStartTime()

Returns:

Returns the startTime.

setStartTime

void setStartTime(java.util.Date startTime)

Parameters:

startTime - The startTime to set.

getLastInterimTime

java.util.Date getLastInterimTime()

Returns:

Returns the lastInterimTime.

setLastInterimTime

void setLastInterimTime(java.util.Date lastInterimTime)

Parameters:

lastInterimTime - The lastInterimTime to set.

getStopTime

java.util.Date getStopTime()

Returns:

Returns the stopTime.

setStopTime

void setStopTime(java.util.Date stopTime)

Parameters:

stopTime - The stopTime to set.

getGigaWordsIn

java.lang.Long getGigaWordsIn()

Returns:

Returns the gigaWordsIn.

setGigaWordsIn

void setGigaWordsIn(java.lang.Long gigaWordsIn)

Parameters:

gigaWordsIn - The gigaWordsIn to set.

getGigaWordsOut

java.lang.Long getGigaWordsOut()

Returns:

Returns the gigaWordsOut.

setGigaWordsOut

void setGigaWordsOut(java.lang.Long gigaWordsOut)

Parameters:

gigaWordsOut - The gigaWordsOut to set.

getOctetsIn

java.lang.Long getOctetsIn()

Returns:

Returns the octetsIn.

setOctetsIn

void setOctetsIn(java.lang.Long octetsIn)

Parameters:

octetsIn - The octetsIn to set.

getOctetsOut

java.lang.Long getOctetsOut()

Returns:

Returns the octetsOut.

setOctetsOut

void setOctetsOut(java.lang.Long octetsOut)

Parameters:

octetsOut - The octetsOut to set.

getTotalOctetsIn

java.lang.Long getTotalOctetsIn()

getTotalOctetsOut

java.lang.Long getTotalOctetsOut()

getPacketsIn

java.lang.Long getPacketsIn()

Returns:

Returns the packetsIn.

setPacketsIn

void setPacketsIn(java.lang.Long packetsIn)

Parameters:

packetsIn - The packetsIn to set.

getPacketsOut

java.lang.Long getPacketsOut()

Returns:

Returns the packetsOut.

setPacketsOut

void setPacketsOut(java.lang.Long packetsOut)

Parameters:

packetsOut - The packetsOut to set.

getTerminateCause

java.lang.Long getTerminateCause()

Returns:

Returns the terminateCause.

setTerminateCause

void setTerminateCause(java.lang.Long terminateCause)

Parameters:

terminateCause - The terminateCause to set.

getRadiusClass

byte[] getRadiusClass()

Returns:

Returns the radiusClass.

setRadiusClass

void setRadiusClass(byte[] radiusClass)

Parameters:

radiusClass - The radiusClass to set.

getSessionState

int getSessionState()

Returns:

Returns the sessionState.

setSessionState

void setSessionState(int sessionState)

Parameters:

sessionState - The sessionState to set.

getLocationCity

java.lang.String getLocationCity()

Returns:

Returns the locationCity.

setLocationCity

void setLocationCity(java.lang.String locationCity)

Parameters:

locationCity - The locationCity to set.

getLocationCountryCode

java.lang.String getLocationCountryCode()

Returns:

Returns the locationCountryCode.

setLocationCountryCode

void setLocationCountryCode(java.lang.String locationCountryCode)

Parameters:

locationCountryCode - The locationCountryCode to set.

getLocationID

java.lang.String getLocationID()

Returns:

Returns the locationID.

setLocationID

void setLocationID(java.lang.String locationID)

Parameters:

locationID - The locationID to set.

getLocationType

java.lang.String getLocationType()

Returns:

Returns the locationType.

setLocationType

void setLocationType(java.lang.String locationType)

Parameters:

locationType - The locationType to set.

getLocationName

java.lang.String getLocationName()

Returns:

Returns the locationName.

setLocationName

void setLocationName(java.lang.String locationName)

Parameters:

locationName - The locationName to set.

getLocationStateProvince

java.lang.String getLocationStateProvince()

Returns:

Returns the locationStateProvince.

setLocationStateProvince

void setLocationStateProvince(java.lang.String locationStateProvince)

Parameters:

locationStateProvince - The locationStateProvince to set.

getPaymentType

java.lang.String getPaymentType()

Returns:

Returns the paymentType.

setPaymentType

void setPaymentType(java.lang.String paymentType)

Parameters:

paymentType - The paymentType to set.

getServiceClass

java.lang.String getServiceClass()

Returns:

Returns the serviceClass.

setServiceClass

void setServiceClass(java.lang.String serviceClass)

Parameters:

serviceClass - The serviceClass to set.

getServiceName

java.lang.String getServiceName()

Returns:

Returns the serviceName.

setServiceName

void setServiceName(java.lang.String serviceName)

Parameters:

serviceName - The serviceName to set.

getProxyToRealm

java.lang.String getProxyToRealm()

Returns:

Returns the proxyToRealm.

setProxyToRealm

void setProxyToRealm(java.lang.String proxyToRealm)

Parameters:

proxyToRealm - The proxyToRealm to set.

isSecured

boolean isSecured()

Returns:

Returns the secured.

setSecured

void setSecured(boolean secured)

Parameters:

secured - The secured to set.

getCalledStationId

java.lang.String getCalledStationId()

Returns:

Returns the calledStationId.

setCalledStationId

void setCalledStationId(java.lang.String calledStationId)

Parameters:

calledStationId - The calledStationId to set.

getCallingStationId

java.lang.String getCallingStationId()

Returns:

Returns the callingStationId.

setCallingStationId

void setCallingStationId(java.lang.String callingStationId)

Parameters:

callingStationId - The callingStationId to set.

getConnectInfo

java.lang.String getConnectInfo()

Returns:

Returns the connectInfo.

setConnectInfo

void setConnectInfo(java.lang.String connectInfo)

Parameters:

connectInfo - The connectInfo to set.

getClientIPAddress

java.lang.String getClientIPAddress()

Returns:

Returns the clientIPAddress.

setClientIPAddress

void setClientIPAddress(java.lang.String clientIPAddress)

Parameters:

clientIPAddress - The clientIPAddress to set.

getNasIdentifier

java.lang.String getNasIdentifier()

Returns:

Returns the nasIdentifier.

setNasIdentifier

void setNasIdentifier(java.lang.String nasIdentifier)

Parameters:

nasIdentifier - The nasIdentifier to set.

getNasIPAddress

java.lang.String getNasIPAddress()

Returns:

Returns the nasIPAddress.

setNasIPAddress

void setNasIPAddress(java.lang.String nasIPAddress)

Parameters:

nasIPAddress - The nasIPAddress to set.

getFramedIPAddress

java.lang.String getFramedIPAddress()

Returns:

Returns the framedIPAddress.

setFramedIPAddress

void setFramedIPAddress(java.lang.String framedIPAddress)

Parameters:

framedIPAddress - The framedIPAddress to set.

getTimeStamp

long getTimeStamp()

Returns:

Returns the timeStamp.

setTimeStamp

void setTimeStamp(long timeStamp)

Parameters:

timeStamp - The timeStamp to set.

getMaxBandwidthDown

java.lang.Long getMaxBandwidthDown()

setMaxBandwidthDown

void setMaxBandwidthDown(java.lang.Long maxBandwidthDown)

getMaxBandwidthUp

java.lang.Long getMaxBandwidthUp()

setMaxBandwidthUp

void setMaxBandwidthUp(java.lang.Long maxBandwidthUp)

getMinBandwidthDown

java.lang.Long getMinBandwidthDown()

setMinBandwidthDown

void setMinBandwidthDown(java.lang.Long minBandwidthDown)

getMinBandwidthUp

java.lang.Long getMinBandwidthUp()

Returns:

Returns the minBandwidthUp.

setMinBandwidthUp

void setMinBandwidthUp(java.lang.Long minBandwidthUp)

Parameters:

minBandwidthUp - the minBandwidth to set.

getMaxOctetsDown

java.lang.Long getMaxOctetsDown()

setMaxOctetsDown

void setMaxOctetsDown(java.lang.Long maxOctetsDown)

getMaxOctetsUp

java.lang.Long getMaxOctetsUp()

setMaxOctetsUp

void setMaxOctetsUp(java.lang.Long maxOctetshUp)

getMaxOctetsTotal

java.lang.Long getMaxOctetsTotal()

setMaxOctetsTotal

void setMaxOctetsTotal(java.lang.Long maxOctetsTotal)

getNasType

java.lang.String getNasType()

setNasType

void setNasType(java.lang.String nasType)

getRedirectURL

java.lang.String getRedirectURL()

setRedirectURL

void setRedirectURL(java.lang.String redirectURL)

isNewSession

boolean isNewSession()

Returns:

Returns the newSession.

setNewSession

void setNewSession(boolean newSession)

Parameters:

newSession - The newSession to set.

getJRadiusKey

java.lang.String getJRadiusKey()

setJRadiusKey

void setJRadiusKey(java.lang.String jRadiusKey)

getLastRadiusRequest

JRadiusRequest getLastRadiusRequest()

setLastRadiusRequest

void setLastRadiusRequest(JRadiusRequest lastRadiusRequest)

toString

java.lang.String toString()

Overrides:

toString in class java.lang.Object