snmp4j学习笔记

SNMP会话类，该类是snmp4j的核心，提供发送/接收SNMP的PDU的功能。支持发送所有类型的PDU，支持异步、同步两种方式发送。

Snmp独立于具体的传输层协议，和传输层有关的工作由TransportMapping负责，有两种方式可以将Snmp关联到某种传输：

除了关联传输，还可以为Snmp指定消息分发器：

Snmp准备好后，需要启动监听，以便接收其它SNMP实体发送来的报文：

要发送SNMP报文，首先要构建目标（Taget），目标映射接收方SNMP实体：

然后，构建PDU，即需要发送的报文：

构建好PDU后，就可以通过同步（同步方式不支持广播消息）或者异步方式，将其发送给target了：

对于Manager角色，如果要接收来自Agent的trap，可以：

对于Agent角色，如果要接收来自Manger的请求，并做出应答，还是使用上面的CommandResponder：

最后，应当关闭会话和transport：

在TCP/IP协议族中，协议数据单元（Protocol Data Unit，PDU）表示使用某个协议的两个实体之间发送的报文，包括报文头和报文体。由于TCP/IP协议族是分层结构，因而下层协议PDU的载荷部分，就是上层协议的PDU。

在SNMP协议的报文头中，具有一个字段“PDU类型”，可以理解为报文的类型。

snmp4j使用该类构建SNMP协议报文。该类实现了BERSerializable接口，后者定义了如何将ASN.1数据类型串行化为BER格式的方法。

PDU类定义了以下常量，来代表SNMP报文类型：

1. GET：get-request报文
2. GETNEXT：get-next-response报文
3. RESPONSE：get-response、set-response报文
4. SET：set-request报文
5. V1TRAP：SNMPv1的trap报文
6. GETBULK：SNMPv2c/v3的get-bulk-request报文
7. INFORM：SNMPv2c/v3的inform报文
8. TRAP：SNMPv2c/v3的trap报文
9. NOTIFICATION：SNMPv2c/v3的notification报文
10. REPORT：SNMPv3的report报文

PDU类提供以下重要方法：

1. add()、addAll()：把变量绑定添加到当前PDU
2. addOID()、addAllOIDs()：把变量绑定添加到当前PDU，只添加变量名（OID），值置NULL
3. get()：得到当前PDU指定索引上的变量绑定
4. set()：设置当前PDU指定索引上的变量绑定
5. remove()：移除当前PDU指定索引上的变量绑定
6. clear()：移除所有变量绑定，设置请求ID为0，可以用来重用PDU对象
7. size()：当前PDU包含的变量绑定的个数
8. getVariableBindings()：得到所有变量绑定的集合
9. trim()：移除最后一个变量绑定，如果至少存在一个绑定
10. setErrorStatus()：设置PDU的错误状态字段
11. setErrorIndex()：设置PDU的错误索引，1表示第一个变量绑定存在错误
12. isConfirmedPdu()：判断该PDU是否是需要确认的PDU（非report、trap、response）
13. setType()：设置PDU类型
14. setRequestID()：设置请求ID，如果设置为0或者空，发送时消息处理模型自动生成

 PDU包含以下子类型：

1. PDUv1：表示SNMPv1的PDU
2. ScopedPDU：表示SNMPv3的scoped PDU

注意对于SNMPv2c，直接使用PDU类

下面的代码示例了如何创建一个SNMPv3的PDU：

目标，该接口代表远程（即对端）SNMP实体（Manager、Agent）。定义了以下方法：

1. setAddress()：设置目标的地址
2. setVersion()：设置目标的SNMP版本号（org.snmp4j.mp.SnmpConstants）
3. setRetries()：设置请求超时前重试的次数
4. setTimeout()：设置请求超时的毫秒数
5. setMaxSizeRequestPDU()：目标支持的最大PDU长度
6. 对应的getter方法

该接口的缺省实现是AbstractTarget，并且包含几个子类型，这些子类型是按照安全性特征划分的：

1. CommunityTarget：SNMPv1、SNMPv2c的基于团体名的消息处理模型的目标
2. SecureTarget：与安全模型独立的目标超类，用来支持安全的SNMP通信。包含子类
   1. UserTarget：用于SNMPv3的，基于用户的目标

下面是创建目标的样例代码：

