JRadiusSession (jradius-core-1.1.5 1.1.5 API)

All Superinterfaces:

Serializable
```
public interface JRadiusSession
extends 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

Fields
Modifier and Type	Field and Description
`static int`	`ACCT_ONLY_STARTED`
`static int`	`ACCT_ONLY_STOPPED`
`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 String`	`SESSION_ATTRIBUTE_LOCATION_CITY`
`static String`	`SESSION_ATTRIBUTE_LOCATION_COUNTRY_CODE`
`static String`	`SESSION_ATTRIBUTE_LOCATION_ID`
`static String`	`SESSION_ATTRIBUTE_LOCATION_NAME`
`static String`	`SESSION_ATTRIBUTE_LOCATION_STATE_PROVINCE`
`static String`	`SESSION_ATTRIBUTE_LOCATION_TYPE`
`static int`	`SESSION_STARTED`
`static int`	`SESSION_STOPPED`
`static int`	`UNKNOWN_STATE`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addLogMessage(JRadiusRequest request, String message)`
`void`	`commitLogEntries(int result)`
`void`	`commitLogEntry(JRadiusLogEntry entry, int result)`
`void`	`ensureSessionState(JRadiusRequest request, int state)`
`Serializable`	`getAttribute(String name)`
`String`	`getCalledStationId()`
`String`	`getCallingStationId()`
`String`	`getClientIPAddress()`
`String`	`getConnectInfo()`
`String`	`getFramedIPAddress()`
`Long`	`getGigaWordsIn()`
`Long`	`getGigaWordsOut()`
`Long`	`getIdleTimeout()`
`Long`	`getInterimInterval()`
`String`	`getJRadiusKey()`
`Date`	`getLastInterimTime()`
`JRadiusLogEntry`	`getLogEntry(JRadiusEvent event, String key)`
`JRadiusLogEntry`	`getLogEntry(JRadiusRequest request)`
`Long`	`getMaxBandwidthDown()`
`Long`	`getMaxBandwidthUp()`
`Long`	`getMaxOctetsDown()`
`Long`	`getMaxOctetsTotal()`
`Long`	`getMaxOctetsUp()`
`Long`	`getMinBandwidthDown()`
`Long`	`getMinBandwidthUp()`
`String`	`getNasIdentifier()`
`String`	`getNasIPAddress()`
`String`	`getNasType()`
`Long`	`getOctetsIn()`
`Long`	`getOctetsOut()`
`Long`	`getPacketsIn()`
`Long`	`getPacketsOut()`
`String`	`getPassword()`
`String`	`getProxyToRealm()`
`byte[][]`	`getRadiusClass()`
`byte[]`	`getRadiusState()`
`String`	`getRealm()`
`String`	`getRedirectURL()`
`Long`	`getServiceType()`
`String`	`getSessionId()`
`String`	`getSessionKey()`
`int`	`getSessionState()`
`Long`	`getSessionTime()`
`Long`	`getSessionTimeout()`
`Date`	`getStartTime()`
`Date`	`getStopTime()`
`Long`	`getTerminateCause()`
`long`	`getTimeStamp()`
`Long`	`getTotalOctetsIn()`
`Long`	`getTotalOctetsOut()`
`String`	`getUsername()`
`void`	`initSession(JRadiusRequest request)` This method is kicked off by the InitSessionHandler after a new PPRadiusSession has been created.
`boolean`	`isAccountingReversed()`
`boolean`	`isLogging()`
`boolean`	`isSecured()`
`void`	`lock()`
`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`	`setAttribute(String name, Serializable value)`
`void`	`setCalledStationId(String calledStationId)`
`void`	`setCallingStationId(String callingStationId)`
`void`	`setClientIPAddress(String clientIPAddress)`
`void`	`setConnectInfo(String connectInfo)`
`void`	`setFramedIPAddress(String framedIPAddress)`
`void`	`setGigaWordsIn(Long gigaWordsIn)`
`void`	`setGigaWordsOut(Long gigaWordsOut)`
`void`	`setIdleTimeout(Long idleTimeout)`
`void`	`setInterimInterval(Long interimInterval)`
`void`	`setJRadiusKey(String jRadiusKey)`
`void`	`setLastInterimTime(Date lastInterimTime)`
`void`	`setMaxBandwidthDown(Long maxBandwidthDown)`
`void`	`setMaxBandwidthUp(Long maxBandwidthUp)`
`void`	`setMaxOctetsDown(Long maxOctetsDown)`
`void`	`setMaxOctetsTotal(Long maxOctetsTotal)`
`void`	`setMaxOctetsUp(Long maxOctetshUp)`
`void`	`setMinBandwidthDown(Long minBandwidthDown)`
`void`	`setMinBandwidthUp(Long minBandwidthUp)`
`void`	`setNasIdentifier(String nasIdentifier)`
`void`	`setNasIPAddress(String nasIPAddress)`
`void`	`setNasType(String nasType)`
`void`	`setOctetsIn(Long octetsIn)`
`void`	`setOctetsOut(Long octetsOut)`
`void`	`setPacketsIn(Long packetsIn)`
`void`	`setPacketsOut(Long packetsOut)`
`void`	`setPassword(String password)`
`void`	`setProxyToRealm(String proxyToRealm)`
`void`	`setRadiusClass(byte[][] radiusClass)`
`void`	`setRadiusState(byte[] radiusState)`
`void`	`setRealm(String realm)`
`void`	`setRedirectURL(String redirectURL)`
`void`	`setSecured(boolean secured)`
`void`	`setServiceType(Long serviceType)`
`void`	`setSessionId(String sessionId)`
`void`	`setSessionKey(String sessionKey)`
`void`	`setSessionState(int sessionState)`
`void`	`setSessionTime(Long sessionTime)`
`void`	`setSessionTimeout(Long sessionTimeout)`
`void`	`setStartTime(Date startTime)`
`void`	`setStopTime(Date stopTime)`
`void`	`setTerminateCause(Long terminateCause)`
`void`	`setTimeStamp(long timeStamp)`
`void`	`setUsername(String username)`
`void`	`unlock()`

