Snmp學習總結(七)——SNMP4J介紹
一、SNMP4J介紹
SNMP4J是一個用Java來實現SNMP(簡單網路管理協議)協議的開源專案.它支援以命令列的形式進行管理與響應。SNMP4J是純物件導向設計與SNMP++(用C++實現SNMPv1/v2c/v3)相類似。
SNMP4J API 提供以下下特性：
- 支援MD5和SHA驗證，DES，3DES,AES128、AES192和AES256加密的SNMPv3。
- 支援MPv1,MPv2C和MPv3，帶執行的可阻塞的資訊處理模組。
- 全部PDU格式。
- 可阻塞的傳輸拓撲。支援UPD、TCP、TLS 。
- 可阻塞的超時模組。
- 同步和非同步請求。
- 命令發生器以及命令應答器的支援。
- 基於Apache license的開源免費。
- JAVA 1.4.1或更高版本(2.0或更高版本需要jdk1.6及以上的支援)。
- 基於LOG4J記錄日誌。
- 使用GETBULK實現Row-based的有效的非同步表格獲取。
- 支援多執行緒。
二、SNMP4J重要的類和介面介紹
2.1、Snmp類
Snmp類：該類是SNMP4J中最為核心的類。負責SNMP報文的接受和傳送。它提供了傳送和接收PDU的方法，所有的PDU型別都可以採用同步或者非同步的方式被髮送
2.2、PDU類和ScopedPDU類
該類是SNMP報文單元的抽象，其中PDU類適用於SNMPv1和SNMPv2c。ScopedPDU類繼承於PDU類，適用於SNMPv3。
2.3、Target介面和CommunityTarget類以及UserTarget類
對應於SNMP代理的地址資訊，包括IP地址和埠號（161）。其中Target介面適用於SNMPv1和SNMPv2c。CommunityTarget類實現了Target介面，用於SNMPv1和SNMPv2c這兩個版本，UserTarget類實現了Target介面，適用於SNMPv3。
2.4、TransportMapping介面
該介面代表了SNMP4J所使用的傳輸層協議。這也是SNMP4J一大特色的地方。按照RFC的規定，SNMP是隻使用UDP作為傳輸層協議的。而SNMP4J支援管理端和代理端使用UDP或者TCP進行傳輸。該介面有兩個子介面。
2.5、Snmp、Target、PDU三者的關係
Target代表遠端裝置或者遠端實體、PDU代表管理端同Target通訊的資料，Snmp就代表管理者管理功能（其實就是資料的收發）的具體執行者。
打個比方：Target就是你遠方的戀人，PDU就是你們之間傳遞的情書、而Snmp就是負責幫你寄信收信的郵差。
三、SNMP4J的兩種訊息傳送模式
SNMP4J支援兩種訊息傳送模式：同步傳送模式和非同步傳送模式。
同步傳送模式也稱阻塞模式。當管理端傳送出一條訊息之後，執行緒會被阻塞，直到收到對方的回應或者時間超時。同步傳送模式程式設計較為簡單，但是不適用於傳送廣播訊息。
非同步傳送模式也稱非阻塞模式。當程式傳送一條訊息之後，執行緒將會繼續執行，當收到訊息的回應的時候，程式會對訊息作出相應的處理。要實現非同步傳送模式，需要例項化一個實現了ResponseListener介面的類的物件。ResponseListener介面中有一個名為onResponse的函式。這是一個回撥函式，當程式收到響應的時候，會自動呼叫該函式。由該函式完成對響應的處理。
四、使用SNMP4J實現管理端的步驟
該部分說明了利用SNMP4J編寫SNMP管理端的大致過程，讀者在閱讀之後會對SNMP4J有一個宏觀上的認識。在附錄部分，作者給出了一個用SNMP4J開發管理站的樣例程式，如果有進一步的需要，請參考附錄部分。
4.1 、初始化
①、明確SNMP在傳輸層所使用的協議
一般情況下，我們都使用使用UDP協議作為SNMP的傳輸層協議，所以我們需要例項化的是一個DefaultUdpTransportMapping介面物件；
②、例項化一個snmp物件
在此過程中，我們需要將1中例項化的DefaultUdpTransportMapping介面的物件作為引數，穿snmp類的建構函式中。另外，如果實現的SNMPv3協議，我們還需要設定安全機制，新增安全使用者等等；
③、監聽snmp訊息
在此，我們可以呼叫剛剛例項化的DefaultUdpTransportMapping的介面物件的listen方法，讓程式監聽snmp訊息；
4.2、 構造傳送目標
如果實現的是SNMPv2c或者說SNMPv1，需要例項化一個CommunityTarget物件。如果實現的是SNMPv3程式，則需要例項化一個UserTarget物件。
之後，我們還需要對例項化的物件做一些設定。如果是CommunityTarget的物件，則需要設定使用的Snmp版本，重傳時間和等待時延。如果是UserTarget物件，我們不僅需要設定版本、重傳時間、等待時延，還需要設定安全級別和安全名稱。
4.3、 構造傳送報文
如果傳送的是SNMPv2c或者說SNMPv1的報文，我們需要例項化一個PDU類的物件。如果傳送的是SNMPv3的報文，我們則需要例項化一個ScopedPDU類的物件。之後，我們還需要生成一個OID物件，其中包含了我們所需要獲取的SNMP物件在MIB庫中的ID。然後我們需要將OID和之前生成的PDU物件或者是ScopedPDU物件繫結，並且設定PDU的報文型別（五種SNMP報文型別之一）。
4.4、 構造響應監聽物件（非同步模式）
當使用非同步模式的時候，我們需要例項化一個實現了ResponseListener介面的物件，作為響應訊息的監聽物件。在構造該物件的過程中，我們需要重寫ResponseListener的OnResponse函式，該函式是一個回撥函式，用來處理程式收到響應後的一些操作。
4.5、 傳送訊息
當所有上述操作都設定完畢之後，就可以傳送訊息了。同步模式和非同步模式傳送訊息呼叫的函式名字均為send，但是兩個函式所需引數不一樣。同步模式的引數僅為4.2和4.3中構造的目標物件和報文物件，而非同步模式還需要4.4中構造的監聽物件。
同步模式傳送訊息後便等待響應的到達，到達之後會返回一個ResponseEvent物件，該物件中包含了響應的相應資訊。
非同步模式傳送訊息之後便會繼續執行，當收到響應訊息時便會呼叫監聽物件的OnResponse函式。該函式中的語句便是我們對響應的處理
五、使用SNMP4J實現管理端的程式設計實現
①、設定遠端實體
snmp4j中，用CommunityTarget物件來表示遠端實體（要進行snmp訊息通訊的遠端主機，使用snmp的v2版本）
②、指定遠端實體的地址
snmp4j中使用Address介面物件來表示，Address物件需要透過實現該介面的類的物件向上轉型來例項化
③、透過CommunityTarget以及其父介面中提供的setXX方法來設定遠端實體的屬性，如設定遠端實體的snmp共同體屬性、遠端實體的地址、超時時間、重傳次數、snmp版本等
④、設定使用的傳輸協議
snmp4j中，用TransportMapping介面的物件來表示傳輸協議（tcp/udp）
⑤、呼叫TransportMapping中的listen()方法，啟動監聽程式，接收訊息，由於該監聽程式是守護程式，最後應呼叫close()方法來釋放該程式
⑥、建立SNMP物件，用於傳送請求PDU
a、建立請求pdu，即建立PDU類的物件，呼叫PDU類中的add()方法繫結要查詢的OID，呼叫PDU中的setType()方法來確定該pdu的型別（與snmp中五種操作想對應）
b、透過PDU的構造方法 public SNMP(TransportMapping transportingMapping),或者其他構造方法來生成pdu,之後呼叫 ResopnseEvent send(PDU pdu,Target target)傳送pdu，該方法返回一個ResponseEvent物件
⑦、透過ResponseEvent物件來獲得SNMP請求的應答pdu，方法：public PDU getResponse()
⑧、透過應答pdu獲得mib資訊（之前繫結的OID的值），方法：VaribleBinding get（int index）
5.1、獲取遠端計算機的名稱
package me.gacl.snmp;import java.io.IOException;
import org.snmp4j.CommunityTarget;
import org.snmp4j.PDU;
import org.snmp4j.ScopedPDU;
import org.snmp4j.Snmp;
import org.snmp4j.Target;
import org.snmp4j.TransportMapping;
import org.snmp4j.UserTarget;
import org.snmp4j.event.ResponseEvent;
import org.snmp4j.event.ResponseListener;
import org.snmp4j.mp.MPv3;
import org.snmp4j.mp.SnmpConstants;
import org.snmp4j.security.AuthMD5;
import org.snmp4j.security.PrivDES;
import org.snmp4j.security.SecurityLevel;
import org.snmp4j.security.SecurityModels;
import org.snmp4j.security.SecurityProtocols;
import org.snmp4j.security.USM;
import org.snmp4j.security.UsmUser;
import org.snmp4j.smi.Address;
import org.snmp4j.smi.GenericAddress;
import org.snmp4j.smi.OID;
import org.snmp4j.smi.OctetString;
import org.snmp4j.smi.VariableBinding;
import org.snmp4j.transport.DefaultUdpTransportMapping;
public class Snmp4jFirstDemo {
private Snmp snmp = null;
private int version ;
public Snmp4jFirstDemo(int version) {
try {
this.version = version;
TransportMapping transport = new DefaultUdpTransportMapping();
snmp = new Snmp(transport);
if (version == SnmpConstants.version3) {
// 設定安全模式
USM usm = new USM(SecurityProtocols.getInstance(),new OctetString(MPv3.createLocalEngineID()), 0);
SecurityModels.getInstance().addSecurityModel(usm);
}
// 開始監聽訊息
transport.listen();
} catch (IOException e) {
e.printStackTrace();
}
}
public void sendMessage(Boolean syn, final Boolean bro, PDU pdu, String addr)
throws IOException {
// 生成目標地址物件
Address targetAddress = GenericAddress.parse(addr);
Target target = null;
if (version == SnmpConstants.version3) {
// 新增使用者
snmp.getUSM().addUser(new OctetString("MD5DES"),new UsmUser(new OctetString("MD5DES"), AuthMD5.ID,new OctetString("MD5DESUserAuthPassword"),PrivDES.ID, new OctetString("MD5DESUserPrivPassword")));
target = new UserTarget();
// 設定安全級別
((UserTarget) target).setSecurityLevel(SecurityLevel.AUTH_PRIV);
((UserTarget) target).setSecurityName(new OctetString("MD5DES"));
target.setVersion(SnmpConstants.version3);
} else {
target = new CommunityTarget();
if (version == SnmpConstants.version1) {
target.setVersion(SnmpConstants.version1);
((CommunityTarget) target).setCommunity(new OctetString("public"));
} else {
target.setVersion(SnmpConstants.version2c);
((CommunityTarget) target).setCommunity(new OctetString("public"));
}
}
// 目標物件相關設定
target.setAddress(targetAddress);
target.setRetries(5);
target.setTimeout(1000);
if (!syn) {
// 傳送報文 並且接受響應
ResponseEvent response = snmp.send(pdu, target);
// 處理響應
System.out.println("Synchronize(同步) message(訊息) from(來自) "
+ response.getPeerAddress() + "\r\n"+"request(傳送的請求):"
+ response.getRequest() + "\r\n"+"response(返回的響應):"
+ response.getResponse());
/**
* 輸出結果：
* Synchronize(同步) message(訊息) from(來自) 192.168.1.233/161
request(傳送的請求):GET[requestID=632977521, errorStatus=Success(0), errorIndex=0, VBS[1.3.6.1.2.1.1.5.0 = Null]]
response(返回的響應):RESPONSE[requestID=632977521, errorStatus=Success(0), errorIndex=0, VBS[1.3.6.1.2.1.1.5.0 = WIN-667H6TS3U37]]
*/
} else {
// 設定監聽物件
ResponseListener listener = new ResponseListener() {
public void onResponse(ResponseEvent event) {
if (bro.equals(false)) {
((Snmp) event.getSource()).cancel(event.getRequest(),this);
}
// 處理響應
PDU request = event.getRequest();
PDU response = event.getResponse();
System.out.println("Asynchronise(非同步) message(訊息) from(來自) "
+ event.getPeerAddress() + "\r\n"+"request(傳送的請求):" + request
+ "\r\n"+"response(返回的響應):" + response);
}
};
// 傳送報文
snmp.send(pdu, target, null, listener);
}
}
public static void main(String[] args) {
//Snmp的三個版本號
//int ver3 = SnmpConstants.version3;
int ver2c = SnmpConstants.version2c;
//int ver1 = SnmpConstants.version1;
Snmp4jFirstDemo manager = new Snmp4jFirstDemo(ver2c);
// 構造報文
PDU pdu = new PDU();
//PDU pdu = new ScopedPDU();
// 設定要獲取的物件ID，這個OID代表遠端計算機的名稱
OID oids = new OID("1.3.6.1.2.1.1.5.0");
pdu.add(new VariableBinding(oids));
// 設定報文型別
pdu.setType(PDU.GET);
//((ScopedPDU) pdu).setContextName(new OctetString("priv"));
try {
// 傳送訊息 其中最後一個是想要傳送的目標地址
//manager.sendMessage(false, true, pdu, "udp:192.168.1.229/161");//192.168.1.229 Linux伺服器
manager.sendMessage(false, true, pdu, "udp:192.168.1.233/161");//192.168.1.233 WinServer2008伺服器
} catch (IOException e) {
e.printStackTrace();
}
}
}
5.2、獲得本機的資訊
package me.gacl.snmp;
import java.io.IOException;
import org.snmp4j.CommunityTarget;
import org.snmp4j.PDU;
import org.snmp4j.Snmp;
import org.snmp4j.TransportMapping;
import org.snmp4j.event.ResponseEvent;
import org.snmp4j.mp.SnmpConstants;
import org.snmp4j.smi.Address;
import org.snmp4j.smi.GenericAddress;
import org.snmp4j.smi.OID;
import org.snmp4j.smi.OctetString;
import org.snmp4j.smi.VariableBinding;
import org.snmp4j.transport.DefaultUdpTransportMapping;
/**
*
ClassName: GetOID
*
Description:獲得本機的資訊
* @author xudp
* @version 1.0 V
* @createTime 2014-9-15 下午04:45:12
*/
public class GetOID {
public static void main(String[] args) throws Exception{
try{
//設定CommunityTarget
CommunityTarget myTarget = new CommunityTarget();
//定義遠端主機的地址
//Address deviceAdd = GenericAddress.parse("udp:192.168.1.233/161");
//定義本機的地址
Address localAdd = GenericAddress.parse("udp:localhost/161");
//設定遠端主機的地址
//myTarget.setAddress(deviceAdd);
//設定本地主機的地址
myTarget.setAddress(localAdd);
//設定snmp共同體
myTarget.setCommunity(new OctetString("public"));
//設定超時重試次數
myTarget.setRetries(2);
//設定超時的時間
myTarget.setTimeout(5*60);
//設定使用的snmp版本
myTarget.setVersion(SnmpConstants.version2c);
//設定採取的協議
TransportMapping transport = new DefaultUdpTransportMapping();//設定傳輸協議為UDP
//呼叫TransportMapping中的listen()方法，啟動監聽程式，接收訊息，由於該監聽程式是守護程式，最後應呼叫close()方法來釋放該程式
transport.listen();
//建立SNMP物件，用於傳送請求PDU
Snmp protocol = new Snmp(transport);
//建立請求pdu,獲取mib
PDU request = new PDU();
//呼叫的add方法繫結要查詢的OID
request.add(new VariableBinding(new OID("1.3.6.1.2.1.1.1")));
request.add(new VariableBinding(new OID(new int[] {1,3,6,1,2,1,1,2})));
//呼叫setType()方法來確定該pdu的型別
request.setType(PDU.GETNEXT);
//呼叫 send(PDU pdu,Target target)傳送pdu，返回一個ResponseEvent物件
ResponseEvent responseEvent = protocol.send(request, myTarget);
//透過ResponseEvent物件來獲得SNMP請求的應答pdu，方法：public PDU getResponse()
PDU response=responseEvent.getResponse();
//輸出
if(response != null){
System.out.println("request.size()="+request.size());
System.out.println("response.size()="+response.size());
//透過應答pdu獲得mib資訊（之前繫結的OID的值），方法：VaribleBinding get(int index)
VariableBinding vb1 = response.get(0);
VariableBinding vb2 = response.get(1);
System.out.println(vb1);
System.out.println(vb2);
//呼叫close()方法釋放該程式
transport.close();
/**
* 輸出結果：
* request.size()=2
response.size()=2
1.3.6.1.2.1.1.1.0 = Hardware: x86 Family 6 Model 58 Stepping 9 AT/AT COMPATIBLE - Software: Windows 2000 Version 5.1 (Build 2600 Multiprocessor Free)
1.3.6.1.2.1.1.2.0 = 1.3.6.1.4.1.311.1.1.3.1.1
*/
}
}catch(IOException e){
e.printStackTrace();
}
}
} 以上就是關於SNMP4J的簡單介紹和入門，後面的博文中將進行更加詳細的介紹。
* @version 1.0 V
* @createTime 2014-9-15 下午04:45:12
*/
public class GetOID {
public static void main(String[] args) throws Exception{
try{
//設定CommunityTarget
CommunityTarget myTarget = new CommunityTarget();
//定義遠端主機的地址
//Address deviceAdd = GenericAddress.parse("udp:192.168.1.233/161");
//定義本機的地址
Address localAdd = GenericAddress.parse("udp:localhost/161");
//設定遠端主機的地址
//myTarget.setAddress(deviceAdd);
//設定本地主機的地址
myTarget.setAddress(localAdd);
//設定snmp共同體
myTarget.setCommunity(new OctetString("public"));
//設定超時重試次數
myTarget.setRetries(2);
//設定超時的時間
myTarget.setTimeout(5*60);
//設定使用的snmp版本
myTarget.setVersion(SnmpConstants.version2c);
//設定採取的協議
TransportMapping transport = new DefaultUdpTransportMapping();//設定傳輸協議為UDP
//呼叫TransportMapping中的listen()方法，啟動監聽程式，接收訊息，由於該監聽程式是守護程式，最後應呼叫close()方法來釋放該程式
transport.listen();
//建立SNMP物件，用於傳送請求PDU
Snmp protocol = new Snmp(transport);
//建立請求pdu,獲取mib
PDU request = new PDU();
//呼叫的add方法繫結要查詢的OID
request.add(new VariableBinding(new OID("1.3.6.1.2.1.1.1")));
request.add(new VariableBinding(new OID(new int[] {1,3,6,1,2,1,1,2})));
//呼叫setType()方法來確定該pdu的型別
request.setType(PDU.GETNEXT);
//呼叫 send(PDU pdu,Target target)傳送pdu，返回一個ResponseEvent物件
ResponseEvent responseEvent = protocol.send(request, myTarget);
//透過ResponseEvent物件來獲得SNMP請求的應答pdu，方法：public PDU getResponse()
PDU response=responseEvent.getResponse();
//輸出
if(response != null){
System.out.println("request.size()="+request.size());
System.out.println("response.size()="+response.size());
//透過應答pdu獲得mib資訊（之前繫結的OID的值），方法：VaribleBinding get(int index)
VariableBinding vb1 = response.get(0);
VariableBinding vb2 = response.get(1);
System.out.println(vb1);
System.out.println(vb2);
//呼叫close()方法釋放該程式
transport.close();
/**
* 輸出結果：
* request.size()=2
response.size()=2
1.3.6.1.2.1.1.1.0 = Hardware: x86 Family 6 Model 58 Stepping 9 AT/AT COMPATIBLE - Software: Windows 2000 Version 5.1 (Build 2600 Multiprocessor Free)
1.3.6.1.2.1.1.2.0 = 1.3.6.1.4.1.311.1.1.3.1.1
*/
}
}catch(IOException e){
e.printStackTrace();
}
}
} 以上就是關於SNMP4J的簡單介紹和入門，後面的博文中將進行更加詳細的介紹。
來自 “ ITPUB部落格 ” ，連結：http://blog.itpub.net/9034054/viewspace-1974330/，如需轉載，請註明出處，否則將追究法律責任。
相關文章
- Snmp學習總結系列——開篇
- Snmp學習總結(二)——WinXP安裝和配置SNMP
- (七) Spring學習總結Spring
- 第七週學習總結
- ClickHouse學習系列之七【系統命令介紹】
- 七種網路卡繫結模式介紹模式
- 表示學習介紹
- C#總結（二）事件Event 介紹總結C#事件
- JavaScript學習總結（七）Ajax和HTTP狀態字JavaScriptHTTP
- Flutter 介紹 & 經驗總結Flutter
- MySQL 分割槽介紹總結MySql
- WebKit介紹及總結（一）WebKit
- dapr學習：dapr介紹
- Presto學習-presto介紹REST
- 前端學習（2375）：專案介紹結束前端
- 學習總結
- Graphql學習(一)-GraphQL介紹
- 整合學習入門介紹
- 元學習簡單介紹
- 學習python前言介紹Python
- QTreeView使用總結2，常用API介紹QTViewAPI
- RAID技術介紹和總結AI
- InnoDB學習（七）之索引結構索引
- mysqlimport學習總結MySqlImport
- Maven學習總結Maven
- MyBatis 學習總結MyBatis
- awk 學習總結
- JNI 學習總結
- tkinter學習總結
- SVG學習總結SVG
- vue學習總結Vue
- WorkFlow學習總結
- HTML學習總結HTML
- Mybatis學習總結MyBatis
- Kafka 總結學習Kafka
- Typescript學習總結TypeScript
- 【TS】學習總結
- lua 學習總結