|
OpenNMS API 1.2.3 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Defines an abstract strategy for manipulating round robin database file. This is used by the RrdUtils to implement the appropriate behaviour
Method Summary | |
void |
closeFile(java.lang.Object rrd)
This closes the supplied round robin database |
java.lang.Object |
createDefinition(java.lang.String creator,
java.lang.String directory,
java.lang.String dsName,
int step,
java.lang.String dsType,
int dsHeartbeat,
java.lang.String dsMin,
java.lang.String dsMax,
java.util.List rraList)
Create a round robin database definition from the supplied parameters. |
void |
createFile(java.lang.Object rrdDef)
Creates the round robin database defined by the supplied definition. |
java.io.InputStream |
createGraph(java.lang.String command,
java.io.File workDir)
Creates an InputStream representing the bytes of a graph created from round robin data. |
java.lang.Double |
fetchLastValue(java.lang.String rrdFile,
int interval)
Fetches the last value from the round robin database with the given name. |
java.lang.String |
getStats()
Provides the round robin database an opportunity to contribute statistics information to the logs file. |
void |
graphicsInitialize()
This Initializes the graphics subsystem only. |
void |
initialize()
Initialize the appropriate round robin system |
java.lang.Object |
openFile(java.lang.String fileName)
Opens the round robin database with the supplied name. |
void |
updateFile(java.lang.Object rrd,
java.lang.String data)
Updates the supplied round robin database with the given timestamp:value point |
Method Detail |
public void initialize() throws java.lang.Exception
java.lang.Exception
- if an Error occurspublic void graphicsInitialize() throws java.lang.Exception
java.lang.Exception
public java.lang.Object createDefinition(java.lang.String creator, java.lang.String directory, java.lang.String dsName, int step, java.lang.String dsType, int dsHeartbeat, java.lang.String dsMin, java.lang.String dsMax, java.util.List rraList) throws java.lang.Exception
creator
- -
A string representing who is creating this file for use in log
msgsdirectory
- -
The directory to create the file indsName
- -
The datasource name for use in the round robin databasestep
- -
the step for the databasedsType
- -
the type for the datasourcedsHeartbeat
- -
the heartbeat for the datasoucedsMin
- -
the minimum allowable value for the datasourcedsMax
- -
the maximum allowable value for the datasoucerraList
- -
a List of the round robin archives to create in the database
java.lang.Exception
- If an error occurs while creating the definitionpublic void createFile(java.lang.Object rrdDef) throws java.lang.Exception
rrdDef
- an round robin database definition created using the
createDefinition call.
java.lang.Exception
- if an error occurs create the filepublic java.lang.Object openFile(java.lang.String fileName) throws java.lang.Exception
fileName
- the name of the associated rrd file
java.lang.Exception
- if an error occurs opening the filepublic void updateFile(java.lang.Object rrd, java.lang.String data) throws java.lang.Exception
rrd
- an rrd object created using openFiledata
- a string of the form java.lang.Exception
- if an error occurs updating the filepublic void closeFile(java.lang.Object rrd) throws java.lang.Exception
rrd
- an rrd object created using openFile
java.lang.Exception
- if an error occurs closing the filepublic java.lang.Double fetchLastValue(java.lang.String rrdFile, int interval) throws java.lang.NumberFormatException, RrdException
rrdFile
- a name the represents a round robin databaseinterval
- a step interval of the round robin database
java.lang.NumberFormatException
RrdException
public java.io.InputStream createGraph(java.lang.String command, java.io.File workDir) throws java.io.IOException, RrdException
command
- the command needed to create the graphworkDir
- the directory that all referenced files are relative to
java.io.IOException
- if an IOError occurs
RrdException
- if an RRD error occurspublic java.lang.String getStats()
|
OpenNMS API 1.2.3 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |