Package org.opennms.netmgt.provision

Interface ServiceDetector

All Known Subinterfaces:

AsyncServiceDetector, SyncServiceDetector

All Known Implementing Classes:

AbstractDetector, AbstractJdbcDetector, ActiveMQDetector, AgentBasedSyncAbstractDetector, AsyncAbstractDetector, AsyncBasicDetector, AsyncBasicDetectorMinaImpl, AsyncBasicDetectorNettyImpl, AsyncLineOrientedDetectorMinaImpl, AsyncLineOrientedDetectorNettyImpl, AsyncMultilineDetectorMinaImpl, AsyncMultilineDetectorNettyImpl, BasicDetector, BgpSessionDetector, BSFDetector, CiscoIpSlaDetector, CitrixDetector, DhcpDetector, DiskUsageDetector, DnsDetector, DominoIIOPDetector, FtpDetector, GpDetector, HostResourceSWRunDetector, HttpDetector, HttpsDetector, IcmpDetector, ImapDetector, ImapsDetector, JdbcDetector, JdbcQueryDetector, JdbcStoredProcedureDetector, JMXDetector, Jsr160Detector, LdapDetector, LdapsDetector, LineOrientedDetector, LoopDetector, MemcachedDetector, MSExchangeDetector, MultilineHttpDetector, MultilineOrientedDetector, NotesHttpDetector, NrpeDetector, NsclientDetector, NtpDetector, OmsaStorageDetector, OpenManageChassisDetector, PercDetector, Pop3Detector, RadiusAuthDetector, ReverseDNSLookupDetector, ServiceDetectorImpl, SmbDetector, SmtpDetector, SnmpDetector, SshDetector, SyncAbstractDetector, TcpDetector, TrivialTimeDetector, WebDetector, Win32ServiceDetector, WmiDetector, WsManDetector, WsManWQLDetector, XmpDetector

public interface ServiceDetector

ServiceDetector Note: the isServiceDetected method is not defined here because there is a synchronous version of the method and an asynchronous one that are defined in sub interfaces. This interface is used for the configuration so all service detectors can be found since the would all be initialized and configured the same way.

Version:

$Id: $

Author:

Method Summary

Modifier and Type	Method	Description
void	dispose()	The detector should clean up after itself in this method if necessary.
java.lang.String	getIpMatch()	Get the IPLIKE rule for detecting the service.
int	getPort()	Get the port where this service will be detected.
java.lang.String	getServiceName()	Requires that all implementations of this API return a service name.
int	getTimeout()	Get the timeout for detecting the service.
void	init()	Perform any necessary initialization after construction and before detecting.
void	setIpMatch(java.lang.String ipMatch)	Set the IPLIKE rule for detecting the service.
void	setPort(int port)	Set the port where the service will be detected.
void	setServiceName(java.lang.String serviceName)	Service name is mutable so that we can create new instances of each implementation and define a new service detector using the underlying protocol.
void	setTimeout(int timeout)	Set the timeout for detecting the service.

Method Detail

init

void init()

Perform any necessary initialization after construction and before detecting.

getServiceName

java.lang.String getServiceName()

Requires that all implementations of this API return a service name.

Returns:

a String object.

setServiceName

void setServiceName(java.lang.String serviceName)

Service name is mutable so that we can create new instances of each implementation and define a new service detector using the underlying protocol.

Parameters:

serviceName - a String object.

getPort

int getPort()

Get the port where this service will be detected.

setPort

void setPort(int port)

Set the port where the service will be detected.

Parameters:

port -

getTimeout

int getTimeout()

Get the timeout for detecting the service.

setTimeout

void setTimeout(int timeout)

Set the timeout for detecting the service.

Parameters:

port -

getIpMatch

java.lang.String getIpMatch()

Get the IPLIKE rule for detecting the service.

setIpMatch

void setIpMatch(java.lang.String ipMatch)

Set the IPLIKE rule for detecting the service.

dispose

void dispose()

The detector should clean up after itself in this method if necessary.