A C D E G H I M O R S T U

A

accept(File, String) - Method in class com.mccrory.scott.base.ConcreteFilenameFilter

Required for the FilenameFilter interface.

addStatsValue(StatsValue) - Method in class com.mccrory.scott.spumoni.StatsProgram

Adds the StatsValue object to our StatsValueList

C

clone() - Method in class com.mccrory.scott.base.ExecRunner

We override the clone method here to prevent cloning of our class.

clone() - Method in class com.mccrory.scott.spumoni.StatsValue

We override the clone method here to prevent cloning of our class.

clone() - Method in class com.mccrory.scott.spumoni.StatsProgram

We override the clone method here to prevent cloning of our class.

clone() - Method in class com.mccrory.scott.spumoni.StatsCollector

We override the clone method here to prevent cloning of our class.

clone() - Method in class com.mccrory.scott.spumoni.SnmpTrapAgent

We override the clone method here to prevent cloning of our class.

close() - Method in class com.mccrory.scott.spumoni.SnmpTrapAgent

Closes the SNMP session.

collectStats() - Method in class com.mccrory.scott.spumoni.StatsCollector

Collect all of the stats and write them to the data file.

com.mccrory.scott.base - package com.mccrory.scott.base

Common base utility classes.

com.mccrory.scott.base.test - package com.mccrory.scott.base.test

JUnit Test Classes for base package.

com.mccrory.scott.spumoni - package com.mccrory.scott.spumoni

The main package for Spumoni.

com.mccrory.scott.spumoni.test - package com.mccrory.scott.spumoni.test

JUnit Test Classes for spumoni package.

ConcreteFilenameFilter - class com.mccrory.scott.base.ConcreteFilenameFilter.

A case-insensitive, concrete implementation of java.io.FilenameFilter.

ConcreteFilenameFilter(String) - Constructor for class com.mccrory.scott.base.ConcreteFilenameFilter

ConcreteFilenameFilter constructor.

Conversions - class com.mccrory.scott.base.Conversions.

Contains methods for easy class conversions.

Conversions() - Constructor for class com.mccrory.scott.base.Conversions

Basic Conversions constructor.

D

Dom4jHelper - class com.mccrory.scott.base.Dom4jHelper.

Contains methods to make working with dom4j objects a little easier.

Dom4jHelper() - Constructor for class com.mccrory.scott.base.Dom4jHelper

Dom4jHelper constructor.

E

exec(String) - Method in class com.mccrory.scott.base.ExecRunner

The exec(String) method runs a process inside of a watched thread.

exec(String, OutputStream, OutputStream) - Method in class com.mccrory.scott.base.ExecRunner

Convenience method for calling exec with OutputStreams.

exec(String, PrintWriter, PrintWriter) - Method in class com.mccrory.scott.base.ExecRunner

The exec(String, PrintWriter, PrintWriter) method runs a process inside of a watched thread.

ExecRunner - class com.mccrory.scott.base.ExecRunner.

Makes running external executables easier, optionally under a watched thread.

ExecRunner() - Constructor for class com.mccrory.scott.base.ExecRunner

Basic ExecRunner constructor.

ExecRunner(String) - Constructor for class com.mccrory.scott.base.ExecRunner

ExecRunner constructor which also conveniently runs exec(String).

ExecRunnerTest - class com.mccrory.scott.base.test.ExecRunnerTest.

JUnit test case for ExecRunner class.

ExecRunnerTest(String) - Constructor for class com.mccrory.scott.base.test.ExecRunnerTest

StatsCollectorTest constructor

G

getAttributes(Element) - Static method in class com.mccrory.scott.base.Dom4jHelper

Returns a HashMap of all the attributes in the passed-in XML/Dom4J Element.

getChildElementNames(Element) - Static method in class com.mccrory.scott.base.Dom4jHelper

Returns the names of all the child elements of a passed-in Element.

getCollectedStats() - Method in class com.mccrory.scott.spumoni.StatsCollector

Returns an object with only the COLLECTED statistics.

getErrString() - Method in class com.mccrory.scott.base.ExecRunner

Returns the error string if exec(String) was invoked.

getMaxRunTime() - Method in class com.mccrory.scott.spumoni.StatsProgram

Returns the program's maximum run time in seconds.

