org.opennms.web.vulnerability
Class VulnerabilityFactory

java.lang.Object
  org.opennms.web.vulnerability.VulnerabilityFactory

public class VulnerabilityFactory
extends Object

Encapsulates all querying functionality for vulnerabilities.

Since:

1.8.1

Version:

$Id: $

Author:

Lawrence Karnowski , OpenNMS , Lawrence Karnowski , OpenNMS

Nested Class Summary

static class	VulnerabilityFactory.ResolutionType Convenience class to determine what sort of events to include in a query.
static class	VulnerabilityFactory.SortStyle Convenience class to determine sort style of a query.

Field Summary

protected static ThreadCategory

log Constant log

Method Summary

protected static String	getOrderByClause(VulnerabilityFactory.SortStyle sortStyle) Convenience method for getting the SQL ORDER BY clause related to a given sort style.
protected static String	getResolutionTypeClause(VulnerabilityFactory.ResolutionType resType) Convenience method for getting the SQL WHERE clause related to a given resolution type.
static Vulnerability[]	getVulnerabilities() Return all open vulnerabilities sorted by time.
static Vulnerability[]	getVulnerabilities(VulnerabilityFactory.ResolutionType resType) Return all open or resolved vulnerabilities sorted by identifier.
static Vulnerability[]	getVulnerabilities(VulnerabilityFactory.SortStyle sortStyle) Return all open vulnerabilities sorted by the given sort style.
static Vulnerability[]	getVulnerabilities(VulnerabilityFactory.SortStyle sortStyle, VulnerabilityFactory.ResolutionType resType) Return all vulnerabilities (optionally only open vulnerabilities) sorted by the given sort style.
static Vulnerability[]	getVulnerabilities(VulnerabilityFactory.SortStyle sortStyle, VulnerabilityFactory.ResolutionType resType, Filter[] filters) Return all vulnerabilities (optionally only open vulnerabilities) sorted by the given sort style.
static Vulnerability[]	getVulnerabilities(VulnerabilityFactory.SortStyle sortStyle, VulnerabilityFactory.ResolutionType resType, Filter[] filters, int limit, int offset) Return all vulnerabilities (optionally only open vulnerabilities) sorted by the given sort style.
static Vulnerability[]	getVulnerabilitiesForNode(int nodeId, VulnerabilityFactory.SortStyle sortStyle, VulnerabilityFactory.ResolutionType resType, int throttle, int offset, javax.servlet.ServletContext servletContext) Return some maximum number of vulnerabilities or less sorted by the given sort style for the given node.
static Vulnerability	getVulnerability(int vulId) Return a specific vulnerability.
static int	getVulnerabilityCount() Count all open vulnerabilities.
static int	getVulnerabilityCount(VulnerabilityFactory.ResolutionType resType, Filter[] filters) Count the number of vulnerabilities for a given resolution type and given filters..
static int	getVulnerabilityCountForInterface(int nodeId, String ipAddress, VulnerabilityFactory.ResolutionType resType, javax.servlet.ServletContext servletContext) Return the number of vulnerabilities for this IP address and the given resolution type.
static int	getVulnerabilityCountForNode(int nodeId, VulnerabilityFactory.ResolutionType resType, javax.servlet.ServletContext servletContext) Return the number of vulnerabilities for this node and the given resolution type.
static Vulnerability[]	getVulnerablilitiesForInterface(int nodeId, String ipAddress, VulnerabilityFactory.SortStyle sortStyle, VulnerabilityFactory.ResolutionType resType, int throttle, int offset, javax.servlet.ServletContext servletContext) Return some maximum number of events or less (optionally only unacknowledged events) sorted by the given sort style for the given IP address.
protected static Vulnerability[]	rs2Vulnerabilities(ResultSet rs) Convenience method for translating a java.sql.ResultSet containing vulnerability information into an array of Vulnerability objects.

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static final ThreadCategory log

Constant log

Method Detail

getVulnerabilityCount

public static int getVulnerabilityCount()
                                 throws SQLException

Count all open vulnerabilities.

Returns:

a int.

Throws:

SQLException - if any.

getVulnerabilityCount

public static int getVulnerabilityCount(VulnerabilityFactory.ResolutionType resType,
                                        Filter[] filters)
                                 throws SQLException

Count the number of vulnerabilities for a given resolution type and given filters..

Parameters:

resType - a VulnerabilityFactory.ResolutionType object.

filters - an array of Filter objects.

Returns:

a int.

Throws:

SQLException - if any.

getVulnerability

public static Vulnerability getVulnerability(int vulId)
                                      throws SQLException

Return a specific vulnerability.

Parameters:

vulId - a int.

Returns:

a Vulnerability object.

Throws:

SQLException - if any.

getVulnerabilitiesForNode

public static Vulnerability[] getVulnerabilitiesForNode(int nodeId,
                                                        VulnerabilityFactory.SortStyle sortStyle,
                                                        VulnerabilityFactory.ResolutionType resType,
                                                        int throttle,
                                                        int offset,
                                                        javax.servlet.ServletContext servletContext)
                                                 throws SQLException

Return some maximum number of vulnerabilities or less sorted by the given sort style for the given node.

Parameters:

throttle - a value less than one means no throttling

nodeId - a int.

sortStyle - a VulnerabilityFactory.SortStyle object.

resType - a VulnerabilityFactory.ResolutionType object.

offset - a int.

Returns:

an array of Vulnerability objects.

Throws:

SQLException - if any.

getVulnerabilityCountForNode

