org.opennms.netmgt.xml.eventconf

Class Maskelement

java.lang.Object

org.opennms.netmgt.xml.eventconf.Maskelement

All Implemented Interfaces:

Serializable

public class Maskelement
extends Object
implements Serializable

The mask element

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	TAG_HOST The event host xml tag
static String	TAG_INTERFACE The event interface xml tag
static String	TAG_NODEID The event nodeid xml tag
static String	TAG_SERVICE The event service xml tag
static String	TAG_SNMP_COMMUNITY The SNMP community xml tag
static String	TAG_SNMP_EID The SNMP EID xml tag
static String	TAG_SNMP_GENERIC The SNMP generic xml tag
static String	TAG_SNMP_SPECIFIC The SNMP specific xml tag
static String	TAG_SNMPHOST The event snmp host xml tag
static String	TAG_SOURCE The event source xml tag
static String	TAG_UEI The UEI xml tag

Constructor Summary

Constructors

Constructor and Description
Maskelement()

Method Summary

Methods

Modifier and Type	Method and Description
void	addMevalue(int index, String value)
void	addMevalue(String value)
EventMatcher	constructMatcher()
Enumeration<String>	enumerateMevalue()
boolean	equals(Object obj)
String	getMename() The mask element name.
String[]	getMevalue()
String	getMevalue(int index) The mask element value.
List<String>	getMevalueCollection()
int	getMevalueCount()
int	hashCode()
boolean	isValid()
Iterator<String>	iterateMevalue()
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	removeAllMevalue()
boolean	removeMevalue(String value)
String	removeMevalueAt(int index)
void	setMename(String mename)
void	setMevalue(int index, String value)
void	setMevalue(List<String> values)
void	setMevalue(String[] values)
void	setMevalueCollection(List<String> values)
static Maskelement	unmarshal(Reader reader)
void	validate()

Methods inherited from class java.lang.Object

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

Field Detail

TAG_UEI

public static final String TAG_UEI

The UEI xml tag

See Also:

Constant Field Values

TAG_SOURCE

public static final String TAG_SOURCE

The event source xml tag

See Also:

Constant Field Values

TAG_NODEID

public static final String TAG_NODEID

The event nodeid xml tag

See Also:

Constant Field Values

TAG_HOST

public static final String TAG_HOST

The event host xml tag

See Also:

Constant Field Values

TAG_INTERFACE

public static final String TAG_INTERFACE

The event interface xml tag

See Also:

Constant Field Values

TAG_SNMPHOST

public static final String TAG_SNMPHOST

The event snmp host xml tag

See Also:

Constant Field Values

TAG_SERVICE

public static final String TAG_SERVICE

The event service xml tag

See Also:

Constant Field Values

TAG_SNMP_EID

public static final String TAG_SNMP_EID

The SNMP EID xml tag

See Also:

Constant Field Values

TAG_SNMP_SPECIFIC

public static final String TAG_SNMP_SPECIFIC

The SNMP specific xml tag

See Also:

Constant Field Values

TAG_SNMP_GENERIC

public static final String TAG_SNMP_GENERIC

The SNMP generic xml tag

See Also:

Constant Field Values

TAG_SNMP_COMMUNITY

public static final String TAG_SNMP_COMMUNITY

The SNMP community xml tag

See Also:

Constant Field Values

Constructor Detail

Maskelement

public Maskelement()

Method Detail

addMevalue

public void addMevalue(String value)
                throws IndexOutOfBoundsException

Throws:

IndexOutOfBoundsException

addMevalue

public void addMevalue(int index,
              String value)
                throws IndexOutOfBoundsException

Throws:

IndexOutOfBoundsException

enumerateMevalue

public Enumeration<String> enumerateMevalue()

getMename

public String getMename()

The mask element name. Must be from the following subset:

uei

the OpenNMS Universal Event Identifier

source

source of the event; "trapd" for received SNMP traps; warning: these aren't standardized

host

host related to the event; for SNMP traps this is the IP source address of the host that sent the trap to OpenNMS

snmphost

SNMP host related to the event; for SNMPv1 traps this is IP address reported in the trap; for SNMPv2 traps and later this is the same as "host"

nodeid

the OpenNMS node identifier for the node related to this event

interface

interface related to the event; for SNMP traps this is the same as "snmphost"

service

Service name

id

enterprise ID in an SNMP trap

specific

specific value in an SNMP trap

generic

generic value in an SNMP trap

community

community string in an SNMP trap

getMevalue

public String getMevalue(int index)
                  throws IndexOutOfBoundsException

The mask element value. A case-sensitive, exact match is performed. If the mask value has a "%" as the last character, it will match zero or more characters at the end of the string being matched.

Throws:

IndexOutOfBoundsException

getMevalue

public String[] getMevalue()

getMevalueCollection

public List<String> getMevalueCollection()

getMevalueCount

public int getMevalueCount()

isValid

public boolean isValid()

Returns:

true if this object is valid according to the schema

iterateMevalue

public Iterator<String> iterateMevalue()

marshal

public void marshal(Writer out)
             throws org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Throws:

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

marshal

public void marshal(ContentHandler handler)
             throws IOException,
                    org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Throws:

IOException

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

removeAllMevalue

public void removeAllMevalue()

removeMevalue

public boolean removeMevalue(String value)

removeMevalueAt

public String removeMevalueAt(int index)

setMename

public void setMename(String mename)

setMevalue

public void setMevalue(int index,
              String value)
                throws IndexOutOfBoundsException

Throws:

IndexOutOfBoundsException

setMevalue

public void setMevalue(String[] values)

setMevalue

public void setMevalue(List<String> values)

setMevalueCollection

public void setMevalueCollection(List<String> values)

unmarshal

public static Maskelement unmarshal(Reader reader)
                             throws org.exolab.castor.xml.MarshalException,
                                    org.exolab.castor.xml.ValidationException

Throws:

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

validate

public void validate()
              throws org.exolab.castor.xml.ValidationException

Throws:

org.exolab.castor.xml.ValidationException

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

constructMatcher

public EventMatcher constructMatcher()