Module org.snmp4j.agent

Package org.snmp4j.agent.mo

Class MOChangeEvent

java.lang.Object

java.util.EventObject

org.snmp4j.agent.mo.DeniableEventObject

org.snmp4j.agent.mo.MOChangeEvent

All Implemented Interfaces:

Serializable

public class MOChangeEvent
extends DeniableEventObject

The MOChangeEvent describes the change of a single value of a ManagedObject.

Version:

3.2.3

Author:

Frank Fock

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MOChangeEvent.Modification
static class	MOChangeEvent.OidType

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor	Description
MOChangeEvent(Object source, ManagedObject<SubRequest<?>> changedObject, org.snmp4j.smi.OID index, MOChangeEvent.Modification modification)	Creates a deniable MOChangeEvent object based on the changed managed object instances that are identified through a common the instance OID (i.e.
MOChangeEvent(Object source, ManagedObject<SubRequest<?>> changedObject, org.snmp4j.smi.OID index, MOChangeEvent.Modification modification, SubRequest<?> subRequest)	Creates a deniable MOChangeEvent object based on the changed managed object instances that are identified through a common the instance OID (i.e.
MOChangeEvent(Object source, ManagedObject<SubRequest<?>> changedObject, org.snmp4j.smi.OID oid, org.snmp4j.smi.Variable oldValue, org.snmp4j.smi.Variable newValue)	Creates a deniable MOChangeEvent object based on the changed managed object, the instance OID of the changed value, with old and new value.
MOChangeEvent(Object source, ManagedObject<SubRequest<?>> changedObject, org.snmp4j.smi.OID oid, org.snmp4j.smi.Variable oldValue, org.snmp4j.smi.Variable newValue, boolean deniable)	Creates a MOChangeEvent object based on the changed managed object, the instance OID of the changed value, with old and new value.
MOChangeEvent(Object source, ManagedObject<SubRequest<?>> changedObject, org.snmp4j.smi.OID oid, org.snmp4j.smi.Variable oldValue, org.snmp4j.smi.Variable newValue, boolean deniable, SubRequest<?> subRequest)	Creates a MOChangeEvent object based on the changed managed object, the instance OID of the changed value, with old and new value.

Method Summary

Modifier and Type	Method	Description
ManagedObject<SubRequest<?>>	getChangedObject()
MOChangeEvent.Modification	getModification()	Gets the type of the modification.
protected MOChangeEvent.Modification	getModificationFromValues(org.snmp4j.smi.Variable oldValue, org.snmp4j.smi.Variable newValue)
org.snmp4j.smi.Variable	getNewValue()
org.snmp4j.smi.OID	getOID()
MOChangeEvent.OidType	getOidType()	Gets the representation type of the OID of the event as defined by MOChangeEvent.OidType.
org.snmp4j.smi.Variable	getOldValue()
SubRequest<?>	getSubRequest()	Get the SubRequest that triggered this change.
String	toString()

Methods inherited from class org.snmp4j.agent.mo.DeniableEventObject

getDenyReason, isDeniable, setDenyReason

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

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

Constructor Detail

MOChangeEvent

public MOChangeEvent(Object source,
                     ManagedObject<SubRequest<?>> changedObject,
                     org.snmp4j.smi.OID oid,
                     org.snmp4j.smi.Variable oldValue,
                     org.snmp4j.smi.Variable newValue)

Creates a deniable MOChangeEvent object based on the changed managed object, the instance OID of the changed value, with old and new value.

Parameters:

source - the event source.

changedObject - the ManagedObject whose value is changed.

oid - the instance OID of the changed instance.

oldValue - the old value.

newValue - the new value.

MOChangeEvent

public MOChangeEvent(Object source,
                     ManagedObject<SubRequest<?>> changedObject,
                     org.snmp4j.smi.OID index,
                     MOChangeEvent.Modification modification)

Creates a deniable MOChangeEvent object based on the changed managed object instances that are identified through a common the instance OID (i.e. their row index) and with a list of old and new values.

Parameters:

source - the event source.

changedObject - the ManagedObject whose value is changed.

index - the instance OID of the changed instance (i.e. row index).

modification - identifies the type of modification that triggered the event.

Since:

3.0

MOChangeEvent

public MOChangeEvent(Object source,
                     ManagedObject<SubRequest<?>> changedObject,
                     org.snmp4j.smi.OID index,
                     MOChangeEvent.Modification modification,
                     SubRequest<?> subRequest)

Creates a deniable MOChangeEvent object based on the changed managed object instances that are identified through a common the instance OID (i.e. their row index) and with a list of old and new values.

Parameters:

source - the event source.

changedObject - the ManagedObject whose value is changed.

index - the instance OID of the changed instance (i.e. row index).

modification - identifies the type of modification that triggered the event.

subRequest - the subRequest that triggered the change. This might by null if the change was not triggered by a SNMP, AgentX, or similar external request or if the request cannot be identified through the call hierarchy.

Since:

3.2.3

MOChangeEvent

public MOChangeEvent(Object source,
                     ManagedObject<SubRequest<?>> changedObject,
                     org.snmp4j.smi.OID oid,
                     org.snmp4j.smi.Variable oldValue,
                     org.snmp4j.smi.Variable newValue,
                     boolean deniable)

Creates a MOChangeEvent object based on the changed managed object, the instance OID of the changed value, with old and new value.

Parameters:

source - the event source.

changedObject - the ManagedObject whose value is changed.

oid - the instance OID of the changed instance.

oldValue - the old value.

newValue - the new value.

deniable - indicates whether the event can be canceled through setting its denyReason member to a SNMP error status.

Since:

1.1

MOChangeEvent

public MOChangeEvent(Object source,
                     ManagedObject<SubRequest<?>> changedObject,
                     org.snmp4j.smi.OID oid,
                     org.snmp4j.smi.Variable oldValue,
                     org.snmp4j.smi.Variable newValue,
                     boolean deniable,
                     SubRequest<?> subRequest)

Creates a MOChangeEvent object based on the changed managed object, the instance OID of the changed value, with old and new value.

Parameters:

source - the event source.

changedObject - the ManagedObject whose value is changed.

oid - the instance OID of the changed instance.

oldValue - the old value.

newValue - the new value.

deniable - indicates whether the event can be canceled through setting its denyReason member to a SNMP error status.

subRequest - the subRequest that triggered the change. This might by null if the change was not triggered by a SNMP, AgentX, or similar external request.

Since:

3.2.3

Method Detail

getModificationFromValues

protected MOChangeEvent.Modification getModificationFromValues(org.snmp4j.smi.Variable oldValue,
                                                               org.snmp4j.smi.Variable newValue)

getChangedObject

public ManagedObject<SubRequest<?>> getChangedObject()

getOID

public org.snmp4j.smi.OID getOID()

getOldValue

public org.snmp4j.smi.Variable getOldValue()

getNewValue

public org.snmp4j.smi.Variable getNewValue()

getModification

public MOChangeEvent.Modification getModification()

Gets the type of the modification. This could be implicitly determined by getModificationFromValues(Variable, Variable) object construction or explicitly set by a suitable constructor.

Returns:

a modification type as defined by MOChangeEvent.Modification.

Since:

3.0

getOidType

public MOChangeEvent.OidType getOidType()

Gets the representation type of the OID of the event as defined by MOChangeEvent.OidType. The type MOChangeEvent.OidType.index refers to the row index of a MOTable ManagedObject. All other types refer to a single instance OID, whereas MOChangeEvent.OidType.fullyQualified includes the OID of the ManagedObject and MOChangeEvent.OidType.instanceSuffix does not.

Returns:

the type of the OID returned by getOID().

Since:

3.0

getSubRequest

public SubRequest<?> getSubRequest()

Get the SubRequest that triggered this change. If null there is either no SNMP or AgentX request that triggered this change or the request cannot be identified.

Returns:

the SubRequest that triggered this change or null if that is not known.

Since:

3.2.3

toString

public String toString()

Overrides:

toString in class EventObject