net.itransformers.snmp2xml4j.snmptoolkit.SnmpManager Maven / Gradle / Ivy
The newest version!
/*
* SnmpManager.java
*
* This work is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published
* by the Free Software Foundation; either version 2 of the License,
* or (at your option) any later version.
*
* This work is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
* USA
*
* Copyright (c) 2010-2016 iTransformers Labs. All rights reserved.
*/
package net.itransformers.snmp2xml4j.snmptoolkit;
/**
* Created by niau on 3/14/16.
*
* @author niau
* @version $Id: $Id
*/
import net.itransformers.snmp2xml4j.snmptoolkit.messagedispacher.DefaultMessageDispatcherFactory;
import net.itransformers.snmp2xml4j.snmptoolkit.messagedispacher.MessageDispatcherAbstractFactory;
import net.itransformers.snmp2xml4j.snmptoolkit.transport.TransportMappingAbstractFactory;
import net.percederberg.mibble.*;
import net.percederberg.mibble.snmp.SnmpObjectType;
import net.percederberg.mibble.type.*;
import net.percederberg.mibble.value.ObjectIdentifierValue;
import org.apache.log4j.Logger;
import org.apache.log4j.Priority;
import org.snmp4j.*;
import org.snmp4j.event.ResponseEvent;
import org.snmp4j.mp.CounterSupport;
import org.snmp4j.mp.DefaultCounterListener;
import org.snmp4j.security.SecurityLevel;
import org.snmp4j.smi.Integer32;
import org.snmp4j.smi.OID;
import org.snmp4j.smi.TransportIpAddress;
import org.snmp4j.smi.VariableBinding;
import org.snmp4j.util.DefaultPDUFactory;
import org.snmp4j.util.PDUFactory;
import org.snmp4j.util.TableUtils;
import java.io.File;
import java.io.IOException;
import java.util.*;
public abstract class SnmpManager {
protected Snmp snmp = null;
static Logger logger = Logger.getLogger(SnmpManager.class);
protected int retries;
protected int timeout;
protected int maxSizeRequestPDU = 65535;
protected int maxRepetitions;
private MessageDispatcherAbstractFactory messageDispatcherFactory;
private TransportMappingAbstractFactory transportMappingAbstractFactory;
private TransportIpAddress transportLocalIpAddress;
protected MibLoader loader;
protected PDUFactory pduFactory;
/**
* Constructor for SnmpManager.
*
* @param loader a {@link net.percederberg.mibble.MibLoader} object.
* @param retries a int.
* @param timeout a int.
* @param maxSizeRequestPDU a int.
* @param maxRepetitions a int.
* @param transportMappingAbstractFactory a {@link net.itransformers.snmp2xml4j.snmptoolkit.transport.TransportMappingAbstractFactory} object.
* @param transportLocalIpAddress a {@link org.snmp4j.smi.TransportIpAddress} object.
*/
public SnmpManager(MibLoader loader, int retries, int timeout, int maxSizeRequestPDU, int maxRepetitions, TransportMappingAbstractFactory transportMappingAbstractFactory, TransportIpAddress transportLocalIpAddress) {
this.retries = retries;
this.timeout = timeout;
this.maxSizeRequestPDU = maxSizeRequestPDU;
this.messageDispatcherFactory = new DefaultMessageDispatcherFactory();
this.transportMappingAbstractFactory = transportMappingAbstractFactory;
this.pduFactory = new DefaultPDUFactory();
this.transportLocalIpAddress = transportLocalIpAddress;
this.maxRepetitions = maxRepetitions;
this.loader = loader;
}
/**
* Constructor for SnmpManager.
*
* @param loader a {@link net.percederberg.mibble.MibLoader} object.
* @param transportMappingAbstractFactory a {@link net.itransformers.snmp2xml4j.snmptoolkit.transport.TransportMappingAbstractFactory} object.
* @param messageDispatcherAbstractFactory a {@link net.itransformers.snmp2xml4j.snmptoolkit.messagedispacher.MessageDispatcherAbstractFactory} object.
* @param transportLocalIpAddress a {@link org.snmp4j.smi.TransportIpAddress} object.
*/
public SnmpManager(MibLoader loader, TransportMappingAbstractFactory transportMappingAbstractFactory, MessageDispatcherAbstractFactory messageDispatcherAbstractFactory, TransportIpAddress transportLocalIpAddress) {
this.messageDispatcherFactory = new DefaultMessageDispatcherFactory();
this.transportMappingAbstractFactory = transportMappingAbstractFactory;
this.messageDispatcherFactory = messageDispatcherAbstractFactory;
this.pduFactory = new DefaultPDUFactory();
this.loader = loader;
this.transportLocalIpAddress = transportLocalIpAddress;
}
public void closeSnmp() throws IOException {
snmp.close();
}
/**
* doInit.
*
* @throws java.io.IOException if any.
*/
protected abstract void doInit() throws IOException;
/**
* init.
*
* @throws java.io.IOException if any.
*/
public void init() throws IOException {
TransportMapping transportMapping = transportMappingAbstractFactory.createTransportMapping(transportLocalIpAddress);
MessageDispatcher messageDispatcher = messageDispatcherFactory.createMessageDispatcherMapping();
snmp = new Snmp(messageDispatcher, transportMapping);
doInit();
transportMapping.listen();
}
/**
* doSetParameters.
*
* @param conParams a {@link java.util.Map} object.
*/
protected abstract void doSetParameters(Map conParams);
/**
* setParameters.
*
* @param conParams a {@link java.util.Map} object.
*/
public void setParameters(Map conParams) {
if (conParams!=null) {
this.retries = convertStringToIntParam("retries", conParams.get("retries"), 3);
this.timeout = convertStringToIntParam("timeout", conParams.get("timeout"), 1000);
this.maxSizeRequestPDU = convertStringToIntParam("maxSizeRequestPDU", conParams.get("maxSizeRequestPDU"), 1000);
this.maxRepetitions = convertStringToIntParam("maxRepetitions", conParams.get("maxRepetitions"), 10);
doSetParameters(conParams);
}
}
/**
* convertStringToIntParam.
*
* @param name a {@link java.lang.String} object.
* @param value a {@link java.lang.String} object.
* @param defaultValue a int.
* @return a int.
*/
protected int convertStringToIntParam(String name, String value, int defaultValue){
int valueInt;
if (value != null) {
try {
valueInt = Integer.parseInt(value);
return valueInt;
} catch (NumberFormatException nfe) {
logger.info("Invalid value for "+ name + " setting to default "+defaultValue);
}
}
return defaultValue;
}
/**
* set.
*
* @param oids an array of {@link org.snmp4j.smi.OID} objects.
* @param value a int.
* @return a {@link org.snmp4j.event.ResponseEvent} object.
*/
public ResponseEvent set(OID oids[], int value) {
PDU pdu = createPDU();
for (OID oid : oids) {
pdu.add(new VariableBinding(oid, new Integer32(value)));
}
pdu.setType(PDU.SET);
ResponseEvent event = null;
try {
event = snmp.send(pdu, getTarget(), null);
} catch (IOException ioe) {
System.out.println("Error SNMP SET");
}
if (event != null) {
return event;
}
throw new RuntimeException("SET timed out");
}
/**
* This method is capable of handling multiple OIDs
*
* @param oidStrings an array of {@link java.lang.String} objects.
* @return a {@link org.snmp4j.event.ResponseEvent} object.
* @throws java.io.IOException if any.
*/
public ResponseEvent snmpGet(ArrayList oidStrings) throws IOException {
OID oidOids[] = new OID[oidStrings.size()];
int i = 0;
for (String oid : oidStrings) {
MibValueSymbol symbol = findSymbolFromMibs(oid);
if (symbol == null) {
oidOids[i] = new OID(oid);
}else {
String oidd = symbol.getValue().toString();
oidOids[i] = new OID(oidd);
}
i++;
}
return snmpGetNext(oidOids);
}
/**
* snmpGet.
*
* @param oids an array of {@link org.snmp4j.smi.OID} objects.
* @return a {@link org.snmp4j.event.ResponseEvent} object.
* @throws java.io.IOException if any.
*/
public ResponseEvent snmpGet(OID oids[]) throws IOException {
PDU pdu = pduFactory.createPDU(getTarget());
for (OID oid : oids) {
pdu.add(new VariableBinding(oid));
}
pdu.setType(PDU.GET);
ResponseEvent response;
response = snmp.send(pdu, getTarget());
if (response != null) {
PDU responsePDU = response.getResponse();
if (responsePDU != null) {
if (responsePDU.getErrorStatus() == PDU.noError) {
return response;
}
}
logger.log(Priority.INFO, "GET reposne from " + getTarget().getAddress() + " was null!");
return null;
}
logger.log(Priority.INFO, "GET from " + getTarget().getAddress() + " has timed out!");
return null;
}
/**
* snmpGet.
*
* @param oidString a {@link java.lang.String} object.
* @return a {@link java.lang.String} object.
* @throws java.io.IOException if any.
*/
public String snmpGet(String oidString) throws IOException {
OID oid = new OID(oidString);
PDU pdu = pduFactory.createPDU(getTarget());
pdu.add(new VariableBinding(oid));
pdu.setType(PDU.GET);
ResponseEvent response;
response = snmp.send(pdu, getTarget());
if (response != null) {
PDU responsePDU = response.getResponse();
if (responsePDU != null) {
if (responsePDU.getErrorStatus() == PDU.noError) {
return responsePDU.get(0).toValueString();
}
}
logger.info("GET reposne from " + getTarget().getAddress() + " was null!");
return null;
}
logger.info("GET from " + getTarget().getAddress() + " has timed out!");
return null;
}
/**
* getNext.
*
* @param oidString a {@link java.lang.String} object.
* @return a {@link java.lang.String} object.
* @throws java.io.IOException if any.
*/
public String snmpGetNext(String oidString) throws IOException {
OID oid = new OID(oidString);
PDU pdu = pduFactory.createPDU(getTarget());
pdu.add(new VariableBinding(oid));
pdu.setType(PDU.GETNEXT);
ResponseEvent response;
response = snmp.send(pdu, getTarget());
if (response != null) {
PDU responsePDU = response.getResponse();
if (responsePDU != null) {
if (responsePDU.getErrorStatus() == PDU.noError) {
return responsePDU.get(0).toValueString();
}
}
logger.info("GET reposne from " + getTarget().getAddress() + " was null!");
return null;
}
logger.info("GET from " + getTarget().getAddress() + " has timed out!");
return null;
}
/**
* getNext.
*
* @param oids an array of {@link org.snmp4j.smi.OID} objects.
* @return a {@link org.snmp4j.event.ResponseEvent} object.
* @throws java.io.IOException if any.
*/
public ResponseEvent snmpGetNext(OID oids[]) throws IOException {
PDU pdu = pduFactory.createPDU(getTarget());
for (OID oid : oids) {
pdu.add(new VariableBinding(oid));
}
pdu.setType(PDU.GETNEXT);
ResponseEvent response;
response = snmp.send(pdu, getTarget());
if (response != null) {
PDU responsePDU = response.getResponse();
if (responsePDU != null) {
if (responsePDU.getErrorStatus() == PDU.noError) {
return response;
}
}
logger.log(Priority.INFO, "GET reposne from " + getTarget().getAddress() + " was null!");
return null;
}
logger.log(Priority.INFO, "GET from " + getTarget().getAddress() + " has timed out!");
return null;
}
/**
* getTarget.
*
* @return a {@link org.snmp4j.Target} object.
*/
protected abstract Target getTarget();
/**
* createPDU.
*
* @return a {@link org.snmp4j.PDU} object.
*/
protected abstract PDU createPDU();
/**
* snmpWalk.
*
* @param includes an array of {@link java.lang.String} objects.
* @return a {@link net.itransformers.snmp2xml4j.snmptoolkit.Node} object.
* @throws java.io.IOException if any.
*/
public Node snmpWalk(String[] includes) throws IOException {
ObjectIdentifierValue oid = loader.getRootOid();
Set includesSet = new HashSet(Arrays.asList(includes));
Node rootNode = new Node(oid, null);
fillTreeFromMib(rootNode);
fillDoWalk(rootNode, includesSet);
fillTreeFromSNMP(rootNode);
return rootNode;
}
public String snmpWalkToString(String[] includes) throws IOException {
ObjectIdentifierValue oid = loader.getRootOid();
Set includesSet = new HashSet(Arrays.asList(includes));
Node rootNode = new Node(oid, null);
fillTreeFromMib(rootNode);
fillDoWalk(rootNode, includesSet);
fillTreeFromSNMP(rootNode);
SnmpXmlPrinter snmpXmlPrinter = new SnmpXmlPrinter(loader,rootNode);
return snmpXmlPrinter.printTreeAsXML();
}
private void fillTreeFromMib(Node node) {
ObjectIdentifierValue oid = node.getObjectIdentifierValue();
ObjectIdentifierValue[] children = oid.getAllChildren();
for (ObjectIdentifierValue child : children) {
if (child == null) { // in case it is not found
continue;
}
Node childNode = new Node(child, node);
node.addChild(childNode);
fillTreeFromMib(childNode);
}
}
/**
* fillTreeFromSNMP.
*
* @param root a {@link net.itransformers.snmp2xml4j.snmptoolkit.Node} object.
* @throws java.io.IOException if any.
*/
protected void fillTreeFromSNMP(Node root) throws IOException {
CounterSupport.getInstance().addCounterListener(new DefaultCounterListener());
// AbstractTransportMapping transport = new DefaultUdpTransportMapping(localAddress);
//
TableUtils tutils = new TableUtils(snmp, pduFactory);
fillTreeFromSNMP(root, tutils);
}
private void fillDoWalk(Node node, Set includes) {
if (includes.contains(node.getObjectIdentifierValue().getName())) {
// set parents and itself
Node currentNode = node;
while (currentNode != null) {
currentNode.setDoWalk(true);
currentNode = currentNode.getParent();
}
fillDoWalkChildren(node);
}
for (Node child : node.getChildren()) {
fillDoWalk(child, includes);
}
}
private void fillDoWalkChildren(Node node) {
for (Node child : node.getChildren()) {
child.setDoWalk(true);
fillDoWalkChildren(child);
}
}
private void fillTreeFromSNMP(Node node, TableUtils tutils ) throws IOException {
if (!node.isDoWalk()) return;
ObjectIdentifierValue oid = node.getObjectIdentifierValue();
MibValueSymbol mibValueSymbol = oid.getSymbol();
if (mibValueSymbol != null) {
MibType mibType = mibValueSymbol.getType();
if (mibType instanceof SnmpObjectType) {
SnmpObjectType snmpObjectType = (SnmpObjectType) mibType;
MibType syntax = snmpObjectType.getSyntax();
if (syntax instanceof SequenceType) {
ArrayList oidList = new ArrayList();
for (Node child : node.getChildren()) {
if (child.isDoWalk()) {
ObjectIdentifierValue childOid = child.getObjectIdentifierValue();
oidList.add(new OID(childOid.getSymbol().getValue().toString()));
}
}
if (oidList.size() > 0) {
OID[] oids = oidList.toArray(new OID[oidList.size()]);
List table = tutils.getTable(getTarget(), oids, new OID("0"), null);
node.setTable(table);
}
return;
} else if (syntax instanceof BitSetType
|| syntax instanceof BooleanType
|| syntax instanceof ChoiceType
|| syntax instanceof IntegerType
|| syntax instanceof NullType
|| syntax instanceof ObjectIdentifierType
|| syntax instanceof RealType
|| syntax instanceof ElementType
|| syntax instanceof StringType
|| syntax instanceof TypeReference
) {
final OID oid1 = new OID(node.getObjectIdentifierValue().toString());
VariableBinding vb = getSingleVariable(oid1);
//logger.debug("Response: " + vb.getVariable().toString());
node.setVb(vb);
}
}
}
for (Node child : node.getChildren()) {
fillTreeFromSNMP(child, tutils);
}
}
private VariableBinding getSingleVariable(OID oid) throws IOException {
PDU pdu = this.pduFactory.createPDU(getTarget());
pdu.setType(PDU.GETNEXT);
pdu.add(new VariableBinding(oid));
ResponseEvent responseEvent = snmp.send(pdu, getTarget());
PDU responsePDU = null;
if (responseEvent != null) responsePDU = responseEvent.getResponse();
VariableBinding vb = null;
if (responsePDU != null) vb = responsePDU.get(0);
return vb;
}
/**
* main.
*
* @param args an array of {@link java.lang.String} objects.
* @throws java.io.IOException if any.
* @throws net.percederberg.mibble.MibLoaderException if any.
*/
public static void main(String[] args) throws IOException, MibLoaderException {
MibLoaderHolder mibLoaderHolder = new MibLoaderHolder(new File("mibs"), false);
SnmpManager snmpUdpv2Manager = new SnmpUdpV2Manager(mibLoaderHolder.getLoader(), "195.218.195.228", "public", 1, 1000, 65535,10, 161);
String oid1 = "1.3.6.1.2.1.1.1.0";
snmpUdpv2Manager.init();
OID oid = new OID(oid1);
OID oids[] = new OID[]{oid};
ResponseEvent responseEvent = snmpUdpv2Manager.snmpGet(oids);
PDU response;
if (responseEvent!=null) {
response = responseEvent.getResponse();
if (response != null) {
for (int i = 0; i < response.size(); i++) {
VariableBinding vb1 = response.get(i);
System.out.println(vb1.toString());
}
}
} else {
logger.debug("PDU response event is null");
}
SnmpManager snmpUdpv3Manager = new SnmpUdpV3Manager(mibLoaderHolder.getLoader(), "195.218.195.228", SecurityLevel.AUTH_NOPRIV, "usr-md5-none", "authkey1", "MD5", null, null, 2, 1000, 65535,10, 161);
snmpUdpv3Manager.init();
responseEvent = snmpUdpv3Manager.snmpGet(oids);
if (responseEvent!=null) {
response = responseEvent.getResponse();
if (response != null) {
for (int i = 0; i < response.size(); i++) {
VariableBinding vb1 = response.get(i);
System.out.println(vb1.getVariable().toString());
}
}
} else {
logger.debug("PDU response event is null");
}
SnmpXmlPrinter xmlPrinter = new SnmpXmlPrinter(mibLoaderHolder.getLoader(),snmpUdpv3Manager.snmpWalk(new String[]{"system", "interfaces"}));
//TODO add a parameter for detailed XML output
String xml = xmlPrinter.printTreeAsXML(true);
logger.trace(xml);
}
/**
* getSymbolFromMibByOid.
*
* @param mibName a {@link java.lang.String} object.
* @param oid a {@link java.lang.String} object.
* @return a {@link java.lang.String} object.
*/
public String getSymbolFromMibByOid(String mibName, String oid) {
logger.debug("getSymbolByOid, mibName="+mibName + ", oid="+oid);
Mib mib = loader.getMib(mibName);
if (mib == null) {
logger.error("Can not find symbol by mib, mibName="+mibName + ", oid="+oid);
}
final MibValueSymbol symbolByOid = mib != null ? mib.getSymbolByOid(oid) : null;
if (symbolByOid == null) {
logger.error("Can not find symbol by OID, mibName="+mibName + ", oid="+oid);
return null;
}
logger.info(symbolByOid.getName());
return symbolByOid.getName();
}
private MibValueSymbol findSymbolFromMibs(String oidName){
Mib mibs[] = loader.getAllMibs();
MibValueSymbol symbol11 = null;
for (Mib mib : mibs) {
symbol11 = (MibValueSymbol) mib.findSymbol(oidName, true);
if (symbol11 != null) {
return symbol11;
}
}
return null;
}
/**
* Getter for the field timeout.
*
* @return a int.
*/
public int getTimeout() {
return timeout;
}
/**
* Setter for the field timeout.
*
* @param timeout a int.
*/
public void setTimeout(int timeout) {
this.timeout = timeout;
}
/**
* Getter for the field snmp.
*
* @return a {@link org.snmp4j.Snmp} object.
*/
public Snmp getSnmp() {
return snmp;
}
/**
* Setter for the field snmp.
*
* @param snmp a {@link org.snmp4j.Snmp} object.
*/
public void setSnmp(Snmp snmp) {
this.snmp = snmp;
}
/**
* Getter for the field retries.
*
* @return a int.
*/
public int getRetries() {
return retries;
}
/**
* Setter for the field retries.
*
* @param retries a int.
*/
public void setRetries(int retries) {
this.retries = retries;
}
/**
* Getter for the field maxSizeRequestPDU.
*
* @return a int.
*/
public int getMaxSizeRequestPDU() {
return maxSizeRequestPDU;
}
/**
* Setter for the field maxSizeRequestPDU.
*
* @param maxSizeRequestPDU a int.
*/
public void setMaxSizeRequestPDU(int maxSizeRequestPDU) {
this.maxSizeRequestPDU = maxSizeRequestPDU;
}
/**
* Getter for the field maxRepetitions.
*
* @return a int.
*/
public int getMaxRepetitions() {
return maxRepetitions;
}
/**
* Setter for the field maxRepetitions.
*
* @param maxRepetitions a int.
*/
public void setMaxRepetitions(int maxRepetitions) {
this.maxRepetitions = maxRepetitions;
}
public MibLoader getLoader() {
return loader;
}
public void setLoader(MibLoader loader) {
this.loader = loader;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy