com.theorem.radserver3
Class SNMPStats

Object
  SNMPStats

public final class SNMPStats

extends Object

SNMP Stats Collect servers stats and make them available to the SNMP agent session.

Field Summary

static String	enterpriseAgent
static String	enterpriseAgentTrap
long	radiusAcctServConfigReset
byte[]	radiusAcctServIdent
long	radiusAcctServResetTime
long	radiusAcctServTotalBadAuthenticators
long	radiusAcctServTotalDupRequests
long	radiusAcctServTotalInvalidRequests
long	radiusAcctServTotalMalformedRequests
long	radiusAcctServTotalNoRecords
long	radiusAcctServTotalPacketsDropped
long	radiusAcctServTotalRequests
long	radiusAcctServTotalResponses
long	radiusAcctServTotalUnknownTypes
long	radiusAcctServUpTime
long	radiusAuthServConfigReset
byte[]	radiusAuthServIdent
long	radiusAuthServResetTime
long	radiusAuthServTotalAccessAccepts
long	radiusAuthServTotalAccessChallenges
long	radiusAuthServTotalAccessRejects
long	radiusAuthServTotalAccessRequests
long	radiusAuthServTotalBadAuthenticators
long	radiusAuthServTotalDupAccessRequests
long	radiusAuthServTotalInvalidRequests
long	radiusAuthServTotalMalformedAccessRequests
long	radiusAuthServTotalPacketsDropped
long	radiusAuthServTotalUnknownTypes
long	radiusAuthServUpTime
static int	RESET_INITIALIZING Value for radiusAuthServConfigReset & radiusAcctServConfigReset - 3.
static int	RESET_OTHER Value for radiusAuthServConfigReset & radiusAcctServConfigReset - 1
static int	RESET_RESET Value for radiusAuthServConfigReset & radiusAcctServConfigReset - 2.
static int	RESET_RUNNING Value for radiusAuthServConfigReset & radiusAcctServConfigReset - 4.

Method Summary

void	buildRadiusClientTable() Build the client table.
void	calcUpTime() Calculate up time for servers.
void	close() Close the SNMP session.
long	getRadiusAuthServConfigReset() Get radiusAuthServConfigReset time (read-write);
void	reset() Reset SNMP information.
void	sendColdStartTrap(String msg) Send a cold start message.
void	sendTrap(String msg) Send a V2 trap message.
int	setRadiusAcctServConfigReset(SnmpObjectId oid, Object configReset, boolean set) Set radiusAuthServConfigReset time (read-write);
int	setRadiusAuthServConfigReset(SnmpObjectId oid, Object configReset, boolean set) Set radiusAuthServConfigReset (read-write);
void	setSNMPManagers(InetAddress[] managerList) Set a list of managers for SNMP.
void	setSysParameters(String sysContact, String sysName, String sysLocation) Set some common SNMP parameters.
String	toString() String representation of the SNMPStats.

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

enterpriseAgent

public static final String enterpriseAgent

See Also:

Constant Field Values

enterpriseAgentTrap

public static final String enterpriseAgentTrap

See Also:

Constant Field Values

radiusAcctServConfigReset

public long radiusAcctServConfigReset

radiusAcctServIdent

public final byte[] radiusAcctServIdent

radiusAcctServResetTime

public long radiusAcctServResetTime

radiusAcctServTotalBadAuthenticators

public volatile long radiusAcctServTotalBadAuthenticators

radiusAcctServTotalDupRequests

public volatile long radiusAcctServTotalDupRequests

radiusAcctServTotalInvalidRequests

public volatile long radiusAcctServTotalInvalidRequests

radiusAcctServTotalMalformedRequests

public volatile long radiusAcctServTotalMalformedRequests

radiusAcctServTotalNoRecords

public volatile long radiusAcctServTotalNoRecords

radiusAcctServTotalPacketsDropped

public volatile long radiusAcctServTotalPacketsDropped

radiusAcctServTotalRequests

public volatile long radiusAcctServTotalRequests

radiusAcctServTotalResponses

public volatile long radiusAcctServTotalResponses

radiusAcctServTotalUnknownTypes

public volatile long radiusAcctServTotalUnknownTypes

radiusAcctServUpTime

public long radiusAcctServUpTime

radiusAuthServConfigReset

public long radiusAuthServConfigReset

radiusAuthServIdent

public final byte[] radiusAuthServIdent

radiusAuthServResetTime

public long radiusAuthServResetTime

radiusAuthServTotalAccessAccepts

