org.opennms.netmgt.capsd.plugins

Class HttpPlugin

java.lang.Object

org.opennms.netmgt.capsd.AbstractPlugin

org.opennms.netmgt.capsd.AbstractTcpPlugin

org.opennms.netmgt.capsd.plugins.HttpPlugin

All Implemented Interfaces:

Plugin

Direct Known Subclasses:

HttpsPlugin, NotesHttpPlugin

public class HttpPlugin
extends AbstractTcpPlugin

This class is designed to be used by the capabilities daemon to test for the existance of an HTTP server on remote interfaces. The class implements the Plugin interface that allows it to be used along with other plugins by the daemon. This plugin generates a HTTP GET request and checks the return code returned by the remote host to determine if it supports the protocol. The remote host's response will be deemed valid if the return code falls in the 100 to 599 range (inclusive). This is based on the following information from RFC 1945 (HTTP 1.0) HTTP 1.0 GET return codes: 1xx: Informational - Not used, future use 2xx: Success 3xx: Redirection 4xx: Client error 5xx: Server error

This plugin generates a HTTP GET request and checks the return code returned by the remote host to determine if it supports the protocol. The remote host's response will be deemed valid if the return code falls in the 100 to 599 range (inclusive). This is based on the following information from RFC 1945 (HTTP 1.0) HTTP 1.0 GET return codes: 1xx: Informational - Not used, future use 2xx: Success 3xx: Redirection 4xx: Client error 5xx: Server error

This plugin generates a HTTP GET request and checks the return code returned by the remote host to determine if it supports the protocol. The remote host's response will be deemed valid if the return code falls in the 100 to 599 range (inclusive). This is based on the following information from RFC 1945 (HTTP 1.0) HTTP 1.0 GET return codes: 1xx: Informational - Not used, future use 2xx: Success 3xx: Redirection 4xx: Client error 5xx: Server error

Author:

Mathew Brozowski, Sowmya , Weaver , OpenNMS

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	CHECK_RETURN_CODE Boolean indicating whether to check for a return code
static String	DEFAULT_URL The query to send to the HTTP server
protected static String	PROPERTY_NAME_MAX_RET_CODE Constant PROPERTY_NAME_MAX_RET_CODE="max-ret-code"
protected static String	PROPERTY_NAME_PORT Constant PROPERTY_NAME_PORT="port"
protected static String	PROPERTY_NAME_RESPONSE_TEXT Constant PROPERTY_NAME_RESPONSE_TEXT="response-text"
protected static String	PROPERTY_NAME_RETURN_CODE Constant PROPERTY_NAME_RETURN_CODE="check-return-code"
protected static String	PROPERTY_NAME_URL Constant PROPERTY_NAME_URL="url"
static String	PROTOCOL_NAME Constant PROTOCOL_NAME="HTTP"
static String	QUERY_STRING The query to send to the HTTP server
static String	RESPONSE_STRING A string to look for in the response from the server

Constructor Summary

Constructors

Modifier	Constructor and Description
	HttpPlugin() Constructor for HttpPlugin.
protected	HttpPlugin(String protocolName, boolean checkReturnCode, String queryString, String responseString) Constructor for HttpPlugin.
protected	HttpPlugin(String protocolName, boolean checkReturnCode, String queryString, String responseString, int[] defaultPorts) Constructor for HttpPlugin.

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	checkProtocol(Socket socket, ConnectionConfig config) checkProtocol
protected boolean	checkResponseBody(ConnectionConfig config, String response) Checks the response body as a substring or regular expression match according to the leading-tilde convention
protected List<ConnectionConfig>	getConnectionConfigList(Map<String,Object> qualifiers, InetAddress address) getConnectionConfigList

Methods inherited from class org.opennms.netmgt.capsd.AbstractTcpPlugin

checkConnection, closeSocket, createConnectionConfig, getKeyedInteger, getKeyedIntegerArray, getPluginName, getProtocolName, getSocketWrapper, isProtocolSupported, isProtocolSupported, populateConnectionConfig, preconnectCheck, saveConfig, saveKeyedInteger, setPluginName

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_NAME_PORT

protected static final String PROPERTY_NAME_PORT

Constant PROPERTY_NAME_PORT="port"

See Also:

Constant Field Values

PROPERTY_NAME_MAX_RET_CODE

protected static final String PROPERTY_NAME_MAX_RET_CODE

Constant PROPERTY_NAME_MAX_RET_CODE="max-ret-code"

See Also:

Constant Field Values

PROPERTY_NAME_RETURN_CODE

protected static final String PROPERTY_NAME_RETURN_CODE

Constant PROPERTY_NAME_RETURN_CODE="check-return-code"

See Also:

Constant Field Values

PROPERTY_NAME_URL

protected static final String PROPERTY_NAME_URL

Constant PROPERTY_NAME_URL="url"

See Also:

Constant Field Values

PROPERTY_NAME_RESPONSE_TEXT

protected static final String PROPERTY_NAME_RESPONSE_TEXT

Constant PROPERTY_NAME_RESPONSE_TEXT="response-text"

See Also:

Constant Field Values

CHECK_RETURN_CODE

public static final boolean CHECK_RETURN_CODE

Boolean indicating whether to check for a return code

See Also:

Constant Field Values

PROTOCOL_NAME

public static final String PROTOCOL_NAME

Constant PROTOCOL_NAME="HTTP"

See Also:

Constant Field Values

QUERY_STRING

public static final String QUERY_STRING

The query to send to the HTTP server

See Also:

Constant Field Values

DEFAULT_URL

public static final String DEFAULT_URL

The query to send to the HTTP server

See Also:

Constant Field Values

RESPONSE_STRING

public static final String RESPONSE_STRING

A string to look for in the response from the server

See Also:

Constant Field Values

Constructor Detail

HttpPlugin

public HttpPlugin()

Constructor for HttpPlugin.

HttpPlugin

protected HttpPlugin(String protocolName,
          boolean checkReturnCode,
          String queryString,
          String responseString)

Constructor for HttpPlugin.

Parameters:

protocolName - a String object.

checkReturnCode - a boolean.

queryString - a String object.

responseString - a String object.

HttpPlugin

protected HttpPlugin(String protocolName,
          boolean checkReturnCode,
          String queryString,
          String responseString,
          int[] defaultPorts)

Constructor for HttpPlugin.

Parameters:

protocolName - a String object.

checkReturnCode - a boolean.

queryString - a String object.

responseString - a String object.

defaultPorts - an array of int.

Method Detail

checkProtocol

protected boolean checkProtocol(Socket socket,
                    ConnectionConfig config)
                         throws IOException

checkProtocol

Specified by:

checkProtocol in class AbstractTcpPlugin

Parameters:

socket - a Socket object.

config - a ConnectionConfig object.

Returns:

a boolean.

Throws:

IOException

getConnectionConfigList

protected List<ConnectionConfig> getConnectionConfigList(Map<String,Object> qualifiers,
                                             InetAddress address)

getConnectionConfigList

Overrides:

getConnectionConfigList in class AbstractTcpPlugin

Parameters:

qualifiers - a Map object.

address - a InetAddress object.

Returns:

a List object.

checkResponseBody

protected boolean checkResponseBody(ConnectionConfig config,
                        String response)

Checks the response body as a substring or regular expression match according to the leading-tilde convention

Parameters:

config - ConnectionConfig object from which response-text property is extracted

response - Body of HTTP response to check

Returns:

Whether the response matches the response-text property