- 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
  - SESSION_STARTED
```
static final int SESSION_STARTED
```
    See Also:
    
    Constant Field Values
  - SESSION_STOPPED
```
static final int SESSION_STOPPED
```
    See Also:
    
    Constant Field Values
  - ACCT_ONLY_STARTED
```
static final int ACCT_ONLY_STARTED
```
    See Also:
    
    Constant Field Values
  - ACCT_ONLY_STOPPED
```
static final int ACCT_ONLY_STOPPED
```
    See Also:
    
    Constant Field Values
  - SESSION_ATTRIBUTE_LOCATION_ID
```
static final String SESSION_ATTRIBUTE_LOCATION_ID
```
    See Also:
    
    Constant Field Values
  - SESSION_ATTRIBUTE_LOCATION_TYPE
```
static final String SESSION_ATTRIBUTE_LOCATION_TYPE
```
    See Also:
    
    Constant Field Values
  - SESSION_ATTRIBUTE_LOCATION_NAME
```
static final String SESSION_ATTRIBUTE_LOCATION_NAME
```
    See Also:
    
    Constant Field Values
  - SESSION_ATTRIBUTE_LOCATION_CITY
```
static final String SESSION_ATTRIBUTE_LOCATION_CITY
```
    See Also:
    
    Constant Field Values
  - SESSION_ATTRIBUTE_LOCATION_STATE_PROVINCE
```
static final String SESSION_ATTRIBUTE_LOCATION_STATE_PROVINCE
```
    See Also:
    
    Constant Field Values
  - SESSION_ATTRIBUTE_LOCATION_COUNTRY_CODE
```
static final String SESSION_ATTRIBUTE_LOCATION_COUNTRY_CODE
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getLogEntry
```
JRadiusLogEntry getLogEntry(JRadiusEvent event,
                            String key)
```
  - getLogEntry
```
JRadiusLogEntry getLogEntry(JRadiusRequest request)
                     throws RadiusException