public volatile long radiusAuthServTotalAccessAccepts

radiusAuthServTotalAccessChallenges

public volatile long radiusAuthServTotalAccessChallenges

radiusAuthServTotalAccessRejects

public volatile long radiusAuthServTotalAccessRejects

radiusAuthServTotalAccessRequests

public long radiusAuthServTotalAccessRequests

radiusAuthServTotalBadAuthenticators

public volatile long radiusAuthServTotalBadAuthenticators

radiusAuthServTotalDupAccessRequests

public volatile long radiusAuthServTotalDupAccessRequests

radiusAuthServTotalInvalidRequests

public volatile long radiusAuthServTotalInvalidRequests

radiusAuthServTotalMalformedAccessRequests

public volatile long radiusAuthServTotalMalformedAccessRequests

radiusAuthServTotalPacketsDropped

public volatile long radiusAuthServTotalPacketsDropped

radiusAuthServTotalUnknownTypes

public volatile long radiusAuthServTotalUnknownTypes

radiusAuthServUpTime

public long radiusAuthServUpTime

RESET_INITIALIZING

public static final int RESET_INITIALIZING

Value for radiusAuthServConfigReset & radiusAcctServConfigReset - 3.

See Also:

Constant Field Values

RESET_OTHER

public static final int RESET_OTHER

Value for radiusAuthServConfigReset & radiusAcctServConfigReset - 1

See Also:

Constant Field Values

RESET_RESET

public static final int RESET_RESET

Value for radiusAuthServConfigReset & radiusAcctServConfigReset - 2.

See Also:

Constant Field Values

RESET_RUNNING

public static final int RESET_RUNNING

Value for radiusAuthServConfigReset & radiusAcctServConfigReset - 4.

See Also:

Constant Field Values

Method Detail

buildRadiusClientTable

public void buildRadiusClientTable()

Build the client table. This is built on any SNMP request, but no more than once in a certain time period, on the scale of seconds.

calcUpTime

public void calcUpTime()

Calculate up time for servers. Calculated times are converted to hundredths of a second.

close

public void close()

Close the SNMP session.

getRadiusAuthServConfigReset

public long getRadiusAuthServConfigReset()

Get radiusAuthServConfigReset time (read-write);

reset

public void reset()

Reset SNMP information. Clear times, counts and tables.

Since:

3.32

sendColdStartTrap

public void sendColdStartTrap(String msg)

Send a cold start message.

Parameters:

msg - Message to send

sendTrap

public void sendTrap(String msg)

Send a V2 trap message. If there's no agent do nothing.

setRadiusAcctServConfigReset

public int setRadiusAcctServConfigReset(SnmpObjectId oid,
                                        Object configReset,
                                        boolean set)

Set radiusAuthServConfigReset time (read-write);

Parameters:

oid - Object Id being set (only used in tables to extract indices).

configReset - value.

set - If true this the variable is actually set. Otherwise it's a test of setting. In the test the variable is never set.

Returns:

SNMP error message type. SnmpPduPacket.ErrNoError is returned if there's no error.

setRadiusAuthServConfigReset

public int setRadiusAuthServConfigReset(SnmpObjectId oid,
                                        Object configReset,
                                        boolean set)

Set radiusAuthServConfigReset (read-write);

Parameters:

oid - Object Id being set (only used in tables to extract indices).

configReset - Object value..

set - If true this the variable is actually set. Otherwise it's a test of setting. In the test the variable is never set.

Returns:

SNMP error message type. SnmpPduPacket.ErrNoError is returned if there's no error.

setSNMPManagers

public void setSNMPManagers(InetAddress[] managerList)

Set a list of managers for SNMP. If no manager list is applied requests from any source will be accepted. If the list is in place only requests from these systems will be permitted.

Parameters:

managerList - List of managers that may send requests.

setSysParameters

public void setSysParameters(String sysContact,
                             String sysName,
                             String sysLocation)

Set some common SNMP parameters. These may be set using this method or by the SNMP management system. Initially they are all empty. If any parameter is null that parameter will not be changed.

Parameters:

sysContact - "The textual identification of the contact person for this managed node, together with information on how to contact this person."

sysName - "An administratively-assigned name for this managed node. By convention, this is the node's fully-qualified domain name."

sysLocation - ""The physical location of this node (e.g., `telephone closet, 3rd floor')."

Throws:

RADIUSServerException - if SNMP isn't already started.

toString

public String toString()

String representation of the SNMPStats. Human readable stats.

Returns:

string.