/*
* SNMP Package
*
* Copyright (C) 2004, Jonathan Sevy <jsevy@mcs.drexel.edu>
*
* This is free software. Redistribution and use in source and binary forms, with
* or without modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
* 3. The name of the author may not be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
* EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
* OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
*/
package snmp;
import java.math.BigInteger;
import java.util.Vector;
/**
* The SNMPv2BulkRequestPDU class represents an SNMPv2 Bulk Request PDU from RFC 1905, as indicated below. This
* forms the payload of an SNMPv2 Bulk Request message.
-- protocol data units
3. Definitions
SNMPv2-PDU DEFINITIONS ::= BEGIN
IMPORTS
ObjectName, ObjectSyntax, Integer32
FROM SNMPv2-SMI;
-- protocol data units
PDUs ::=
CHOICE {
get-request
GetRequest-PDU,
get-next-request
GetNextRequest-PDU,
get-bulk-request
GetBulkRequest-PDU,
response
Response-PDU,
set-request
SetRequest-PDU,
inform-request
InformRequest-PDU,
snmpV2-trap
SNMPv2-Trap-PDU
}
-- PDUs
GetRequest-PDU ::=
[0]
IMPLICIT PDU
GetNextRequest-PDU ::=
[1]
IMPLICIT PDU
Response-PDU ::=
[2]
IMPLICIT PDU
SetRequest-PDU ::=
[3]
IMPLICIT PDU
-- [4] is obsolete
GetBulkRequest-PDU ::=
[5]
IMPLICIT BulkPDU
InformRequest-PDU ::=
[6]
IMPLICIT PDU
SNMPv2-Trap-PDU ::=
[7]
IMPLICIT PDU
max-bindings
INTEGER ::= 2147483647
BulkPDU ::= -- MUST be identical in
SEQUENCE { -- structure to PDU
request-id Integer32,
non-repeaters INTEGER (0..max-bindings),
max-repetitions INTEGER (0..max-bindings),
variable-bindings VarBindList -- values are ignored
}
*/
public class SNMPv2BulkRequestPDU extends SNMPSequence
{
/**
* Create a new PDU of the specified type, with given request ID, non-repeaters, and max-repetitions fields,
* and containing the supplied SNMP sequence as data.
*/
@SuppressWarnings("unchecked")
public SNMPv2BulkRequestPDU(int requestID, int nonRepeaters, int maxRepetitions, SNMPSequence varList)
throws SNMPBadValueException
{
super();
Vector contents = new Vector();
tag = SNMPBERCodec.SNMPv2BULKREQUEST;
contents.insertElementAt(new SNMPInteger(requestID), 0);
contents.insertElementAt(new SNMPInteger(nonRepeaters), 1);
contents.insertElementAt(new SNMPInteger(maxRepetitions), 2);
contents.insertElementAt(varList, 3);
this.setValue(contents);
}
/**
* Create a new PDU of the specified type from the supplied BER encoding.
* @throws SNMPBadValueException Indicates invalid SNMP Bulk PDU encoding supplied in enc.
*/
protected SNMPv2BulkRequestPDU(byte[] enc, byte pduType)
throws SNMPBadValueException
{
tag = pduType;
extractFromBEREncoding(enc);
// validate the message: make sure we have the appropriate pieces
Vector contents = (Vector)(this.getValue());
if (contents.size() != 4)
{
throw new SNMPBadValueException("Bad Bulk Request PDU");
}
if (!(contents.elementAt(0) instanceof SNMPInteger))
{
throw new SNMPBadValueException("Bad Bulk Request PDU: bad request ID");
}
if (!(contents.elementAt(1) instanceof SNMPInteger))
{
throw new SNMPBadValueException("Bad Bulk Request PDU: bad non-repeaters field");
}
if (!(contents.elementAt(2) instanceof SNMPInteger))
{
throw new SNMPBadValueException("Bad Bulk Request PDU: bad max-repetitions field");
}
if (!(contents.elementAt(3) instanceof SNMPSequence))
{
throw new SNMPBadValueException("Bad Bulk Request PDU: bad variable binding list");
}
// now validate the variable binding list: should be list of sequences which
// are (OID, value) pairs
SNMPSequence varBindList = this.getVarBindList();
for (int i = 0; i < varBindList.size(); i++)
{
SNMPObject element = varBindList.getSNMPObjectAt(i);
// must be a two-element sequence
if (!(element instanceof SNMPSequence))
{
throw new SNMPBadValueException("Bad Bulk Request PDU: bad variable binding at index" + i);
}
// variable binding sequence must have 2 elements, first of which must be an object identifier
SNMPSequence varBind = (SNMPSequence)element;
if ((varBind.size() != 2) || !(varBind.getSNMPObjectAt(0) instanceof SNMPObjectIdentifier))
{
throw new SNMPBadValueException("Bad Bulk Request PDU: bad variable binding at index" + i);
}
}
}
/**
* A utility method that extracts the variable binding list from the pdu. Useful for retrieving
* the set of (object identifier, value) pairs returned in response to a request to an SNMP
* device. The variable binding list is just an SNMP sequence containing the identifier, value pairs.
* @see snmp.SNMPVarBindList
*/
public SNMPSequence getVarBindList()
{
Vector contents = (Vector)(this.getValue());
return (SNMPSequence)(contents.elementAt(3));
}
/**
* A utility method that extracts the request ID number from this PDU.
*/
public int getRequestID()
{
Vector contents = (Vector)(this.getValue());
return ((BigInteger)((SNMPInteger)(contents.elementAt(0))).getValue()).intValue();
}
/**
* A utility method that extracts the non-repeaters field for this PDU.
*/
public int getNonRepeaters()
{
Vector contents = (Vector)(this.getValue());
return ((BigInteger)((SNMPInteger)(contents.elementAt(1))).getValue()).intValue();
}
/**
* A utility method that returns the max-repetitions field for this PDU.
*/
public int getMaxRepetitions()
{
Vector contents = (Vector)(this.getValue());
return ((BigInteger)((SNMPInteger)(contents.elementAt(2))).getValue()).intValue();
}
/**
* A utility method that returns the PDU type of this PDU.
*/
public byte getPDUType()
{
return tag;
}
}