org.snmp4j.util.RetrievalEvent Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of snmp4j Show documentation
Show all versions of snmp4j Show documentation
A distribution of snmp4j, see snmp4j site for updates
The newest version!
/*_############################################################################
_##
_## SNMP4J - RetrievalEvent.java
_##
_## Copyright (C) 2003-2009 Frank Fock and Jochen Katz (SNMP4J.org)
_##
_## Licensed under the Apache License, Version 2.0 (the "License");
_## you may not use this file except in compliance with the License.
_## You may obtain a copy of the License at
_##
_## http://www.apache.org/licenses/LICENSE-2.0
_##
_## Unless required by applicable law or agreed to in writing, software
_## distributed under the License is distributed on an "AS IS" BASIS,
_## WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
_## See the License for the specific language governing permissions and
_## limitations under the License.
_##
_##########################################################################*/
package org.snmp4j.util;
import java.util.EventObject;
import org.snmp4j.PDU;
import org.snmp4j.smi.VariableBinding;
import java.util.Arrays;
/**
* The RetrievalEvent is an abstract class representing the result
* of one or more GET/GETNEXT/GETBULK requests.
*
* @author Frank Fock
* @version 1.8
* @since 1.8
*/
public abstract class RetrievalEvent extends EventObject {
/**
* Retrieval operation was successfull.
*/
public static final int STATUS_OK = 0;
/**
* A request to the agent timed out.
*/
public static final int STATUS_TIMEOUT = -1;
/**
* The agent failed to return the objects in lexicographic order.
*/
public static final int STATUS_WRONG_ORDER = -2;
/**
* A report has been received from the agent.
* @see #getReportPDU()
*/
public static final int STATUS_REPORT = -3;
/**
* An exception occured during retrieval operation.
* @see #getException()
*/
public static final int STATUS_EXCEPTION = -4;
protected VariableBinding[] vbs;
protected int status = STATUS_OK;
protected Object userObject;
protected Exception exception;
protected PDU reportPDU;
protected RetrievalEvent(Object source, Object userObject) {
super(source);
this.userObject = userObject;
}
/**
* Creates a retrieval event with a status.
* @param source
* the source of the event.
* @param userObject
* the user object or null.
* @param status
* one of the status constants defined for this object.
*/
public RetrievalEvent(Object source, Object userObject, int status) {
this(source, userObject);
this.status = status;
}
/**
* Creates a retrieval event with an exception.
* @param source
* the source of the event.
* @param userObject
* the user object or null.
* @param exception
* an exception instance.
*/
public RetrievalEvent(Object source, Object userObject, Exception exception) {
this(source, userObject);
this.exception = exception;
this.status = STATUS_EXCEPTION;
}
/**
* Creates a retrieval event with a report PDU.
* @param source
* the source of the event.
* @param userObject
* the user object or null.
* @param report
* a PDU of type {@link PDU#REPORT}.
*/
public RetrievalEvent(Object source, Object userObject, PDU report) {
this(source, userObject);
this.reportPDU = report;
this.status = STATUS_REPORT;
}
/**
* Creates a retrieval event with row data.
*
* @param source
* the source of the event.
* @param userObject
* the user object or null.
* @param variableBindings
* an array of VariableBinding instances.
*/
public RetrievalEvent(Object source, Object userObject,
VariableBinding[] variableBindings) {
this(source, userObject);
this.vbs = variableBindings;
}
/**
* Gets the status of the table operation.
* @return
* one of the status constants defined for this object.
* {@link #STATUS_OK} indicates success, all other values indicate
* failure of the operation.
*/
public int getStatus() {
return status;
}
/**
* Indicates whether the event reports an error or not.
* @return
* true if the operation failed with an error.
*/
public boolean isError() {
return (status != STATUS_OK);
}
/**
* Gets the user object that has been specified by the user when the retrieval
* operation that fired this event has been requested.
* @return
* an object instance if an user object has been specified or
* null otherwise.
*/
public Object getUserObject() {
return userObject;
}
/**
* Gets the exception associated with this event.
* @return
* an Exception instance if there has been an exception instance
* associated with this event ({@link #getStatus()} returns
* {@link #STATUS_EXCEPTION}), or null otherwise.
*/
public Exception getException() {
return exception;
}
/**
* Gets the report PDU associated with this event.
* @return
* a ScopedPDU instance if there has been a report PDU
* instance associated with this event ({@link #getStatus()} returns
* {@link #STATUS_REPORT}), or null otherwise.
*/
public PDU getReportPDU() {
return reportPDU;
}
/**
* Returns a textual error message for the error.
* @return
* an error message or an empty string if no error occurred.
*/
public String getErrorMessage() {
switch (status) {
case STATUS_EXCEPTION: {
return exception.getMessage();
}
case STATUS_REPORT: {
return "Report: "+reportPDU.get(0);
}
case STATUS_TIMEOUT: {
return "Request timed out.";
}
case STATUS_WRONG_ORDER: {
return "Agent did not return variable bindings in lexicographic order.";
}
default: {
return PDU.toErrorStatusText(status);
}
}
}
public String toString() {
return getClass().getName()+"[vbs="+
((vbs == null) ? "null" : ""+Arrays.asList(vbs))+
",status="+status+",exception="+
exception+",report="+reportPDU+"]";
}
}