getMaxRunTimeExceeded() - Method in class com.mccrory.scott.base.ExecRunner

Returns whether the maximum runtime was exceeded or not.

getMaxRunTimeSecs() - Method in class com.mccrory.scott.base.ExecRunner

Returns the maximum run time in seconds for this object.

getOidConflicts() - Method in class com.mccrory.scott.spumoni.StatsProgramList

Searches for OID conflicts and returns a list of StatsProgram objects and their offending StatsValue components.

getOids() - Method in class com.mccrory.scott.spumoni.StatsValueList

Returns a vector of all of the OIDs in the contained StatsValues

getOids() - Method in class com.mccrory.scott.spumoni.StatsProgramList

Returns a vector of all of the OIDs in the contained StatsPrograms

getOids() - Method in class com.mccrory.scott.spumoni.StatsProgram

Returns a vector of all of the OIDs in this StatsProgram

getOutString() - Method in class com.mccrory.scott.base.ExecRunner

Returns the output string if exec(String) was invoked.

getProgram() - Method in class com.mccrory.scott.spumoni.StatsProgram

Returns the program's command string.

getRegexp() - Method in class com.mccrory.scott.spumoni.StatsProgram

Returns the program's regexp string.

getRequiredModules() - Method in class com.mccrory.scott.spumoni.StatsProgram

Returns a Vector of the program's required modules.

getSnmpOid() - Method in class com.mccrory.scott.spumoni.StatsValue

Returns the SNMP OID.

getSnmpTrapMax() - Method in class com.mccrory.scott.spumoni.StatsValue

Returns the max acceptable value before an SMTP trap is sent.

getSnmpTrapMin() - Method in class com.mccrory.scott.spumoni.StatsValue

Returns the min acceptable value before an SMTP trap is sent.

getStatsValueList() - Method in class com.mccrory.scott.spumoni.StatsProgram

Returns a StatsValueList of the program's StatsValue objects.

getValue() - Method in class com.mccrory.scott.spumoni.StatsValue

Gets the program value's actual collected value.

getValueByOid(String) - Method in class com.mccrory.scott.spumoni.StatsValueList

Returns a value String corresponding to the specified OID.

getValueByOid(String) - Method in class com.mccrory.scott.spumoni.StatsProgramList

Returns a StatsValue's value String corresponding to the specified OID.

getValueName() - Method in class com.mccrory.scott.spumoni.StatsValue

Returns the value name.

getXmlFilename() - Method in class com.mccrory.scott.spumoni.StatsProgram

Returns the program's source XML filename.

H

handleAlarm(AlarmEntry) - Method in class com.mccrory.scott.spumoni.StatsCollector

Invoked when a JDring alarm is triggered.

handleGet(SnmpVarBind) - Method in class com.mccrory.scott.spumoni.StatsCollector

Handles SNMP GET PDUs.

handleGet(SnmpVarBind) - Method in interface com.mccrory.scott.spumoni.OidHandler

Handles SNMP GET PDUs.

handleGetbulk(SnmpVarBind) - Method in class com.mccrory.scott.spumoni.StatsCollector

Handles SNMP GETBULK PDUs.

handleGetbulk(SnmpVarBind) - Method in interface com.mccrory.scott.spumoni.OidHandler

Handles SNMP GETBULK PDUs.

handleGetnext(SnmpVarBind) - Method in class com.mccrory.scott.spumoni.StatsCollector

Handles SNMP GETNEXT PDUs.

handleGetnext(SnmpVarBind) - Method in interface com.mccrory.scott.spumoni.OidHandler

Handles SNMP GETNEXT PDUs.

handleInform(SnmpVarBind) - Method in class com.mccrory.scott.spumoni.StatsCollector

Handles SNMP INFORM PDUs.

handleInform(SnmpVarBind) - Method in interface com.mccrory.scott.spumoni.OidHandler

Handles SNMP INFORM PDUs.

handleReport(SnmpVarBind) - Method in class com.mccrory.scott.spumoni.StatsCollector

Handles SNMP REPORT PDUs.

handleReport(SnmpVarBind) - Method in interface com.mccrory.scott.spumoni.OidHandler

Handles SNMP REPORT PDUs.

handleResponse(SnmpVarBind) - Method in class com.mccrory.scott.spumoni.StatsCollector

