org.opennms.netmgt.rrd.tcp

Class TcpRrdStrategy

java.lang.Object

org.opennms.netmgt.rrd.tcp.TcpRrdStrategy

All Implemented Interfaces:

RrdStrategy<TcpRrdStrategy.RrdDefinition,TcpRrdStrategy.RrdOutputSocketWithFilename>

public class TcpRrdStrategy
extends Object
implements RrdStrategy<TcpRrdStrategy.RrdDefinition,TcpRrdStrategy.RrdOutputSocketWithFilename>

Provides a TCP socket-based implementation of RrdStrategy that pushes update commands out in a simple serialized format.

The receiver of this strategy is not defined in any way. This is just a fire and forget strategy. There is no way to read data back into opennms.

Version:

$Id: $

Author:

ranger

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TcpRrdStrategy.RrdDefinition
static class	TcpRrdStrategy.RrdOutputSocketWithFilename

Constructor Summary

Constructors

Constructor and Description
TcpRrdStrategy()

Method Summary

Modifier and Type	Method and Description
void	closeFile(TcpRrdStrategy.RrdOutputSocketWithFilename rrd) closeFile
TcpRrdStrategy.RrdDefinition	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(TcpRrdStrategy.RrdDefinition rrdDef) createFile
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() getDefaultFileExtension
int	getGraphLeftOffset() getGraphLeftOffset
int	getGraphRightOffset() getGraphRightOffset
int	getGraphTopOffsetWithText() getGraphTopOffsetWithText
String	getHost() getHost
int	getPort() getPort
String	getStats() getStats
TcpRrdStrategy.RrdOutputSocketWithFilename	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	setHost(String host) setHost
void	setPort(int port) setPort
void	updateFile(TcpRrdStrategy.RrdOutputSocketWithFilename 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

TcpRrdStrategy

public TcpRrdStrategy()

Method Detail

getHost

public String getHost()

getHost

Returns:

a String object.

setConfigurationProperties

public void setConfigurationProperties(Properties configurationParameters)

setConfigurationProperties

Specified by:

setConfigurationProperties in interface RrdStrategy<TcpRrdStrategy.RrdDefinition,TcpRrdStrategy.RrdOutputSocketWithFilename>

Parameters:

configurationParameters - a Properties object.

setHost

public void setHost(String host)

setHost

Parameters:

host - a String object.

getPort

public int getPort()

getPort

Returns:

a int.

setPort

public void setPort(int port)

setPort

Parameters:

port - a int.

getDefaultFileExtension

public String getDefaultFileExtension()

getDefaultFileExtension

Specified by:

getDefaultFileExtension in interface RrdStrategy<TcpRrdStrategy.RrdDefinition,TcpRrdStrategy.RrdOutputSocketWithFilename>

Returns:

a String object.

createDefinition

public TcpRrdStrategy.RrdDefinition 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<TcpRrdStrategy.RrdDefinition,TcpRrdStrategy.RrdOutputSocketWithFilename>

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(TcpRrdStrategy.RrdDefinition rrdDef)
                throws Exception

createFile

Specified by:

createFile in interface RrdStrategy<TcpRrdStrategy.RrdDefinition,TcpRrdStrategy.RrdOutputSocketWithFilename>

Parameters:

rrdDef - a TcpRrdStrategy.RrdDefinition object.

Throws:

Exception - if any.

openFile

public TcpRrdStrategy.RrdOutputSocketWithFilename 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

Specified by:

openFile in interface RrdStrategy<TcpRrdStrategy.RrdDefinition,TcpRrdStrategy.RrdOutputSocketWithFilename>

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

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

Specified by:

updateFile in interface RrdStrategy<TcpRrdStrategy.RrdDefinition,TcpRrdStrategy.RrdOutputSocketWithFilename>

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

closeFile

public void closeFile(TcpRrdStrategy.RrdOutputSocketWithFilename rrd)
               throws Exception

closeFile

Specified by:

closeFile in interface RrdStrategy<TcpRrdStrategy.RrdDefinition,TcpRrdStrategy.RrdOutputSocketWithFilename>

Parameters:

rrd - a TcpRrdStrategy.RrdOutputSocketWithFilename object.

Throws:

Exception - if any.

fetchLastValue

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

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<TcpRrdStrategy.RrdDefinition,TcpRrdStrategy.RrdOutputSocketWithFilename>

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.

fetchLastValue

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

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<TcpRrdStrategy.RrdDefinition,TcpRrdStrategy.RrdOutputSocketWithFilename>

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.

fetchLastValueInRange

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

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<TcpRrdStrategy.RrdDefinition,TcpRrdStrategy.RrdOutputSocketWithFilename>

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.

createGraph

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

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<TcpRrdStrategy.RrdDefinition,TcpRrdStrategy.RrdOutputSocketWithFilename>

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

createGraphReturnDetails

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

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<TcpRrdStrategy.RrdDefinition,TcpRrdStrategy.RrdOutputSocketWithFilename>

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

getGraphLeftOffset

public int getGraphLeftOffset()

getGraphLeftOffset

Specified by:

getGraphLeftOffset in interface RrdStrategy<TcpRrdStrategy.RrdDefinition,TcpRrdStrategy.RrdOutputSocketWithFilename>

Returns:

a int.

getGraphRightOffset

public int getGraphRightOffset()

getGraphRightOffset

Specified by:

getGraphRightOffset in interface RrdStrategy<TcpRrdStrategy.RrdDefinition,TcpRrdStrategy.RrdOutputSocketWithFilename>

Returns:

a int.

getGraphTopOffsetWithText

public int getGraphTopOffsetWithText()

getGraphTopOffsetWithText

Specified by:

getGraphTopOffsetWithText in interface RrdStrategy<TcpRrdStrategy.RrdDefinition,TcpRrdStrategy.RrdOutputSocketWithFilename>

Returns:

a int.

getStats

public String getStats()

getStats

Specified by:

getStats in interface RrdStrategy<TcpRrdStrategy.RrdDefinition,TcpRrdStrategy.RrdOutputSocketWithFilename>

Returns:

a String object.

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<TcpRrdStrategy.RrdDefinition,TcpRrdStrategy.RrdOutputSocketWithFilename>

Parameters:

rrdFiles - a Collection object.