org.opennms.netmgt.rrd.jrobin
Class JRobinRrdStrategy

java.lang.Object
  org.opennms.netmgt.rrd.jrobin.JRobinRrdStrategy

All Implemented Interfaces:

RrdStrategy<org.jrobin.core.RrdDef,org.jrobin.core.RrdDb>

public class JRobinRrdStrategy
extends Object
implements RrdStrategy<org.jrobin.core.RrdDef,org.jrobin.core.RrdDb>

Provides a JRobin based implementation of RrdStrategy. It uses JRobin 1.4 in FILE mode (NIO is too memory consuming for the large number of files that we open)

Version:

$Id: $

Author:

ranger

Constructor Summary

JRobinRrdStrategy()
Initialized the RrdDb to use the FILE factory because the NIO factory uses too much memory for our implementation.

Method Summary

protected void	addVdefDs(org.jrobin.graph.RrdGraphDef graphDef, String sourceName, String[] rhs, double start, double end, Map<String,List<String>> defs)
void	closeFile(org.jrobin.core.RrdDb rrdFile) Closes the JRobin RrdDb.
org.jrobin.core.RrdDef	createDefinition(String creator, String directory, String rrdName, int step, List<RrdDataSource> dataSources, List<String> rraList) Create a round robin database definition from the supplied parameters.
void	createFile(org.jrobin.core.RrdDef rrdDef) Creates the JRobin RrdDb from the def by opening the file and then closing.
InputStream	createGraph(String command, File workDir) Creates an InputStream representing the bytes of a graph created from round robin data.
protected org.jrobin.graph.RrdGraphDef	createGraphDef(File workDir, String[] commandArray) createGraphDef
RrdGraphDetails	createGraphReturnDetails(String command, File workDir) Creates an RrdGraphDetails object representing the graph created from round robin data.
static char[]	escapeIfNotPathSepInDEF(char encountered, char escaped, StringBuffer currToken) escapeIfNotPathSepInDEF
Double	fetchLastValue(String fileName, String ds, int interval) Fetches the last value from the round robin database with the given name.
Double	fetchLastValue(String fileName, String ds, String consolidationFunction, int interval) Fetches the last value from the round robin database with the given name.
Double	fetchLastValueInRange(String fileName, String ds, int interval, int range) Fetches the last value from the round robin database with the given name within a time range.
Properties	getConfigurationProperties() getConfigurationProperties
String	getDefaultFileExtension() getDefaultFileExtension
int	getGraphLeftOffset() getGraphLeftOffset
int	getGraphRightOffset() getGraphRightOffset
int	getGraphTopOffsetWithText() getGraphTopOffsetWithText
String	getStats() This implementation does not track any stats.
org.jrobin.core.RrdDb	openFile(String fileName) Opens the round robin database with the supplied name.
void	promoteEnqueuedFiles(Collection<String> rrdFiles) In the event that this is a queuing implementation of the RrdStrategy.
void	setConfigurationProperties(Properties configurationParameters) setConfigurationProperties
static String[]	tokenizeWithQuotingAndEscapes(String line, String delims, boolean processQuoted) tokenizeWithQuotingAndEscapes
static String[]	tokenizeWithQuotingAndEscapes(String line, String delims, boolean processQuoted, String tokens) Tokenize a String into an array of Strings.
void	updateFile(org.jrobin.core.RrdDb rrdFile, String owner, String data) Updates the supplied round robin database with the given timestamp:value point

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JRobinRrdStrategy

public JRobinRrdStrategy()
                  throws Exception

Initialized the RrdDb to use the FILE factory because the NIO factory uses too much memory for our implementation.

Throws:

Exception - if any.

Method Detail

getConfigurationProperties

public Properties getConfigurationProperties()

getConfigurationProperties

Returns:

a Properties object.

setConfigurationProperties

public void setConfigurationProperties(Properties configurationParameters)

setConfigurationProperties

Specified by:

setConfigurationProperties in interface RrdStrategy<org.jrobin.core.RrdDef,org.jrobin.core.RrdDb>

Parameters:

configurationParameters - a Properties object.

closeFile

public void closeFile(org.jrobin.core.RrdDb rrdFile)
               throws Exception

Closes the JRobin RrdDb.

Specified by:

closeFile in interface RrdStrategy<org.jrobin.core.RrdDef,org.jrobin.core.RrdDb>

Parameters:

rrdFile - a RrdDb object.

Throws:

Exception - if any.

createDefinition

public org.jrobin.core.RrdDef createDefinition(String creator,
                                               String directory,
                                               String rrdName,
                                               int step,
                                               List<RrdDataSource> dataSources,
                                               List<String> rraList)
                                        throws Exception

Create a round robin database definition from the supplied parameters. This definition is used in the createFile call to create the actual file.

