org.opennms.netmgt.capsd.plugins
Class JDBCPlugin

java.lang.Object
  org.opennms.netmgt.capsd.AbstractPlugin
      org.opennms.netmgt.capsd.plugins.JDBCPlugin

All Implemented Interfaces:

Plugin

Direct Known Subclasses:

JDBCStoredProcedurePlugin

public class JDBCPlugin
extends AbstractPlugin

This OpenNMS capsd plugin checks if a given server is running a server that can talk JDBC on a given interface. If true then the interface is "saved" for future service state checking. This plugin is slow; Stablishing a connection between the client and the server is an slow operation. A connection pool doesn't make any sense when discovering a database, Also opening and closing a connection every time helps to discover problems like a RDBMS running out of connections.

More plugin information available at: OpenNMS developer site

Since:

0.1

Version:

0.1 - 07/22/2002

Author:

Jose Vicente Nunez Zuleta (josevnz@users.sourceforge.net) - RHCE, SJCD, SJCP

Constructor Summary

JDBCPlugin()
Class constructor.

Method Summary

boolean	checkStatus(Connection con, Map<String,Object> qualifiers)
protected void	closeStmt(Statement statement)
String	getProtocolName() Returns the default protocol name
boolean	isProtocolSupported(InetAddress address) Default checking method, asuming all the parameters by default.
boolean	isProtocolSupported(InetAddress address, Map<String,Object> qualifiers) Checking method, receives all the parameters as a Map.
protected Category	log()

Methods inherited from class java.lang.Object

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

Constructor Detail

JDBCPlugin

public JDBCPlugin()

Class constructor. Load the JDBC drivers.

Method Detail

log

protected Category log()

checkStatus

public boolean checkStatus(Connection con,
                           Map<String,Object> qualifiers)

closeStmt

protected void closeStmt(Statement statement)

getProtocolName

public String getProtocolName()

Returns the default protocol name

Specified by:

getProtocolName in interface Plugin

Specified by:

getProtocolName in class AbstractPlugin

Returns:

String Protocol Name

isProtocolSupported

public boolean isProtocolSupported(InetAddress address)

Default checking method, asuming all the parameters by default. This method is likely to skip some machines because the default password is empty. is recomended to use the parametric method instead (unless your DBA is dummy enugh to leave a JDBC server with no password!!!).

Specified by:

isProtocolSupported in interface Plugin

Specified by:

isProtocolSupported in class AbstractPlugin

Parameters:

address - Address of the JDBC server to poll

Returns:

True if a JDBC server is running on this server, false otherwise

isProtocolSupported

public boolean isProtocolSupported(InetAddress address,
                                   Map<String,Object> qualifiers)

Checking method, receives all the parameters as a Map. Currently supported:

• port - Port where the JDBC server is listening (defaults to DEFAULT_PORT). Type: Integer
• user - Database user (defaults to DEFAULT_DATABASE_USER if not provided). Type String
• password - Database password (defaults to DEFAULT_DATABASE_PASSWORD). Type String
• timeout - Timeout
• retry - How many times will try to check for the service

Specified by:

isProtocolSupported in interface Plugin

Specified by:

isProtocolSupported in class AbstractPlugin

Parameters:

address - Address of the JDBC server to poll

qualifiers - Set of properties to be passed to the JDBC driver.

Returns:

True if a JDBC server is running on this server, false otherwise

Throws:

NullPointerException - if the properties or the address are not defined