org.opennms.netmgt.events.api

Interface EventSubscriptionService

All Known Subinterfaces:

EventIpcManager

All Known Implementing Classes:

EventIpcManagerDefaultImpl, MockEventIpcManager

public interface EventSubscriptionService

EventSubscriptionService interface.

Version:

$Id: $

Author:

ranger

Method Summary

Modifier and Type	Method and Description
void	addEventListener(EventListener listener) Registers an event listener that is interested in all events
void	addEventListener(EventListener listener, Collection<String> ueis) Registers an event listener interested in the UEIs in the passed list
void	addEventListener(EventListener listener, String uei) Registers an event listener interested in the passed UEI
boolean	hasEventListener(String uei) Checks if there is at least one listener for the given uei.
void	removeEventListener(EventListener listener) Removes a registered event listener
void	removeEventListener(EventListener listener, Collection<String> ueis) Removes a registered event listener - the UEI list indicates the list of events the listener is no more interested in
void	removeEventListener(EventListener listener, String uei) Removes a registered event listener - the UEI indicates an event the listener is no more interested in

Method Detail

addEventListener

void addEventListener(EventListener listener)

Registers an event listener that is interested in all events

Parameters:

listener - a EventListener object.

addEventListener

void addEventListener(EventListener listener,
                      Collection<String> ueis)

Registers an event listener interested in the UEIs in the passed list

Parameters:

listener - a EventListener object.

ueis - a Collection object.

addEventListener

void addEventListener(EventListener listener,
                      String uei)

Registers an event listener interested in the passed UEI

Parameters:

listener - a EventListener object.

uei - a String object.

removeEventListener

void removeEventListener(EventListener listener)

Removes a registered event listener

Parameters:

listener - a EventListener object.

removeEventListener

void removeEventListener(EventListener listener,
                         Collection<String> ueis)

Removes a registered event listener - the UEI list indicates the list of events the listener is no more interested in

Parameters:

listener - a EventListener object.

ueis - a Collection object.

removeEventListener

void removeEventListener(EventListener listener,
                         String uei)

Removes a registered event listener - the UEI indicates an event the listener is no more interested in

Parameters:

listener - a EventListener object.

uei - a String object.

hasEventListener

boolean hasEventListener(String uei)

Checks if there is at least one listener for the given uei.

Parameters:

uei - the uie to check for

Returns:

true iff there is at least one listener