Specified by:

createDefinition in interface RrdStrategy<org.jrobin.core.RrdDef,org.jrobin.core.RrdDb>

Parameters:

creator - - A string representing who is creating this file for use in log msgs

directory - - The directory to create the file in

rrdName - - The name to use for the round robin database

step - - the step for the database

dataSources - - the data sources to use for round robin database

rraList - - a List of the round robin archives to create in the database

Returns:

an object representing the definition of an round robin database

Throws:

Exception - If an error occurs while creating the definition

createFile

public void createFile(org.jrobin.core.RrdDef rrdDef)
                throws Exception

Creates the JRobin RrdDb from the def by opening the file and then closing. TODO: Change the interface here to create the file and return it opened.

Specified by:

createFile in interface RrdStrategy<org.jrobin.core.RrdDef,org.jrobin.core.RrdDb>

Parameters:

rrdDef - a RrdDef object.

Throws:

Exception - if any.

openFile

public org.jrobin.core.RrdDb openFile(String fileName)
                               throws Exception

Opens the round robin database with the supplied name. It is assumed the name refers to a round robin database appropriate for this strategy implementation Opens the JRobin RrdDb by name and returns it.

Specified by:

openFile in interface RrdStrategy<org.jrobin.core.RrdDef,org.jrobin.core.RrdDb>

Parameters:

fileName - the name of the associated rrd file

Returns:

an open rrd reference that can by used in calls to updateFile and closeFile

Throws:

Exception - if an error occurs opening the file

updateFile

public void updateFile(org.jrobin.core.RrdDb rrdFile,
                       String owner,
                       String data)
                throws Exception

Updates the supplied round robin database with the given timestamp:value point Creates a sample from the JRobin RrdDb and passes in the data provided.

Specified by:

updateFile in interface RrdStrategy<org.jrobin.core.RrdDef,org.jrobin.core.RrdDb>

Parameters:

rrdFile - an rrd object created using openFile

owner - the owner of the rrd

data - a string of the form :

Throws:

Exception - if an error occurs updating the file

fetchLastValue

public Double fetchLastValue(String fileName,
                             String ds,
                             int interval)
                      throws NumberFormatException,
                             RrdException

Fetches the last value from the round robin database with the given name. The interval passed in should be the interval associated with the round robin database. Fetch the last value from the JRobin RrdDb file.

Specified by:

fetchLastValue in interface RrdStrategy<org.jrobin.core.RrdDef,org.jrobin.core.RrdDb>

Parameters:

fileName - a name the represents a round robin database

ds - a name the represents a data source to be used

interval - a step interval of the round robin database

Returns:

