Package org.opennms.netmgt.eventd.processor.expandable

Class EventTemplate

java.lang.Object

org.opennms.netmgt.eventd.processor.expandable.EventTemplate

All Implemented Interfaces:

ExpandableToken

public class EventTemplate
extends java.lang.Object
implements ExpandableToken

The EventTemplate represents the event input, containing place-holders, e.g. 'nodeLabel', and support to expand the template. For each placeholder in the input a ExpandableToken is created. The expandable state of the EventTemplate is the expanded state of all tokens (tokens.

Constructor Summary

Constructors

Constructor	Description
EventTemplate(java.lang.String input, EventUtil eventUtil)

Method Summary

Modifier and Type	Method	Description
java.lang.String	expand(Event event, java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> decode)	Expands a token.
boolean	requiresTransaction()	Defines if this ExpandableToken requires a transaction to be expanded.

Methods inherited from class java.lang.Object

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

Constructor Detail

EventTemplate

public EventTemplate(java.lang.String input,
                     EventUtil eventUtil)

Method Detail

expand

public java.lang.String expand(Event event,
                               java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> decode)

Description copied from interface: ExpandableToken

Expands a token.

Specified by:

expand in interface ExpandableToken

Parameters:

event - An event, to expand the token from. May not be null.

decode - A Map, to help expanding the token. May be null.

Returns:

The expanded token.

requiresTransaction

public boolean requiresTransaction()

Description copied from interface: ExpandableToken

Defines if this ExpandableToken requires a transaction to be expanded.

Specified by:

requiresTransaction in interface ExpandableToken

Returns:

True if a transaction is required, False otherwise.