应答事件类，该类继承了JDK的观察者模式组件。应答事件将一个请求PDU和它的响应，以及一个可选的用户对象进行关联。它提供以下方法：

1. getRequest()：得到请求PDU
2. getResponse()：得到响应PDU
3. getUserObject()：对于异步请求，可读写一个可选的用户自定义对象
4. getError()：如果请求PDU处理出错，可以从中得到异常对象
5. getPeerAddress()：得到对端的地址，即应答发送方的地址

下面的代码示例如何使用该类：

这是一个回调接口，实现它可以异步的处理应答PDU：

该事件由MessageDispatcher负责分发，相应的CommandResponder会接收到并处理与该事件关联的request、report、trap/notification类型的PDU。

该类提供以下方法：

1. getSecurityModel()：得到使用的安全模型
2. getSecurityLevel()：得到安全级别
3. getPDU()：得到PDU
4. isProcessed()：事件是否已经被处理
5. getPeerAddress()：得到对端SNMP实体的地址

该接口用来处理入站request、report、notification(trap)类型的PDU：

消息分发器接口，处理incoming消息并将消息分发给感兴趣的CommandResponder，同时支持发送outgoing消息。

消息分发器至少需要一个TransportMapping、一个MessageProcessingModel对象，以支持处理任何消息。该接口包含两个实现类：

1. MessageDispatcherImpl：使用MessageProcessingModel解码、分发incoming消息；或者使用适当的TransportMapping来编码、发送outgoing消息
2. MultiThreadedMessageDispatcher：MessageDispatcher的装饰器，用来提供多线程并行处理的支持

该接口对SNMP协议支持的地址类型进行抽象：

该接口定义了传输机制，传输机制是Snmp使用的某种传输层协议的支持。常用的实现为：DefaultTcpTransportMapping、DefaultUdpTransportMapping，分别代表TCP、UDP传输。该接口定义了以下重要方法：

1. sendMessage()：使用该传输发送消息到某一地址
2. add/removeTransportListener()：添加或删除传输监听器。一般至少有一个传输监听器被配置，以接收incoming消息
3. listen()：启动监听，等待incoming消息的到来
4. close()：关闭该传输，并释放相关的资源

定义传输机制时，可以指定它的监听地址和端口：

该接口定义了一个方法：processMessage()，用来处理incoming消息，该接口由Snmp4j负责回调

消息处理模型的通用方法定义：

1. getID()：得到消息处理模型的数字常量ID
2. prepareOutgoingMessage()：准备一个RFC3412出站消息
3. prepareResponseMessage()：准备一个RFC3412应答消息
4. prepareDataElements()：准备处理来自RFC3412入站消息的数据元素
5. isProtocolVersionSupported()：检查某个SNMP协议是否被当前模型支持

具体实现类包括：
MPv1为SNMPv1的消息处理模型
MPv2c为SNMPv2c的消息处理模型
MPv3为SNMPv3的消息处理模型

管理SNMP实体支持的所有的身份验证和隐私协议，单例。定义了以下方法：

1. addDefaultProtocols()：添加默认安全协议
2. addAuthenticationProtocol()：添加身份验证协议
3. getAuthenticationProtocol()：根据OID得到某个身份验证协议
4. removeAuthenticationProtocol()：移除某个身份验证协议
5. add/get/removePrivacyProtocol：添加、得到、删除某个隐私（加解密）协议

为所有SNMP身份验证协议定义统一接口

管理SNMP实体支持的所有安全模型，单例。定义了以下方法：

1. addSecurityModel()：添加一个安全模型
2. removeSecurityModel()：移除一个安全模型
3. getSecurityModel()：得到一个安全模型

该接口映射RFC3411定义的安全模型。该接口定义了以下安全模型ID常量：

SECURITY_MODEL_ANY = 0   
SECURITY_MODEL_SNMPv1 = 1
SECURITY_MODEL_SNMPv2c = 2
SECURITY_MODEL_USM = 3

以及以下方法：

1. getID()：获得当前安全模型的ID
2. newSecurityParametersInstance()：创建一个与当前模型匹配的安全参数实例
3. generateRequestMessage()：依据消息处理模型、安全参数、消息载荷来创建一个请求消息
4. generateResponseMessage()：创建应答消息
5. processIncomingMsg()：处理入站消息