Handles SNMP RESPONSE PDUs.

handleResponse(SnmpVarBind) - Method in interface com.mccrory.scott.spumoni.OidHandler

Handles SNMP RESPONSE PDUs.

handleSet(SnmpVarBind) - Method in class com.mccrory.scott.spumoni.StatsCollector

Handles SNMP SET PDUs.

handleSet(SnmpVarBind) - Method in interface com.mccrory.scott.spumoni.OidHandler

Handles SNMP SET PDUs.

handleTrap(SnmpVarBind) - Method in class com.mccrory.scott.spumoni.StatsCollector

Handles SNMP TRAP PDUs.

handleTrap(SnmpVarBind) - Method in interface com.mccrory.scott.spumoni.OidHandler

Handles SNMP TRAP PDUs.

handleV2Trap(SnmpVarBind) - Method in class com.mccrory.scott.spumoni.StatsCollector

Handles SNMP V2TRAP PDUs.

handleV2Trap(SnmpVarBind) - Method in interface com.mccrory.scott.spumoni.OidHandler

Handles SNMP V2TRAP PDUs.

I

isUnset() - Method in class com.mccrory.scott.spumoni.StatsValue

Returns whether value is unset.

M

main(String[]) - Static method in class com.mccrory.scott.base.ExecRunner

This is for unit testing of the class.

main(String[]) - Static method in class com.mccrory.scott.base.Conversions

Used only for unit testing.

main(String[]) - Static method in class com.mccrory.scott.base.test.ExecRunnerTest

Runs the JUnit test from the command line.

main(String[]) - Static method in class com.mccrory.scott.spumoni.StatsCollector

Starts the Spumoni stats collection according to the prefs files' specs.

main(String[]) - Static method in class com.mccrory.scott.spumoni.SnmpTrapAgent

For unit testing.

main(String[]) - Static method in class com.mccrory.scott.spumoni.SnmpD

The main routine.

main(String[]) - Static method in class com.mccrory.scott.spumoni.test.StatsValueListTest

Runs the JUnit test from the command line.

main(String[]) - Static method in class com.mccrory.scott.spumoni.test.StatsProgramListTest

Runs the JUnit test from the command line.

main(String[]) - Static method in class com.mccrory.scott.spumoni.test.StatsCollectorTest

Runs the JUnit test from the command line.

main(String[]) - Static method in class com.mccrory.scott.spumoni.test.SnmpTrapAgentTest

Runs the JUnit test from the command line.

main(String[]) - Static method in class com.mccrory.scott.spumoni.test.SnmpDTest

Runs the JUnit test from the command line.

O

OidHandler - interface com.mccrory.scott.spumoni.OidHandler.

OidHandler defines standards for handling SNMP requests.

R

registerOidHandler(String, OidHandler) - Method in class com.mccrory.scott.spumoni.SnmpD

Register an oid handler to our lookup map.

S

scheduleRuns() - Method in class com.mccrory.scott.spumoni.StatsCollector

Run once or schedule ourself on a new alarm manager to run periodically.

sendSnmpTrap(String, String) - Method in class com.mccrory.scott.spumoni.StatsCollector

Sends an SNMP trap if all of the required data and conditions are OK.

sendV1Trap(String) - Method in class com.mccrory.scott.spumoni.SnmpTrapAgent

Sends a formatted message as SNMP V1 trap.

sendV2Trap(String) - Method in class com.mccrory.scott.spumoni.SnmpTrapAgent

Sends a formatted message as SNMP V2 trap.

setMaxRunTime(int) - Method in class com.mccrory.scott.spumoni.StatsProgram

Sets the program's maximum run time in seconds.

setMaxRunTimeSecs(int) - Method in class com.mccrory.scott.base.ExecRunner

Sets the maximum run time in seconds.

setProgram(String) - Method in class com.mccrory.scott.spumoni.StatsProgram

Sets the program's command string.

setRegexp(String) - Method in class com.mccrory.scott.spumoni.StatsProgram

Sets the program's regular expression string.

setRequiredModules(String) - Method in class com.mccrory.scott.spumoni.StatsProgram

Sets the program's Vector of required modules from a comma-delimited string.

setRequiredModules(Vector) - Method in class com.mccrory.scott.spumoni.StatsProgram

