org.opennms.netmgt.dao.support
Class RrdFileConstants

java.lang.Object
  org.opennms.netmgt.dao.support.RrdFileConstants

public class RrdFileConstants
extends Object

A convenience class containing RRD file and directory related constants.

Version:

$Id: $

Author:

Mike Davidson , Lawrence Karnowski , Mike Davidson , Lawrence Karnowski

Field Summary

static FileFilter	DOMAIN_DIRECTORY_FILTER Convenience filter that matches non-integer-named directories that contain directories that contain RRD files.
static FileFilter	INTERFACE_DIRECTORY_FILTER Convenience filter that matches directories with RRD files in them.
static int	MAX_RRD_FILENAME_LENGTH The longest an RRD filename can be, currently 1024 characters.
static FileFilter	NODE_DIRECTORY_FILTER Convenience filter that matches integer-named directories that either contain RRD files or directories that contain RRD files.
static FilenameFilter	RRD_FILENAME_FILTER Convenience filter that matches only RRD files.

Constructor Summary

RrdFileConstants()

Method Summary

static String	convertToValidRrdName(String rrd) Note this method will not handle references to higher directories ("..").
static String	getRrdSuffix() getRrdSuffix
static boolean	isValidRRDDomainDir(File file) isValidRRDDomainDir
static boolean	isValidRRDInterfaceDir(File file) isValidRRDInterfaceDir
static boolean	isValidRRDLatencyDir(File file) Determines if the provided File object represents a valid RRD latency directory.
static boolean	isValidRRDName(String rrd) Checks an RRD filename to make sure it is of the proper length and does not contain any unexpected charaters.
static boolean	isValidRRDNodeDir(File file) isValidRRDNodeDir

Methods inherited from class java.lang.Object

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

Field Detail

MAX_RRD_FILENAME_LENGTH

public static final int MAX_RRD_FILENAME_LENGTH

The longest an RRD filename can be, currently 1024 characters.

See Also:

Constant Field Values

RRD_FILENAME_FILTER

public static final FilenameFilter RRD_FILENAME_FILTER

Convenience filter that matches only RRD files.

INTERFACE_DIRECTORY_FILTER

public static final FileFilter INTERFACE_DIRECTORY_FILTER

Convenience filter that matches directories with RRD files in them.

NODE_DIRECTORY_FILTER

public static final FileFilter NODE_DIRECTORY_FILTER

Convenience filter that matches integer-named directories that either contain RRD files or directories that contain RRD files.

DOMAIN_DIRECTORY_FILTER

public static final FileFilter DOMAIN_DIRECTORY_FILTER

Convenience filter that matches non-integer-named directories that contain directories that contain RRD files.

Constructor Detail

RrdFileConstants

public RrdFileConstants()

Method Detail

isValidRRDNodeDir

public static final boolean isValidRRDNodeDir(File file)

isValidRRDNodeDir

Parameters:

file - a File object.

Returns:

a boolean.

isValidRRDDomainDir

public static final boolean isValidRRDDomainDir(File file)

isValidRRDDomainDir

Parameters:

file - a File object.

Returns:

a boolean.

isValidRRDInterfaceDir

public static final boolean isValidRRDInterfaceDir(File file)

isValidRRDInterfaceDir

Parameters:

file - a File object.

Returns:

a boolean.

isValidRRDLatencyDir

public static final boolean isValidRRDLatencyDir(File file)

Determines if the provided File object represents a valid RRD latency directory.

Parameters:

file - a File object.

Returns:

a boolean.

isValidRRDName

public static boolean isValidRRDName(String rrd)

Checks an RRD filename to make sure it is of the proper length and does not contain any unexpected charaters. The maximum length is specified by the MAX_RRD_FILENAME_LENGTHconstant. The only valid characters are letters (A-Z and a-z), numbers (0-9), dashes (-), dots (.), and underscores (_). These precautions are necessary since the RRD filename is used on the commandline and specified in the graph URL.

Parameters:

rrd - a String object.

Returns:

a boolean.

convertToValidRrdName

public static String convertToValidRrdName(String rrd)

Note this method will not handle references to higher directories ("..").

Parameters:

rrd - a String object.

Returns:

a String object.

getRrdSuffix

public static String getRrdSuffix()

getRrdSuffix

Returns:

a String object.