org.snmp4j.util
Class RetrievalEvent

java.lang.Object
  extended by java.util.EventObject
      extended by org.snmp4j.util.RetrievalEvent
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
TableEvent, TreeEvent

public abstract class RetrievalEvent
extends java.util.EventObject

The RetrievalEvent is an abstract class representing the result of one or more GET/GETNEXT/GETBULK requests.

Since:
1.8
Version:
1.8
Author:
Frank Fock
See Also:
Serialized Form

Field Summary
protected  java.lang.Exception exception
           
protected  PDU reportPDU
           
protected  int status
           
static int STATUS_EXCEPTION
          An exception occured during retrieval operation.
static int STATUS_OK
          Retrieval operation was successfull.
static int STATUS_REPORT
          A report has been received from the agent.
static int STATUS_TIMEOUT
          A request to the agent timed out.
static int STATUS_WRONG_ORDER
          The agent failed to return the objects in lexicographic order.
protected  java.lang.Object userObject
           
protected  VariableBinding[] vbs
           
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
protected RetrievalEvent(java.lang.Object source, java.lang.Object userObject)
           
  RetrievalEvent(java.lang.Object source, java.lang.Object userObject, java.lang.Exception exception)
          Creates a retrieval event with an exception.
  RetrievalEvent(java.lang.Object source, java.lang.Object userObject, int status)
          Creates a retrieval event with a status.
  RetrievalEvent(java.lang.Object source, java.lang.Object userObject, PDU report)
          Creates a retrieval event with a report PDU.
  RetrievalEvent(java.lang.Object source, java.lang.Object userObject, VariableBinding[] variableBindings)
          Creates a retrieval event with row data.
 
Method Summary
 java.lang.String getErrorMessage()
          Returns a textual error message for the error.
 java.lang.Exception getException()
          Gets the exception associated with this event.
 PDU getReportPDU()
          Gets the report PDU associated with this event.
 int getStatus()
          Gets the status of the table operation.
 java.lang.Object getUserObject()
          Gets the user object that has been specified by the user when the retrieval operation that fired this event has been requested.
 boolean isError()
          Indicates whether the event reports an error or not.
 java.lang.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 Detail

STATUS_OK

public static final int STATUS_OK
Retrieval operation was successfull.

See Also:
Constant Field Values

STATUS_TIMEOUT

public static final int STATUS_TIMEOUT
A request to the agent timed out.

See Also:
Constant Field Values

STATUS_WRONG_ORDER

public static final int STATUS_WRONG_ORDER
The agent failed to return the objects in lexicographic order.

See Also:
Constant Field Values

STATUS_REPORT

public static final int STATUS_REPORT
A report has been received from the agent.

See Also:
getReportPDU(), Constant Field Values

STATUS_EXCEPTION

public static final int STATUS_EXCEPTION
An exception occured during retrieval operation.

See Also:
getException(), Constant Field Values

vbs

protected VariableBinding[] vbs

status

protected int status

userObject

protected java.lang.Object userObject

exception

protected java.lang.Exception exception

reportPDU

protected PDU reportPDU
Constructor Detail

RetrievalEvent

protected RetrievalEvent(java.lang.Object source,
                         java.lang.Object userObject)

RetrievalEvent

public RetrievalEvent(java.lang.Object source,
                      java.lang.Object userObject,
                      int status)
Creates a retrieval event with a status.

Parameters:
source - the source of the event.
userObject - the user object or null.
status - one of the status constants defined for this object.

RetrievalEvent

public RetrievalEvent(java.lang.Object source,
                      java.lang.Object userObject,
                      java.lang.Exception exception)
Creates a retrieval event with an exception.

Parameters:
source - the source of the event.
userObject - the user object or null.
exception - an exception instance.

RetrievalEvent

public RetrievalEvent(java.lang.Object source,
                      java.lang.Object userObject,
                      PDU report)
Creates a retrieval event with a report PDU.

Parameters:
source - the source of the event.
userObject - the user object or null.
report - a PDU of type PDU.REPORT.

RetrievalEvent

public RetrievalEvent(java.lang.Object source,
                      java.lang.Object userObject,
                      VariableBinding[] variableBindings)
Creates a retrieval event with row data.

Parameters:
source - the source of the event.
userObject - the user object or null.
variableBindings - an array of VariableBinding instances.
Method Detail

getStatus

public int getStatus()
Gets the status of the table operation.

Returns:
one of the status constants defined for this object. STATUS_OK indicates success, all other values indicate failure of the operation.

isError

public boolean isError()
Indicates whether the event reports an error or not.

Returns:
true if the operation failed with an error.

getUserObject

public java.lang.Object getUserObject()
Gets the user object that has been specified by the user when the retrieval operation that fired this event has been requested.

Returns:
an object instance if an user object has been specified or null otherwise.

getException

public java.lang.Exception getException()
Gets the exception associated with this event.

Returns:
an Exception instance if there has been an exception instance associated with this event (getStatus() returns STATUS_EXCEPTION), or null otherwise.

getReportPDU

public PDU getReportPDU()
Gets the report PDU associated with this event.

Returns:
a ScopedPDU instance if there has been a report PDU instance associated with this event (getStatus() returns STATUS_REPORT), or null otherwise.

getErrorMessage

public java.lang.String getErrorMessage()
Returns a textual error message for the error.

Returns:
an error message or an empty string if no error occurred.

toString

public java.lang.String toString()
Overrides:
toString in class java.util.EventObject

Copyright 2005-2010 Frank Fock (SNMP4J.org)

Copyright © 2011 SNMP4J.org. All Rights Reserved.