org.opennms.netmgt.dao.support

Class NullRrdStrategy

java.lang.Object

org.opennms.netmgt.dao.support.NullRrdStrategy

All Implemented Interfaces:

RrdStrategy<Object,Object>

public class NullRrdStrategy
extends Object
implements RrdStrategy<Object,Object>

Constructor Summary

Constructors

Constructor and Description
NullRrdStrategy()

Method Summary

Modifier and Type	Method and Description
void	closeFile(Object rrd) This closes the supplied round robin database
Object	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(Object rrdDef, Map<String,String> attrMapping) Creates the round robin database defined by the supplied definition.
InputStream	createGraph(String command, File workDir) Creates an InputStream representing the bytes of a graph created from round robin data.
RrdGraphDetails	createGraphReturnDetails(String command, File workDir) Creates an RrdGraphDetails object representing the graph created from round robin data.
Double	fetchLastValue(String rrdFile, String ds, int interval) Fetches the last value from the round robin database with the given name.
Double	fetchLastValue(String rrdFile, String ds, String consolidationFunction, int interval) Fetches the last value from the round robin database with the given name.
Double	fetchLastValueInRange(String rrdFile, String ds, int interval, int range) Fetches the last value from the round robin database with the given name within a time range.
String	getDefaultFileExtension() Get the file extension appropriate for files of this type
int	getGraphLeftOffset() Returns the number of pixels that the leftt-hand side of the graph is offset from the left side of the created image.
int	getGraphRightOffset() Returns the number of pixels that the right-hand side of the graph is offset from the right side of the created image.
int	getGraphTopOffsetWithText() Returns the number of pixels that the top of the graph is offset from the top of the created image if there is single line of header text.
String	getStats() Provides the round robin database an opportunity to contribute statistics information to the logs file.
void	graphicsInitialize()
void	initialize()
Object	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
void	updateFile(Object rrd, 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

NullRrdStrategy

public NullRrdStrategy()

Method Detail

setConfigurationProperties

public void setConfigurationProperties(Properties configurationParameters)

Description copied from interface: RrdStrategy

setConfigurationProperties

Specified by:

setConfigurationProperties in interface RrdStrategy<Object,Object>

Parameters:

configurationParameters - a Properties object.

closeFile

public void closeFile(Object rrd)
               throws Exception

Description copied from interface: RrdStrategy

This closes the supplied round robin database

Specified by:

closeFile in interface RrdStrategy<Object,Object>

Parameters:

rrd - an rrd object created using openFile

Throws:

Exception - if an error occurs closing the file

createDefinition

public Object createDefinition(String creator,
                               String directory,
                               String rrdName,
                               int step,
                               List<RrdDataSource> dataSources,
                               List<String> rraList)
                        throws Exception

Description copied from interface: RrdStrategy

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<Object,Object>

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. defines after which time the data is condensed to a defined lower step

Returns:

an object representing the definition of an round robin database. Can be null if the database exists already.

Throws:

Exception - If an error occurs while creating the definition

createFile

public void createFile(Object rrdDef,
                       Map<String,String> attrMapping)
                throws Exception

Description copied from interface: RrdStrategy

Creates the round robin database defined by the supplied definition. Should be able to handle rrdDef being null.

Specified by:

createFile in interface RrdStrategy<Object,Object>

Parameters:

rrdDef - an round robin database definition created using the createDefinition call.

attrMapping - a Map that represents the mapping of attributeId to rrd track names. default there is only one track per datasource, but it is possible to store multiple tracks in one datasource

Throws:

Exception - if an error occurs create the file

createGraph

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

Description copied from interface: RrdStrategy

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<Object,Object>

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

Description copied from interface: RrdStrategy

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 .

Specified by:

createGraphReturnDetails in interface RrdStrategy<Object,Object>

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

fetchLastValue

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

Description copied from interface: RrdStrategy

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<Object,Object>

Parameters:

rrdFile - 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.

fetchLastValueInRange

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

Description copied from interface: RrdStrategy

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<Object,Object>

Parameters:

rrdFile - 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.

getStats

public String getStats()

Description copied from interface: RrdStrategy

Provides the round robin database an opportunity to contribute statistics information to the logs file.

Specified by:

getStats in interface RrdStrategy<Object,Object>

Returns:

a non-null string representing any statistics to be included in the logs

graphicsInitialize

public void graphicsInitialize()
                        throws Exception

Throws:

Exception

initialize

public void initialize()
                throws Exception

Throws:

Exception

openFile

public Object openFile(String fileName)
                throws Exception

Description copied from interface: RrdStrategy

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

Specified by:

openFile in interface RrdStrategy<Object,Object>

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(Object rrd,
                       String owner,
                       String data)
                throws Exception

Description copied from interface: RrdStrategy

Updates the supplied round robin database with the given timestamp:value point

Specified by:

updateFile in interface RrdStrategy<Object,Object>

Parameters:

rrd - 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

getGraphLeftOffset

public int getGraphLeftOffset()

Description copied from interface: RrdStrategy

Returns the number of pixels that the leftt-hand side of the graph is offset from the left side of the created image. The offset should always be positive.

Specified by:

getGraphLeftOffset in interface RrdStrategy<Object,Object>

Returns:

offset in pixels. Should always be positive.

getGraphRightOffset

public int getGraphRightOffset()

Description copied from interface: RrdStrategy

Returns the number of pixels that the right-hand side of the graph is offset from the right side of the created image. The offset should always be negative.

Specified by:

getGraphRightOffset in interface RrdStrategy<Object,Object>

Returns:

offset in pixels. Should always be negative.

getGraphTopOffsetWithText

public int getGraphTopOffsetWithText()

Description copied from interface: RrdStrategy

Returns the number of pixels that the top of the graph is offset from the top of the created image if there is single line of header text. The offset should always be negative.

Specified by:

getGraphTopOffsetWithText in interface RrdStrategy<Object,Object>

Returns:

offset in pixels. Should always be negative.

getDefaultFileExtension

public String getDefaultFileExtension()

Description copied from interface: RrdStrategy

Get the file extension appropriate for files of this type

Specified by:

getDefaultFileExtension in interface RrdStrategy<Object,Object>

Returns:

a String object.

fetchLastValue

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

Description copied from interface: RrdStrategy

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<Object,Object>

Parameters:

rrdFile - 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:

NumberFormatException - if any.

RrdException - if any.

promoteEnqueuedFiles

public void promoteEnqueuedFiles(Collection<String> rrdFiles)

Description copied from interface: RrdStrategy

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<Object,Object>

Parameters:

rrdFiles - a Collection object.