org.opennms.netmgt.utils

Class TcpEventProxy

java.lang.Object

org.opennms.netmgt.utils.TcpEventProxy

All Implemented Interfaces:

EventProxy

public final class TcpEventProxy
extends Object
implements EventProxy

This is the interface used to send events into the event subsystem - It is typically used by the poller framework plugins that perform service monitoring to send out appropriate events. Can also be used by capsd, discovery etc.

Author:

Sowmya Kumaraswamy , OpenNMS

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_PORT Constant DEFAULT_PORT=5817
static int	DEFAULT_TIMEOUT Constant DEFAULT_TIMEOUT=2000

Constructor Summary

Constructors

Constructor and Description
TcpEventProxy() Constructor for TcpEventProxy.
TcpEventProxy(InetSocketAddress address) Constructor for TcpEventProxy.
TcpEventProxy(InetSocketAddress address, int timeout) Constructor for TcpEventProxy.

Method Summary

Methods

Modifier and Type	Method and Description
void	send(Event event) This method is called to send the event out
void	send(Log eventLog) This method is called to send an event log containing multiple events out.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PORT

public static final int DEFAULT_PORT

Constant DEFAULT_PORT=5817

See Also:

Constant Field Values

DEFAULT_TIMEOUT

public static final int DEFAULT_TIMEOUT

Constant DEFAULT_TIMEOUT=2000

See Also:

Constant Field Values

Constructor Detail

TcpEventProxy

public TcpEventProxy()
              throws UnknownHostException

Constructor for TcpEventProxy.

Throws:

UnknownHostException - if any.

TcpEventProxy

public TcpEventProxy(InetSocketAddress address)

Constructor for TcpEventProxy.

Parameters:

address - a InetSocketAddress object.

TcpEventProxy

public TcpEventProxy(InetSocketAddress address,
             int timeout)

Constructor for TcpEventProxy.

Parameters:

address - a InetSocketAddress object.

timeout - a int.

Method Detail

send

public void send(Event event)
          throws EventProxyException

This method is called to send the event out This method is called to send the event out

Specified by:

send in interface EventProxy

Parameters:

event - the event to be sent out

Throws:

UndeclaredThrowableException - thrown if the send fails for any reason

EventProxyException - thrown if the send fails for any reason

send

public void send(Log eventLog)
          throws EventProxyException

This method is called to send an event log containing multiple events out.

Specified by:

send in interface EventProxy

Parameters:

eventLog - the events to be sent out

Throws:

UndeclaredThrowableException - thrown if the send fails for any reason

EventProxyException - if any.