Sets the program's Vector of required modules.

setSnmpOid(String) - Method in class com.mccrory.scott.spumoni.StatsValue

Sets the SNMP OID.

setSnmpTrapMax(int) - Method in class com.mccrory.scott.spumoni.StatsValue

Sets the max acceptable value before an SMTP trap is sent.

setSnmpTrapMin(int) - Method in class com.mccrory.scott.spumoni.StatsValue

Sets the min acceptable value before an SMTP trap is sent.

setStatsValues(StatsValueList) - Method in class com.mccrory.scott.spumoni.StatsProgram

Sets the program's Vector of StatsValue objects.

setValue(String) - Method in class com.mccrory.scott.spumoni.StatsValue

Sets the program value's actual collected value.

setValueName(String) - Method in class com.mccrory.scott.spumoni.StatsValue

Sets the value name.

setXmlFilename(String) - Method in class com.mccrory.scott.spumoni.StatsProgram

Sets the program's source XML filename.

SnmpAgentSessionError(SnmpAgentSession, int, Object) - Method in class com.mccrory.scott.spumoni.SnmpD

Process session errors.

SnmpD - class com.mccrory.scott.spumoni.SnmpD.

SnmpD implements a sample SNMP daemon.

SnmpD() - Constructor for class com.mccrory.scott.spumoni.SnmpD

SnmpDTest - class com.mccrory.scott.spumoni.test.SnmpDTest.

JUnit test case for the SnmpD class.

SnmpDTest(String) - Constructor for class com.mccrory.scott.spumoni.test.SnmpDTest

SnmpDTest constructor

snmpInternalError(SnmpSession, int, SnmpSyntax) - Method in class com.mccrory.scott.spumoni.SnmpTrapAgent

Stubbed out since we are only sending

snmpReceivedPdu(SnmpAgentSession, InetAddress, int, SnmpOctetString, SnmpPduPacket) - Method in class com.mccrory.scott.spumoni.SnmpD

The main method which receives SNMPv2c PDUs and forwards them to their specific handler methods.

snmpReceivedPdu(SnmpSession, int, SnmpPduPacket) - Method in class com.mccrory.scott.spumoni.SnmpTrapAgent

Stubbed out since we are only sending

snmpTimeoutError(SnmpSession, SnmpSyntax) - Method in class com.mccrory.scott.spumoni.SnmpTrapAgent

Stubbed out since we are only sending

SnmpTrapAgent - class com.mccrory.scott.spumoni.SnmpTrapAgent.

SnmpTrapAgent is a class that sends SNMP V1 or V2 traps to one (and only one) SNMP manager defined by its IP address and port number.

SnmpTrapAgent(String, int, String) - Constructor for class com.mccrory.scott.spumoni.SnmpTrapAgent

Builds an snmpagent object for sending SNMP V1 or V2 traps.

SnmpTrapAgentTest - class com.mccrory.scott.spumoni.test.SnmpTrapAgentTest.

JUnit test case for the SnmpTrapAgent class.

SnmpTrapAgentTest(String) - Constructor for class com.mccrory.scott.spumoni.test.SnmpTrapAgentTest

SnmpTrapAgentTest constructor

StatsCollector - class com.mccrory.scott.spumoni.StatsCollector.

Responsible for obtaining system statistics and storing them in a data file.

StatsCollector(String[]) - Constructor for class com.mccrory.scott.spumoni.StatsCollector

StatsCollector constructor.

StatsCollectorTest - class com.mccrory.scott.spumoni.test.StatsCollectorTest.

JUnit test case for the StatsCollector class.

StatsCollectorTest(String) - Constructor for class com.mccrory.scott.spumoni.test.StatsCollectorTest

StatsCollectorTest constructor

StatsProgram - class com.mccrory.scott.spumoni.StatsProgram.

StatsProgram is a data object for the statistics programs handled by Spumoni through the StatsCollector class.

StatsProgram() - Constructor for class com.mccrory.scott.spumoni.StatsProgram

Basic StatsProgram constructor.

StatsProgram(String, String, String, Vector, int, StatsValueList) - Constructor for class com.mccrory.scott.spumoni.StatsProgram

A convenience StatsProgram contructor to set all of the data elements at the time of creation.

