Module com.aoindustries.noc.monitor.portmon

Package com.aoindustries.noc.monitor.portmon

Class JdbcPortMonitor

java.lang.Object

com.aoindustries.noc.monitor.portmon.PortMonitor

com.aoindustries.noc.monitor.portmon.JdbcPortMonitor

Direct Known Subclasses:

MysqlPortMonitor, PostgresqlPortMonitor

public abstract class JdbcPortMonitor
extends PortMonitor

Monitors a database over JDBC.

Author:

AO Industries, Inc.

Field Summary

Fields

Modifier and Type	Field	Description
protected final boolean	readOnly
protected static final int	TIMEOUT

Fields inherited from class com.aoindustries.noc.monitor.portmon.PortMonitor

canceled, CRLF, ipAddress, port

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	JdbcPortMonitor(InetAddress ipAddress, Port port, URIParameters monitoringParameters)	Creates a new JDBC monitor.

Method Summary

Modifier and Type	Method	Description
void	cancel()	Cancels this port method on a best effort basis.
final String	checkPort()	Checks the port.
protected abstract String	getDefaultDatabase()	Gets the default JDBC database.
protected String	getDefaultQuery()
protected abstract String	getDefaultUsername()	Gets the default JDBC username.
protected abstract String	getDriver()	Gets the driver classname.
protected abstract String	getJdbcUrl(InetAddress ipAddress, int port, String database)	Generates the JDBC URL.

Methods inherited from class com.aoindustries.noc.monitor.portmon.PortMonitor

getPortMonitor, readLine

Methods inherited from class java.lang.Object

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

Field Details

TIMEOUT

protected static final int TIMEOUT

See Also:

• Constant Field Values

readOnly

protected final boolean readOnly

Constructor Details

JdbcPortMonitor

protected JdbcPortMonitor(InetAddress ipAddress,
 Port port,
 URIParameters monitoringParameters)

Creates a new JDBC monitor.

Method Details

checkPort

public final String checkPort()
                       throws Exception

Description copied from class: PortMonitor

Checks the port. This may take arbitrarily long to complete, and any timeout should be provided externally and call the cancel method. If any error occurs, must throw an exception.

Specified by:

checkPort in class PortMonitor

Returns:

the message indicating success

Throws:

Exception

See Also:

• PortMonitor.cancel()

cancel

public void cancel()

Description copied from class: PortMonitor

Cancels this port method on a best effort basis. This will not necessarily cause the checkPort method to return immediately. This should only be used once the result of checkPort is no longer relevant, such as after a timeout. Some monitors may still perform their task arbitrarily long after cancel has been called.

It is critical that subclass implementations of this method not block in any way.

Overrides:

cancel in class PortMonitor

See Also:

• PortMonitor.checkPort()

getDriver

protected abstract String getDriver()

Gets the driver classname.

getJdbcUrl

protected abstract String getJdbcUrl(InetAddress ipAddress,
 int port,
 String database)

Generates the JDBC URL.

getDefaultUsername

protected abstract String getDefaultUsername()

Gets the default JDBC username.

getDefaultDatabase

protected abstract String getDefaultDatabase()

Gets the default JDBC database.

getDefaultQuery

protected String getDefaultQuery()