该接口包含一个实现类：USM，对应RFC3414定义的基于用户的安全模型（User Based Security Model）。下面的代码示例了该安全模型的使用方法：

该接口映射SNMP管理信息结构（SMI）定义的数据类型，包含了一个实现类AbstractVariable，后者有以下子类：

OID是一种特殊的Variable，代表对象标识符（不是实例标识符）

即变量名、值对，变量名即OID，变量值即Variable

该类定义了一个框架，用户可以扩展它、覆盖其中的抽象方法来创建SNMP代理。该类定义了以下必须扩展点（抽象方法）：

1. registerManagedObjects()：注册该代理管理的额外对象
2. unregisterManagedObjects()：解除注册该代理管理的额外对象
3. addUsmUser(USM usm)：添加所有必须的初始用户到安全模型中
4. addNotificationTargets(SnmpTargetMIB, SnmpNotificationMIB)：添加初始的notification目标和过滤器。SnmpTargetMIB提供Target的配置，SnmpNotificationMIB提供notification的配置
5. addViews(VacmMIB)：添加初始的VACM配置。VacmMIB持有代理的视图配置
6. addCommunities(SnmpCommunityMIB)：添加SNMPv1、SNMPv2c的团体名映射

该类还定义了以下可选扩展点（受保护的钩子）：

1. initConfigMIB()：初始化配置MIB
2. getContext(MOGroup)：子类覆盖后，可以指定每个MIB模块（组）被注册到的上下文
3. registerSnmpMIBs()：为代理的MOServer注册基本的MIB模块
4. unregisterSnmpMIBs()：解除注册基本的MIB模块
5. setupDefaultProxyForwarder()：创建并注册默认的代理转发器程序（proxy forwarder application）
6. addShutdownHook()：添加JRE标准的关闭钩子，钩子在收到SIGTERM信号后执行
7. finishInit()：完成代理的初始化，默认实现将：连接服务和命令处理器（CommandProcessor）、设立USM、VACM、通知目标。并最终发送coldStart消息给通知目标
8. sendColdStartNotification()：发送冷启动通知给通知目标
9. initMessageDispatcher()：初始化消息分发器
10. initSnmpSession()：初始化SNMP会话
11. updateSession(Session)：为一个会话更新所有对象，如果子类创建了非默认的SNMP MIB实例，必须覆盖此方法
12. updateEngineBoots()：更新引起启动次数计数器
13. initTransportMappings()：初始化该代理使用的传输机制

受管对象服务器，负责管理注册的ManagedObject，该接口定义了受管对象仓库必须提供给CommandResponder的服务。包含以下方法：

1. addContextListener(ContextListener)：添加上下文监听器，当上下文被添加或者删除，监听器会被通知
2. removeContextListener(ContextListener)：移除上下文监听器
3. addContext(OctetString)：添加上下文到服务器
4. removeContext(OctetString)：移除上下文
5. register(ManagedObject, OctetString)：为指定上下文注册一个受管对象，一个受管对象可以注册到多个上下文。如果第二个参数为null，则注册到所有上下文（包括默认上下文）
6. unregister(ManagedObject, OctetString)：解除注册受管对象
7. addLookupListener()：添加查找监听器，lookup调用返回前，监听器被通知
8. removeLookupListener()：移除查找监听器
9. lookup(MOQuery)：查找第一个（字典序）匹配的受管对象
10. iterator()：返回一个迭代器，以迭代该服务器上的内容
11. lock(Object, ManagedObject)：锁定一个对象，对其进行lookup将阻塞直到解锁或超时
12. unlock(Object, ManagedObject)：解锁一个对象
13. getContexts()：获得所有上下文
14. isContextSupported(OctetString)：是否支持指定上下文

受管对象组，表示一组ManagedObject，可以通过 registerMOs(MOServer server, OctetString context) 注册到MOServer。该接口实际上对应了管理信息库（MIB）对象。包含以下实现（其中MOGroupImpl是一个简单的实现，StaticMOGroup则可以用来轻松的实现静态、只读受管对象组）：

通知源，实现该接口的对象负责发送notification，它定义了一个方法：

BaseAgent使用的一个实现了CommandResponder、NotificationOriginator的粘合剂类，负责处理请求、发送通知