```
    Throws:
    
    RadiusException
  - addLogMessage
```
void addLogMessage(JRadiusRequest request,
                   String message)
            throws RadiusException
```
    Throws:
    
    RadiusException
  - commitLogEntry
```
void commitLogEntry(JRadiusLogEntry entry,
                    int result)
```
  - commitLogEntries
```
void commitLogEntries(int result)
```
  - lock
```
void lock()
```
  - unlock
```
void unlock()
```
  - 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
  - setAttribute
```
void setAttribute(String name,
                  Serializable value)
```
  - getAttribute
```
Serializable getAttribute(String name)
```
  - 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
  - ensureSessionState
```
void ensureSessionState(JRadiusRequest request,
                        int state)
                 throws RadiusException
```
    Throws:
    
    RadiusException
  - isAccountingReversed
```
boolean isAccountingReversed()
```
  - getUsername
```
String getUsername()
```
    Returns:
    
    Returns the username.
  - setUsername
```
void setUsername(String username)
```
    Parameters:
    
    username - The username to set.
  - getRealm
```
String getRealm()
```
    Returns:
    
    Returns the realm.
  - setRealm
```
void setRealm(String realm)
```
    Parameters:
    
    realm - The realm to set.
  - getPassword
```
String getPassword()
```
    Returns:
    
    Returns the password.
  - setPassword
```
void setPassword(String password)
```
    Parameters:
    
    password - The password to set.
  - getSessionKey
```
String getSessionKey()
```
    Returns:
    
    Returns the sessionKey.
  - setSessionKey
```
void setSessionKey(String sessionKey)
```
    Parameters:
    
    sessionKey - The sessionKey to set.
  - getSessionId
```
String getSessionId()
```
    Returns:
    
    Returns the sessionId.
  - setSessionId
```
void setSessionId(String sessionId)
```
    Parameters:
    
    sessionId - The sessionId to set.
  - getServiceType
```
Long getServiceType()
```
    Returns:
    
    Returns the serviceType.
  - setServiceType
```
void setServiceType(Long serviceType)
```
    Parameters:
    
    serviceType - The serviceType to set.
  - getIdleTimeout
```
Long getIdleTimeout()
```
    Returns:
    
    Returns the idleTimeout.
  - setIdleTimeout
```
void setIdleTimeout(Long idleTimeout)
```
    Parameters:
    
    idleTimeout - The idleTimeout to set.
  - getInterimInterval
```
Long getInterimInterval()
```
    Returns:
    
    Returns the interimInterval.
  - setInterimInterval
```
void setInterimInterval(Long interimInterval)
```
    Parameters:
    
    interimInterval - The interimInterval to set.
  - getSessionTimeout
```
Long getSessionTimeout()
```
    Returns:
    
    Returns the sessionTimeout.
  - setSessionTimeout
```
void setSessionTimeout(Long sessionTimeout)
```
    Parameters:
    
    sessionTimeout - The sessionTimeout to set.
  - getSessionTime
```
Long getSessionTime()
```
    Returns:
    
    Returns the sessionTime.
  - setSessionTime
```
void setSessionTime(Long sessionTime)
```
    Parameters:
    
    sessionTime - The sessionTime to set.
  - getStartTime
```
Date getStartTime()
```
    Returns:
    
    Returns the startTime.
  - setStartTime
```
void setStartTime(Date startTime)
```
    Parameters:
    
    startTime - The startTime to set.
  - getLastInterimTime
```
Date getLastInterimTime()
```
    Returns:
    
    Returns the lastInterimTime.
  - setLastInterimTime
```
void setLastInterimTime(Date lastInterimTime)
```
    Parameters:
    
    lastInterimTime - The lastInterimTime to set.
  - getStopTime
```
Date getStopTime()
```
    Returns:
    
    Returns the stopTime.
  - setStopTime
```
void setStopTime(Date stopTime)
```
    Parameters:
    
    stopTime - The stopTime to set.
  - getGigaWordsIn
```
Long getGigaWordsIn()
```
    Returns:
    
    Returns the gigaWordsIn.
  - setGigaWordsIn
```
void setGigaWordsIn(Long gigaWordsIn)
```
    Parameters:
    
    gigaWordsIn - The gigaWordsIn to set.
  - getGigaWordsOut
```
Long getGigaWordsOut()
```
    Returns:
    
    Returns the gigaWordsOut.
  - setGigaWordsOut
```
void setGigaWordsOut(Long gigaWordsOut)
```
    Parameters:
    
    gigaWordsOut - The gigaWordsOut to set.
  - getOctetsIn
```
Long getOctetsIn()
```
    Returns:
    
    Returns the octetsIn.
  - setOctetsIn
```
void setOctetsIn(Long octetsIn)
```
    Parameters:
    
    octetsIn - The octetsIn to set.
  - getOctetsOut
```
Long getOctetsOut()
```
    Returns:
    
    Returns the octetsOut.
  - setOctetsOut
```
void setOctetsOut(Long octetsOut)
```
    Parameters:
    
    octetsOut - The octetsOut to set.
  - getTotalOctetsIn
```
Long getTotalOctetsIn()
```
  - getTotalOctetsOut
```
Long getTotalOctetsOut()
```
  - getPacketsIn
```
Long getPacketsIn()
```
    Returns:
    
    Returns the packetsIn.
  - setPacketsIn
```
void setPacketsIn(Long packetsIn)
```
    Parameters:
    
    packetsIn - The packetsIn to set.
  - getPacketsOut
```
Long getPacketsOut()
```
    Returns:
    
    Returns the packetsOut.
  - setPacketsOut
```
void setPacketsOut(Long packetsOut)
```
    Parameters:
    
    packetsOut - The packetsOut to set.
  - getTerminateCause
```
Long getTerminateCause()
```
    Returns:
    
    Returns the terminateCause.
  - setTerminateCause
```
void setTerminateCause(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.
  - getRadiusState
```
byte[] getRadiusState()
```
    Returns:
    
    Returns the radiusState.
  - setRadiusState
```
void setRadiusState(byte[] radiusState)
```
    Parameters:
    
    radiusState - The radiusState to set.
  - getSessionState
```
int getSessionState()
```
    Returns:
    
    Returns the sessionState.
  - setSessionState
```
void setSessionState(int sessionState)
```
    Parameters:
    
    sessionState - The sessionState to set.
  - getProxyToRealm
```
String getProxyToRealm()
```
    Returns:
    
    Returns the proxyToRealm.
  - setProxyToRealm
```
void setProxyToRealm(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
```
String getCalledStationId()
```
    Returns:
    
    Returns the calledStationId.
  - setCalledStationId
```
void setCalledStationId(String calledStationId)
```
    Parameters:
    
    calledStationId - The calledStationId to set.
  - getCallingStationId
```
String getCallingStationId()
```
    Returns:
    
    Returns the callingStationId.
  - setCallingStationId
```
void setCallingStationId(String callingStationId)
```
    Parameters:
    
    callingStationId - The callingStationId to set.
  - getConnectInfo
```
String getConnectInfo()
```
    Returns:
    
    Returns the connectInfo.
  - setConnectInfo
```
void setConnectInfo(String connectInfo)
```
    Parameters:
    
    connectInfo - The connectInfo to set.
  - getClientIPAddress
```
String getClientIPAddress()
```
    Returns:
    
    Returns the clientIPAddress.
  - setClientIPAddress
```
void setClientIPAddress(String clientIPAddress)
```
    Parameters:
    
    clientIPAddress - The clientIPAddress to set.
  - getNasIdentifier
```
String getNasIdentifier()
```
    Returns:
    
    Returns the nasIdentifier.
  - setNasIdentifier
```
void setNasIdentifier(String nasIdentifier)
```
    Parameters:
    
    nasIdentifier - The nasIdentifier to set.
  - getNasIPAddress
```
String getNasIPAddress()
```
    Returns:
    
    Returns the nasIPAddress.
  - setNasIPAddress
```
void setNasIPAddress(String nasIPAddress)
```
    Parameters:
    
    nasIPAddress - The nasIPAddress to set.
  - getFramedIPAddress
```
String getFramedIPAddress()
```
    Returns:
    
    Returns the framedIPAddress.
  - setFramedIPAddress
```
void setFramedIPAddress(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
```
Long getMaxBandwidthDown()
```
  - setMaxBandwidthDown
```
void setMaxBandwidthDown(Long maxBandwidthDown)
```
  - getMaxBandwidthUp
```
Long getMaxBandwidthUp()
```
  - setMaxBandwidthUp
```
void setMaxBandwidthUp(Long maxBandwidthUp)
```
  - getMinBandwidthDown
```
Long getMinBandwidthDown()
```
  - setMinBandwidthDown
```
void setMinBandwidthDown(Long minBandwidthDown)
```
  - getMinBandwidthUp
```
Long getMinBandwidthUp()
```
    Returns:
    
    Returns the minBandwidthUp.
  - setMinBandwidthUp
```
void setMinBandwidthUp(Long minBandwidthUp)
```
    Parameters:
    
    minBandwidthUp - the minBandwidth to set.
  - getMaxOctetsDown
```
Long getMaxOctetsDown()
```
  - setMaxOctetsDown
```
void setMaxOctetsDown(Long maxOctetsDown)
```
  - getMaxOctetsUp
```
Long getMaxOctetsUp()
```
  - setMaxOctetsUp
```
void setMaxOctetsUp(Long maxOctetshUp)
```
  - getMaxOctetsTotal
```
Long getMaxOctetsTotal()
```
  - setMaxOctetsTotal
```
void setMaxOctetsTotal(Long maxOctetsTotal)
```
  - getNasType
```
String getNasType()
```
  - setNasType
```
void setNasType(String nasType)
```
  - getRedirectURL
```
String getRedirectURL()
```
  - setRedirectURL
```
void setRedirectURL(String redirectURL)
```
  - getJRadiusKey
```
String getJRadiusKey()
```
  - setJRadiusKey
```
void setJRadiusKey(String jRadiusKey)
```
  - isLogging
```
boolean isLogging()
```

Interface JRadiusSession

Field Summary

Method Summary

Field Detail

serialVersionUID

RADIUS_ERROR

UNKNOWN_STATE

AUTH_PENDING

AUTH_ACCEPTED

AUTH_REJECTED

ACCT_STARTED

ACCT_STOPPED

SESSION_STARTED

SESSION_STOPPED

ACCT_ONLY_STARTED

ACCT_ONLY_STOPPED

SESSION_ATTRIBUTE_LOCATION_ID

SESSION_ATTRIBUTE_LOCATION_TYPE

SESSION_ATTRIBUTE_LOCATION_NAME

SESSION_ATTRIBUTE_LOCATION_CITY

SESSION_ATTRIBUTE_LOCATION_STATE_PROVINCE

SESSION_ATTRIBUTE_LOCATION_COUNTRY_CODE

Method Detail

getLogEntry

getLogEntry

addLogMessage

commitLogEntry

commitLogEntries

lock

unlock

initSession

setAttribute

getAttribute

onPostProcessing

onAuthorization

onPreProcessing

onPostAuthentication

onAccounting

onNoAccountingStatusType

ensureSessionState

isAccountingReversed

getUsername

setUsername

getRealm

setRealm

getPassword

setPassword

getSessionKey

setSessionKey

getSessionId

setSessionId

getServiceType

setServiceType

getIdleTimeout

setIdleTimeout

getInterimInterval

setInterimInterval

getSessionTimeout

setSessionTimeout

getSessionTime

setSessionTime

getStartTime

setStartTime

getLastInterimTime

setLastInterimTime

getStopTime

setStopTime

getGigaWordsIn

setGigaWordsIn

getGigaWordsOut

setGigaWordsOut

getOctetsIn

setOctetsIn

getOctetsOut

setOctetsOut

getTotalOctetsIn

getTotalOctetsOut

getPacketsIn

setPacketsIn

getPacketsOut