public static int getVulnerabilityCountForNode(int nodeId,
                                               VulnerabilityFactory.ResolutionType resType,
                                               javax.servlet.ServletContext servletContext)
                                        throws SQLException

Return the number of vulnerabilities for this node and the given resolution type.

Parameters:

nodeId - a int.

resType - a VulnerabilityFactory.ResolutionType object.

Returns:

a int.

Throws:

SQLException - if any.

getVulnerablilitiesForInterface

public static Vulnerability[] getVulnerablilitiesForInterface(int nodeId,
                                                              String ipAddress,
                                                              VulnerabilityFactory.SortStyle sortStyle,
                                                              VulnerabilityFactory.ResolutionType resType,
                                                              int throttle,
                                                              int offset,
                                                              javax.servlet.ServletContext servletContext)
                                                       throws SQLException

Return some maximum number of events or less (optionally only unacknowledged events) sorted by the given sort style for the given IP address.

Parameters:

throttle - a value less than one means no throttling

offset - which row to start on in the result list

nodeId - a int.

ipAddress - a String object.

sortStyle - a VulnerabilityFactory.SortStyle object.

resType - a VulnerabilityFactory.ResolutionType object.

Returns:

an array of Vulnerability objects.

Throws:

SQLException - if any.

getVulnerabilityCountForInterface

public static int getVulnerabilityCountForInterface(int nodeId,
                                                    String ipAddress,
                                                    VulnerabilityFactory.ResolutionType resType,
                                                    javax.servlet.ServletContext servletContext)
                                             throws SQLException

Return the number of vulnerabilities for this IP address and the given resolution type.

Parameters:

nodeId - a int.

ipAddress - a String object.

resType - a VulnerabilityFactory.ResolutionType object.

Returns:

a int.

Throws:

SQLException - if any.

getVulnerabilities

public static Vulnerability[] getVulnerabilities()
                                          throws SQLException

Return all open vulnerabilities sorted by time.

Returns:

an array of Vulnerability objects.

Throws:

SQLException - if any.

getVulnerabilities

public static Vulnerability[] getVulnerabilities(VulnerabilityFactory.ResolutionType resType)
                                          throws SQLException

Return all open or resolved vulnerabilities sorted by identifier.

Parameters:

resType - a VulnerabilityFactory.ResolutionType object.

Returns:

an array of Vulnerability objects.

Throws:

SQLException - if any.

getVulnerabilities

public static Vulnerability[] getVulnerabilities(VulnerabilityFactory.SortStyle sortStyle)
                                          throws SQLException

Return all open vulnerabilities sorted by the given sort style.

Parameters:

sortStyle - a VulnerabilityFactory.SortStyle object.

Returns:

an array of Vulnerability objects.

Throws:

SQLException - if any.

getVulnerabilities

public static Vulnerability[] getVulnerabilities(VulnerabilityFactory.SortStyle sortStyle,
                                                 VulnerabilityFactory.ResolutionType resType)
                                          throws SQLException

Return all vulnerabilities (optionally only open vulnerabilities) sorted by the given sort style.

Parameters:

sortStyle - a VulnerabilityFactory.SortStyle object.

resType - a VulnerabilityFactory.ResolutionType object.

Returns:

an array of Vulnerability objects.

Throws:

SQLException - if any.

getVulnerabilities

public static Vulnerability[] getVulnerabilities(VulnerabilityFactory.SortStyle sortStyle,
                                                 VulnerabilityFactory.ResolutionType resType,
                                                 Filter[] filters)
                                          throws SQLException

Return all vulnerabilities (optionally only open vulnerabilities) sorted by the given sort style.

Parameters:

sortStyle - a VulnerabilityFactory.SortStyle object.

resType - a VulnerabilityFactory.ResolutionType object.

filters - an array of Filter objects.

Returns:

an array of Vulnerability objects.

Throws:

SQLException - if any.

getVulnerabilities

public static Vulnerability[] getVulnerabilities(VulnerabilityFactory.SortStyle sortStyle,
                                                 VulnerabilityFactory.ResolutionType resType,
                                                 Filter[] filters,
                                                 int limit,
                                                 int offset)
                                          throws SQLException

Return all vulnerabilities (optionally only open vulnerabilities) sorted by the given sort style.

Note: This limit/offset code is Postgres specific! Per Shane , this is okay for now until we can come up with an Oracle alternative too.

Parameters:

limit - if -1 or zero, no limit or offset is used

offset - if -1, no limit or offset if used

sortStyle - a VulnerabilityFactory.SortStyle object.

resType - a VulnerabilityFactory.ResolutionType object.

filters - an array of Filter objects.

Returns:

an array of Vulnerability objects.

Throws:

SQLException - if any.

rs2Vulnerabilities

protected static Vulnerability[] rs2Vulnerabilities(ResultSet rs)
                                             throws SQLException

Convenience method for translating a java.sql.ResultSet containing vulnerability information into an array of Vulnerability objects.

Parameters:

rs - a ResultSet object.

Returns:

an array of Vulnerability objects.

Throws:

SQLException - if any.

getOrderByClause

protected static String getOrderByClause(VulnerabilityFactory.SortStyle sortStyle)

Convenience method for getting the SQL ORDER BY clause related to a given sort style.

Parameters:

sortStyle - a VulnerabilityFactory.SortStyle object.

Returns:

a String object.

getResolutionTypeClause

protected static String getResolutionTypeClause(VulnerabilityFactory.ResolutionType resType)

Convenience method for getting the SQL WHERE clause related to a given resolution type.

Parameters:

resType - the resolution type to map to a clause

Returns:

a String object.