org.opennms.netmgt.eventd.adaptors.tcp

Interface TcpEventReceiverMBean

All Superinterfaces:

BaseOnmsMBean

All Known Implementing Classes:

TcpEventReceiver

public interface TcpEventReceiverMBean
extends BaseOnmsMBean

TcpEventReceiverMBean interface.

Version:

$Id: $

Author:

ranger

Method Summary

Modifier and Type	Method and Description
void	addEventHandler(String name) Adds a new event handler by its managed name.
void	destroy() Invoked prior to garbage collection.
Integer	getPort() Returns the where a listener is waiting to process new request.
void	removeEventHandler(String name) Removes an event handler.
void	setEventsPerConnection(Integer number) The number of event records a new connection is allowed to send before the connection is terminated by the server.
void	setLogPrefix(String prefix) The logging prefix to use
void	setPort(Integer port) Sets the port where new requests will be handled.

Methods inherited from interface org.opennms.netmgt.daemon.BaseOnmsMBean

getStatus, getStatusText, init, start, status, stop

Method Detail

destroy

void destroy()

Invoked prior to garbage collection.

setPort

void setPort(Integer port)

Sets the port where new requests will be handled. This can only be done prior to starting the managed bean. If the managed bean is already running then an exception is thrown.

Parameters:

port - The port to listen on.

getPort

Integer getPort()

Returns the where a listener is waiting to process new request.

Returns:

The listening port.

addEventHandler

void addEventHandler(String name)
              throws MalformedObjectNameException,
                     InstanceNotFoundException

Adds a new event handler by its managed name.

Parameters:

name - The name of the handler to add.

Throws:

MalformedObjectNameException - Thrown if the passed name is not a valid ObjectName.

InstanceNotFoundException - Thrown if no managed bean can be found that matches the name.

removeEventHandler

void removeEventHandler(String name)
                 throws MalformedObjectNameException,
                        InstanceNotFoundException

Removes an event handler. The passed name must be a valid JMX object name.

Parameters:

name - The name of the handler to remove.

Throws:

MalformedObjectNameException - Thrown if the passed name is not a valid ObjectName.

InstanceNotFoundException - Thrown if no managed bean can be found that matches the name.

setLogPrefix

void setLogPrefix(String prefix)

The logging prefix to use

Parameters:

prefix - a String object.

setEventsPerConnection

void setEventsPerConnection(Integer number)

The number of event records a new connection is allowed to send before the connection is terminated by the server. The connection is always terminated after an event receipt is generated, if one is required.

Parameters:

number - The number of event records.