org.opennms.netmgt.eventd.processor.expandable

Interface ExpandableToken

All Known Implementing Classes:

EventTemplate, ExpandableConstant, ExpandableParameter

public interface ExpandableToken

A token, which may or may not expandable.

Method Summary

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

Method Detail

expand

String expand(Event event,
              Map<String,Map<String,String>> decode)

Expands a token.

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

boolean requiresTransaction()

Defines if this ExpandableToken requires a transaction to be expanded.

Returns:

True if a transaction is required, False otherwise.