The last value as a Double (if the last value didn't exist returns a Double.NaN)

Throws:

NumberFormatException - if any.

RrdException - if any.

fetchLastValue

public Double fetchLastValue(String fileName,
                             String ds,
                             String consolidationFunction,
                             int interval)
                      throws RrdException

Fetches the last value from the round robin database with the given name. The interval passed in should be the interval associated with the round robin database.

Specified by:

fetchLastValue in interface RrdStrategy<org.jrobin.core.RrdDef,org.jrobin.core.RrdDb>

Parameters:

fileName - a name the represents a round robin database

ds - a name the represents a data source to be used

consolidationFunction - a String object.

interval - a step interval of the round robin database

Returns:

The last value as a Double (if the last value didn't exist returns a Double.NaN)

Throws:

RrdException - if any.

fetchLastValueInRange

public Double fetchLastValueInRange(String fileName,
                                    String ds,
                                    int interval,
                                    int range)
                             throws NumberFormatException,
                                    RrdException

Fetches the last value from the round robin database with the given name within a time range. The interval passed in should be the interval associated with the round robin database. The range should be the amount of "lag" acceptable for an update to be considered valid. Range must be a multiple of the RRD interval.

Specified by:

fetchLastValueInRange in interface RrdStrategy<org.jrobin.core.RrdDef,org.jrobin.core.RrdDb>

Parameters:

fileName - a name the represents a round robin database

ds - a name the represents a data source to be used

interval - a step interval of the round robin database

range - an acceptable range for which the last value will be returned

Returns:

The last value as a Double (if the last value didn't exist returns a Double.NaN)

Throws:

NumberFormatException - if any.

RrdException - if any.

createGraph

public InputStream createGraph(String command,
                               File workDir)
                        throws IOException,
                               RrdException

Creates an InputStream representing the bytes of a graph created from round robin data. It accepts an rrdtool graph command. The underlying implementation converts this command to a format appropriate for it .

Specified by:

createGraph in interface RrdStrategy<org.jrobin.core.RrdDef,org.jrobin.core.RrdDb>

Parameters:

command - the command needed to create the graph

workDir - the directory that all referenced files are relative to

Returns:

an input stream representing the bytes of a graph image as a PNG file

Throws:

IOException - if an IOError occurs

RrdException - if an RRD error occurs

createGraphReturnDetails

public RrdGraphDetails createGraphReturnDetails(String command,
                                                File workDir)
                                         throws IOException,
                                                RrdException

Creates an RrdGraphDetails object representing the graph created from round robin data. It accepts an rrdtool graph command. The underlying implementation converts this command to a format appropriate for it . This constructs a graphDef by parsing the rrdtool style command and using the values to create the JRobin graphDef. It does not understand the 'AT style' time arguments however. Also there may be some rrdtool parameters that it does not understand. These will be ignored. The graphDef will be used to construct an RrdGraph and a PNG image will be created. An input stream returning the bytes of the PNG image is returned.

Specified by:

createGraphReturnDetails in interface RrdStrategy<org.jrobin.core.RrdDef,org.jrobin.core.RrdDb>

Parameters:

command - the command needed to create the graph

workDir - the directory that all referenced files are relative to

Returns:

details for the graph including an InputStream, any PRINTed lines, and graph dimensions.

Throws:

IOException - if an IOError occurs

RrdException - if an RRD error occurs

promoteEnqueuedFiles

public void promoteEnqueuedFiles(Collection<String> rrdFiles)

In the event that this is a queuing implementation of the RrdStrategy. This method causes all queued but not yet written data to be to the rrd files as soon as possible.

Specified by:

promoteEnqueuedFiles in interface RrdStrategy<org.jrobin.core.RrdDef,org.jrobin.core.RrdDb>

Parameters:

rrdFiles - a Collection object.

createGraphDef

protected org.jrobin.graph.RrdGraphDef createGraphDef(File workDir,
                                                      String[] commandArray)
                                               throws org.jrobin.core.RrdException

createGraphDef

Parameters:

workDir - a File object.

commandArray - an array of String objects.

Returns:

a RrdGraphDef object.

Throws:

org.jrobin.core.RrdException - if any.

getStats

public String getStats()

This implementation does not track any stats.

Specified by:

getStats in interface RrdStrategy<org.jrobin.core.RrdDef,org.jrobin.core.RrdDb>

Returns:

a String object.

getGraphLeftOffset

public int getGraphLeftOffset()

getGraphLeftOffset

Specified by:

getGraphLeftOffset in interface RrdStrategy<org.jrobin.core.RrdDef,org.jrobin.core.RrdDb>

Returns:

a int.

getGraphRightOffset

public int getGraphRightOffset()

getGraphRightOffset

Specified by:

getGraphRightOffset in interface RrdStrategy<org.jrobin.core.RrdDef,org.jrobin.core.RrdDb>

Returns:

a int.

getGraphTopOffsetWithText

public int getGraphTopOffsetWithText()

getGraphTopOffsetWithText

Specified by:

getGraphTopOffsetWithText in interface RrdStrategy<org.jrobin.core.RrdDef,org.jrobin.core.RrdDb>

Returns:

a int.

getDefaultFileExtension

public String getDefaultFileExtension()

getDefaultFileExtension

Specified by:

getDefaultFileExtension in interface RrdStrategy<org.jrobin.core.RrdDef,org.jrobin.core.RrdDb>

Returns:

a String object.

tokenizeWithQuotingAndEscapes

public static String[] tokenizeWithQuotingAndEscapes(String line,
                                                     String delims,
                                                     boolean processQuoted)

tokenizeWithQuotingAndEscapes

Parameters:

line - a String object.

delims - a String object.

processQuoted - a boolean.

Returns:

an array of String objects.

tokenizeWithQuotingAndEscapes

public static String[] tokenizeWithQuotingAndEscapes(String line,
                                                     String delims,
                                                     boolean processQuoted,
                                                     String tokens)

Tokenize a String into an array of Strings.

Parameters:

line - the string to tokenize

delims - a string containing zero or more characters to treat as a delimiter

processQuoted - whether or not to process escaped values inside quotes

tokens - custom escaped tokens to pass through, escaped. For example, if tokens contains "lsg", then \l, \s, and \g will be passed through unescaped.

Returns:

an array of String objects.

escapeIfNotPathSepInDEF

public static char[] escapeIfNotPathSepInDEF(char encountered,
                                             char escaped,
                                             StringBuffer currToken)

escapeIfNotPathSepInDEF

Parameters:

encountered - a char.

escaped - a char.

currToken - a StringBuffer object.

Returns:

an array of char.

addVdefDs

protected void addVdefDs(org.jrobin.graph.RrdGraphDef graphDef,
                         String sourceName,
                         String[] rhs,
                         double start,
                         double end,
                         Map<String,List<String>> defs)
                  throws org.jrobin.core.RrdException

Throws:

org.jrobin.core.RrdException