Package org.snmp4j.agent.agentx.master

Class AgentXMasterEvent

java.lang.Object

java.util.EventObject

org.snmp4j.agent.agentx.master.AgentXMasterEvent

All Implemented Interfaces:

Serializable

public class AgentXMasterEvent
extends EventObject

The AgentXMasterEvent object describes an event that has been triggered on behalf of a sub-agent to master agent connection/session.

When the type of the event is vetoable (i.e. the event can be used to cancel an action), its type has to be an integer value less than zero. If the type is greater than zero, the event is fired for information only and changing the veto reason has no effect.

Version:

1.0

Author:

Frank Fock

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final int	PEER_ADDED	AgentXMasterEvent type "peer added".
static final int	PEER_REMOVED	AgentXMasterEvent type "peer removed".
static final int	REGISTRATION_ADDED	AgentXMasterEvent type "registration added".
static final int	REGISTRATION_REMOVED	AgentXMasterEvent type "registration removed".
static final int	REGISTRATION_TO_ADD	AgentXMasterEvent type "registration to be added".
static final int	SESSION_ADDED	AgentXMasterEvent type "session added".
static final int	SESSION_REMOVED	AgentXMasterEvent type "session removed".
static final int	SESSION_TO_ADD	AgentXMasterEvent type "session added".

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor	Description
AgentXMasterEvent(Object source, int type, Object changedObject)	Creates an new master agent event.

Method Summary

Modifier and Type	Method	Description
Object	getChangedObject()	Returns the changed object (or the object to be changed).
int	getType()	Returns the event type.
int	getVetoReason()	Returns the veto reason.
void	setVetoReason(int vetoReason)	Sets the AgentX reason (see AgentXProtocol) other than AgentXProtocol.AGENTX_SUCCESS why the action caused this event should be rejected and undone.
String	toString()

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

Field Details

SESSION_TO_ADD

public static final int SESSION_TO_ADD

AgentXMasterEvent type "session added".

See Also:

• Constant Field Values

REGISTRATION_TO_ADD

public static final int REGISTRATION_TO_ADD

AgentXMasterEvent type "registration to be added".

See Also:

• Constant Field Values

PEER_ADDED

public static final int PEER_ADDED

AgentXMasterEvent type "peer added".

See Also:

• Constant Field Values

PEER_REMOVED

public static final int PEER_REMOVED

AgentXMasterEvent type "peer removed".

See Also:

• Constant Field Values

SESSION_ADDED

public static final int SESSION_ADDED

AgentXMasterEvent type "session added".

See Also:

• Constant Field Values

SESSION_REMOVED

public static final int SESSION_REMOVED

AgentXMasterEvent type "session removed".

See Also:

• Constant Field Values

REGISTRATION_ADDED

public static final int REGISTRATION_ADDED

AgentXMasterEvent type "registration added".

See Also:

• Constant Field Values

REGISTRATION_REMOVED

public static final int REGISTRATION_REMOVED

AgentXMasterEvent type "registration removed".

See Also:

• Constant Field Values

Constructor Details

AgentXMasterEvent

public AgentXMasterEvent(Object source,
 int type,
 Object changedObject)

Creates an new master agent event.

Parameters:

source - the command processor that fired the event.

type - the event type (less than zero if veto-able, greater than zero if not).

changedObject - an optional reference to the changed object, which might be an AgentXPeer, AgentXSession, or AgentXRegistration instance for example.

Method Details

getType

public int getType()

Returns the event type.

Returns:

if less than zero, this event can be canceled by setting an appropriate veto reason. If greater than zero, this event is for information only.

getChangedObject

public Object getChangedObject()

Returns the changed object (or the object to be changed).

Returns:

an AgentXPeer, AgentXSession, or AgentXRegistration instance for example.

getVetoReason

public int getVetoReason()

Returns the veto reason. A value other than zero (=AgentXProtocol.AGENTX_SUCCESS) indicates that a vetoable event should be canceled.

Returns:

an AgentX REASON code as defined by AgentXProtocol.

toString

public String toString()

Overrides:

toString in class EventObject

setVetoReason

public void setVetoReason(int vetoReason)

Sets the AgentX reason (see AgentXProtocol) other than AgentXProtocol.AGENTX_SUCCESS why the action caused this event should be rejected and undone.

Parameters:

vetoReason - an AgentX reason code.