StatsProgramList - class com.mccrory.scott.spumoni.StatsProgramList.

StatsProgramList is a collection of StatsProgram objects.

StatsProgramList() - Constructor for class com.mccrory.scott.spumoni.StatsProgramList

StatsProgramList constructor comment.

StatsProgramList(int) - Constructor for class com.mccrory.scott.spumoni.StatsProgramList

StatsValueList constructor with preset minimum size.

StatsProgramList(int, int) - Constructor for class com.mccrory.scott.spumoni.StatsProgramList

StatsValueList constructor with preset minimum size and capacity increment.

StatsProgramList(StatsProgram) - Constructor for class com.mccrory.scott.spumoni.StatsProgramList

Convenience constructor for creating a new StatsProgramList and populating it with a single StatsProgram.

StatsProgramListTest - class com.mccrory.scott.spumoni.test.StatsProgramListTest.

JUnit test case for the StatsProgramList class.

StatsProgramListTest(String) - Constructor for class com.mccrory.scott.spumoni.test.StatsProgramListTest

StatsProgramListTest constructor

StatsValue - class com.mccrory.scott.spumoni.StatsValue.

StatsValue is a data object for a statistics program's single value.

StatsValue() - Constructor for class com.mccrory.scott.spumoni.StatsValue

Basic StatsValue constructor.

StatsValue(String, String, int, int) - Constructor for class com.mccrory.scott.spumoni.StatsValue

A convenience StatsValue contructor to set all of the data elements at time of creation.

StatsValueList - class com.mccrory.scott.spumoni.StatsValueList.

StatsValueList is a collection of StatsValue objects.

StatsValueList() - Constructor for class com.mccrory.scott.spumoni.StatsValueList

Basic StatsValueList constructor.

StatsValueList(int) - Constructor for class com.mccrory.scott.spumoni.StatsValueList

StatsValueList constructor with preset minimum size.

StatsValueList(int, int) - Constructor for class com.mccrory.scott.spumoni.StatsValueList

StatsValueList constructor with preset minimum size and capacity increment.

StatsValueList(StatsValue) - Constructor for class com.mccrory.scott.spumoni.StatsValueList

Convenience constructor for creating a new StatsValueList and populating it with a single StatsValue.

StatsValueListTest - class com.mccrory.scott.spumoni.test.StatsValueListTest.

JUnit test case for the StatsValueList class.

StatsValueListTest(String) - Constructor for class com.mccrory.scott.spumoni.test.StatsValueListTest

StatsValueListTest constructor

T

testCollectStats() - Method in class com.mccrory.scott.base.test.ExecRunnerTest

Tests the StatsCollector operations.

testCollectStats() - Method in class com.mccrory.scott.spumoni.test.StatsCollectorTest

Tests the StatsCollector operations.

testOidConflicts() - Method in class com.mccrory.scott.spumoni.test.StatsProgramListTest

Tests the StatsProgramList getOidConflicts method

testSnmpD() - Method in class com.mccrory.scott.spumoni.test.SnmpDTest

Makes sure we can create the SnmpD object and send a few test GETs to it.

testSnmpTrapAgent() - Method in class com.mccrory.scott.spumoni.test.SnmpTrapAgentTest

Makes sure we can create the SnmpTrapAgent object and send V1 and V2 traps.

testStatsProgramList() - Method in class com.mccrory.scott.spumoni.test.StatsProgramListTest

Tests some StatsProgramList operations.

testStatsValueList() - Method in class com.mccrory.scott.spumoni.test.StatsValueListTest

Tests the StatsValueList operations.

toString() - Method in class com.mccrory.scott.spumoni.StatsValue

Returns a formatted String of this object's values

toString() - Method in class com.mccrory.scott.spumoni.StatsProgram

Returns a formatted String of this object's values

U

unset() - Method in class com.mccrory.scott.spumoni.StatsValue

Unsets the value

unsetStatsValues() - Method in class com.mccrory.scott.spumoni.StatsProgram

Unsets the values in all of the attached StatsValue objects.

unsetValues() - Method in class com.mccrory.scott.spumoni.StatsValueList

Unsets all of the values.

unsetValues() - Method in class com.mccrory.scott.spumoni.StatsProgramList

Unsets all of the values.

A C D E G H I M O R S T U