Version 2.1 by Admin on 2018/12/12 14:15

Hide last authors
Admin 2.1 1 (% style="text-align: left;" %)
2 The differences between the two APIs are
3
4 1. the license model
5 1. the features
6
7 === License Model ===
8
9 The SNMP4J-SMI license is an user license intended for personal use for individuals (not for companies). Although the 1.x license covers also the usage for comany employees, this will be changed with the 2.0 release.
10
11 The SNMP4J-SMI-PRO license is a development site license for all employess at a specific company site (= postal address).
12
13 For both licenses, there are no runtime fees.
14
15 === Features ===
16
17 SNMP4J-SMI is designed for easy integration into SNMP4J and provides basic OID to object name and variable value to human readable string conversion based on (runtime) MIB information.
18
19 SNMP4J-SMI-PRO includes all features of SNMP4J-SMI plus full access to all MIB information, including description, object syntax, default values, etc.
20
21 (% class="wrapped" %)
22 |=(((
23 Functions (of the [[SmiManager>>url:http://www.snmp4j.org/smi/doc/com/snmp4j/smi/SmiManager.html||shape="rect"]] class)
24 )))|=(((
25 Description
26 )))|=(((
27 SNMP4J-SMI
28 )))|=(((
29 SNMP4J-SMI-PRO
30 )))
31 |(((
32 **[[compile>>url:http://www.snmp4j.org/smi/doc/com/snmp4j/smi/SmiManager.html#compile(java.io.File)||shape="rect"]]**[[File>>url:http://docs.oracle.com/javase/6/docs/api/java/io/File.html?is-external=true||title="class or interface in java.io" shape="rect"]]{{code language="none"}}( textOrZipFile){{/code}}
33
34 **[[compile>>url:http://www.snmp4j.org/smi/doc/com/snmp4j/smi/SmiManager.html#compile(com.snmp4j.smi.NamedInputStream)||shape="rect"]]**[[NamedInputStream>>url:http://www.snmp4j.org/smi/doc/com/snmp4j/smi/NamedInputStream.html||title="class in com.snmp4j.smi" shape="rect"]]{{code language="none"}}( mibFile){{/code}}{{code language="none"}}{{/code}}
35
36 **compile**[[NamedInputStream>>url:http://www.snmp4j.org/smi/doc/com/snmp4j/smi/NamedInputStream.html||shape="rect"]]
37 [[CompilationMonitor>>url:http://www.snmp4j.org/smi/doc/com/snmp4j/smi/CompilationMonitor.html||shape="rect"]]
38 [[SmiCompiler.TargetMode>>url:http://www.snmp4j.org/smi/doc/com/snmp4j/smi/SmiCompiler.TargetMode.html||shape="rect"]]
39 [[SmiCompiler.OverwriteMode>>url:http://www.snmp4j.org/smi/doc/com/snmp4j/smi/SmiCompiler.OverwriteMode.html||shape="rect"]]
40 [[SmiCompiler.Strictness>>url:http://www.snmp4j.org/smi/doc/com/snmp4j/smi/SmiCompiler.Strictness.html||shape="rect"]]{{code language="none"}}([] files,  compilationMonitor,  compilerTargetMode,  overwriteMode,  strictness){{/code}}{{code language="none"}}{{/code}}{{code language="none"}}{{/code}}
41 )))|(((
42 Compile one or more MIB specification files into the internal MIB repository (memory or persistent cache).
43 )))|(% style="text-align: center;" %)(% style="text-align: center;" %)
44 (((
45 [[image:https://doc.snmp.app/s/en_GB/7901/04c8b7bf0a5b4889210956b8230224e43d124b25/_/images/icons/emoticons/check.svg||title="(tick)" border="0" class="emoticon emoticon-tick"]]
46 )))|(% style="text-align: center;" %)(% style="text-align: center;" %)
47 (((
48 [[image:https://doc.snmp.app/s/en_GB/7901/04c8b7bf0a5b4889210956b8230224e43d124b25/_/images/icons/emoticons/check.svg||title="(tick)" border="0" class="emoticon emoticon-tick"]]
49 )))
50 |(((
51 **[[deleteModule>>url:file:///D:/source/svn/SNMP4J-SMI-PRO/target/site/apidocs/com/snmp4j/smi/SmiManager.html#deleteModule(java.lang.String, boolean)||shape="rect"]]**[[String>>url:http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true||title="class or interface in java.lang" shape="rect"]]
52
53 {{code language="none"}}
54 ( moduleName, boolean forceDeletion)
55 {{/code}}
56 )))|(((
57 Remove a MIB module from the internal MIB repository (cache)
58 )))|(% style="text-align: center;" %)(% style="text-align: center;" %)
59 (((
60 [[image:https://doc.snmp.app/s/en_GB/7901/04c8b7bf0a5b4889210956b8230224e43d124b25/_/images/icons/emoticons/check.svg||title="(tick)" border="0" class="emoticon emoticon-tick"]]
61 )))|(% style="text-align: center;" %)(% style="text-align: center;" %)
62 (((
63 [[image:https://doc.snmp.app/s/en_GB/7901/04c8b7bf0a5b4889210956b8230224e43d124b25/_/images/icons/emoticons/check.svg||title="(tick)" border="0" class="emoticon emoticon-tick"]]
64 )))
65 |(((
66 **[[listModules>>url:file:///D:/source/svn/SNMP4J-SMI-PRO/target/site/apidocs/com/snmp4j/smi/SmiManager.html#listModules()||shape="rect"]]**
67
68 {{code language="none"}}
69 ()
70 {{/code}}
71 )))|(((
72 List all available MIB modules in the internal MIB repository (cache)
73 )))|(% style="text-align: center;" %)(% style="text-align: center;" %)
74 (((
75 [[image:https://doc.snmp.app/s/en_GB/7901/04c8b7bf0a5b4889210956b8230224e43d124b25/_/images/icons/emoticons/check.svg||title="(tick)" border="0" class="emoticon emoticon-tick"]]
76 )))|(% style="text-align: center;" %)(% style="text-align: center;" %)
77 (((
78 [[image:https://doc.snmp.app/s/en_GB/7901/04c8b7bf0a5b4889210956b8230224e43d124b25/_/images/icons/emoticons/check.svg||title="(tick)" border="0" class="emoticon emoticon-tick"]]
79 )))
80 |(((
81 **[[loadModule>>url:file:///D:/source/svn/SNMP4J-SMI-PRO/target/site/apidocs/com/snmp4j/smi/SmiManager.html#loadModule(java.lang.String)||shape="rect"]]**[[String>>url:http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true||title="class or interface in java.lang" shape="rect"]]{{code language="none"}}( moduleName){{/code}}
82
83 **[[unloadModule>>url:http://www.snmp4j.org/smi/doc/com/snmp4j/smi/SmiManager.html#unloadModule(java.lang.String)||shape="rect"]]**[[String>>url:http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true||title="class or interface in java.lang" shape="rect"]]{{code language="none"}}( moduleName){{/code}}{{code language="none"}}{{/code}}
84 )))|(((
85 Load/unload a MIB module from the MIB repository into the SmiManager memory (i.e., activate a MIB module for usage by the API)
86 )))|(% style="text-align: center;" %)(% style="text-align: center;" %)
87 (((
88 [[image:https://doc.snmp.app/s/en_GB/7901/04c8b7bf0a5b4889210956b8230224e43d124b25/_/images/icons/emoticons/check.svg||title="(tick)" border="0" class="emoticon emoticon-tick"]]
89 )))|(% style="text-align: center;" %)(% style="text-align: center;" %)
90 (((
91 [[image:https://doc.snmp.app/s/en_GB/7901/04c8b7bf0a5b4889210956b8230224e43d124b25/_/images/icons/emoticons/check.svg||title="(tick)" border="0" class="emoticon emoticon-tick"]]
92 )))
93 |(((
94 **format**{{code language="none"}}(int[] value){{/code}}
95
96 **formatForRoundTrip**{{code language="none"}}(int[] value){{/code}}{{code language="none"}}{{/code}}
97
98 **[[format>>url:http://www.snmp4j.org/smi/doc/com/snmp4j/smi/SmiManager.html#format(org.snmp4j.smi.OID, org.snmp4j.smi.Variable, boolean)||shape="rect"]]**[[OID>>url:http://www.snmp4j.org/doc/org/snmp4j/smi/OID.html?is-external=true||title="class or interface in org.snmp4j.smi" shape="rect"]][[Variable>>url:http://www.snmp4j.org/doc/org/snmp4j/smi/Variable.html?is-external=true||title="class or interface in org.snmp4j.smi" shape="rect"]]{{code language="none"}}( instanceOID,  variable, boolean withOID){{/code}}
99 {{code language="none"}}{{/code}}{{code language="none"}}{{/code}}
100 )))|(((
101 Format an numeric OID value to a human readable object identifier with object name prefix.
102
103
104
105 Format a SNMP value to a human readable string using MIB information associated with the given OID.
106 )))|(% style="text-align: center;" %)(% style="text-align: center;" %)
107 (((
108
109
110 [[image:https://doc.snmp.app/s/en_GB/7901/04c8b7bf0a5b4889210956b8230224e43d124b25/_/images/icons/emoticons/check.svg||title="(tick)" border="0" class="emoticon emoticon-tick"]]
111 )))|(% style="text-align: center;" %)(% style="text-align: center;" %)
112 (((
113
114
115 [[image:https://doc.snmp.app/s/en_GB/7901/04c8b7bf0a5b4889210956b8230224e43d124b25/_/images/icons/emoticons/check.svg||title="(tick)" border="0" class="emoticon emoticon-tick"]]
116 )))
117 |(% colspan="1" %)(% colspan="1" %)
118 (((
119 **[[parse>>url:http://www.snmp4j.org/smi/doc/com/snmp4j/smi/SmiManager.html#parse(java.lang.String)||shape="rect"]]**[[String>>url:http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true||title="class or interface in java.lang" shape="rect"]]{{code language="none"}}( text){{/code}}
120
121 **[[parse>>url:http://www.snmp4j.org/smi/doc/com/snmp4j/smi/SmiManager.html#parse(int, java.lang.String)||shape="rect"]]**[[String>>url:http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true||title="class or interface in java.lang" shape="rect"]]{{code language="none"}}(int smiSyntax,  text){{/code}}
122
123 **[[parse>>url:http://www.snmp4j.org/smi/doc/com/snmp4j/smi/SmiManager.html#parse(org.snmp4j.smi.OID, java.lang.String)||shape="rect"]]**[[OID>>url:http://www.snmp4j.org/doc/org/snmp4j/smi/OID.html?is-external=true||title="class or interface in org.snmp4j.smi" shape="rect"]][[String>>url:http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true||title="class or interface in java.lang" shape="rect"]]{{code language="none"}}( classOrInstanceOID,  text){{/code}}{{code language="none"}}{{/code}}
124
125 **[[parseVariableBinding>>url:http://www.snmp4j.org/smi/doc/com/snmp4j/smi/SmiManager.html#parseVariableBinding(java.lang.String)||shape="rect"]]**[[String>>url:http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true||title="class or interface in java.lang" shape="rect"]]{{code language="none"}}( text){{/code}}{{code language="none"}} {{/code}}{{code language="none"}}{{/code}}
126 )))|(% colspan="1" %)(% colspan="1" %)
127 (((
128 Parse an OID string or variable string to an OID value and VariableBinding respectively.
129 )))|(% colspan="1" style="text-align: center;" %)(% colspan="1" style="text-align: center;" %)
130 (((
131
132
133 [[image:https://doc.snmp.app/s/en_GB/7901/04c8b7bf0a5b4889210956b8230224e43d124b25/_/images/icons/emoticons/check.svg||title="(tick)" border="0" class="emoticon emoticon-tick"]]
134 )))|(% colspan="1" %)(% colspan="1" %)
135 (((
136
137
138 (% style="text-align: center;" %)
139 [[image:https://doc.snmp.app/s/en_GB/7901/04c8b7bf0a5b4889210956b8230224e43d124b25/_/images/icons/emoticons/check.svg||title="(tick)" border="0" class="emoticon emoticon-tick"]]
140 )))
141 |(% colspan="1" %)(% colspan="1" %)
142 (((
143 **[[getIndexVariables>>url:http://www.snmp4j.org/smi/doc/com/snmp4j/smi/SmiManager.html#getIndexVariables(org.snmp4j.smi.OID, org.snmp4j.smi.OID)||shape="rect"]]**[[OID>>url:http://www.snmp4j.org/doc/org/snmp4j/smi/OID.html?is-external=true||title="class or interface in org.snmp4j.smi" shape="rect"]][[OID>>url:http://www.snmp4j.org/doc/org/snmp4j/smi/OID.html?is-external=true||title="class or interface in org.snmp4j.smi" shape="rect"]]
144
145 {{code language="none"}}
146 ( table,  index)
147 {{/code}}
148 )))|(% colspan="1" %)(% colspan="1" %)
149 (((
150 Gets the index Variable array for the sub-index values of a SNMP table from the given index OID (suffix).
151 )))|(% colspan="1" style="text-align: center;" %)(% colspan="1" style="text-align: center;" %)
152 (((
153 [[image:https://doc.snmp.app/s/en_GB/7901/04c8b7bf0a5b4889210956b8230224e43d124b25/_/images/icons/emoticons/check.svg||title="(tick)" border="0" class="emoticon emoticon-tick"]]
154 )))|(% colspan="1" style="text-align: center;" %)(% colspan="1" style="text-align: center;" %)
155 (((
156 [[image:https://doc.snmp.app/s/en_GB/7901/04c8b7bf0a5b4889210956b8230224e43d124b25/_/images/icons/emoticons/check.svg||title="(tick)" border="0" class="emoticon emoticon-tick"]]
157 )))
158 |(% colspan="1" %)(% colspan="1" %)
159 (((
160 **[[findSmiObject>>url:http://www.snmp4j.org/smi/doc/com/snmp4j/smi/SmiManager.html#findSmiObject(org.snmp4j.smi.OID)||shape="rect"]]**[[OID>>url:http://www.snmp4j.org/doc/org/snmp4j/smi/OID.html?is-external=true||title="class or interface in org.snmp4j.smi" shape="rect"]]{{code language="none"}}( oid){{/code}}
161
162 **[[findSmiObject>>url:http://www.snmp4j.org/smi/doc/com/snmp4j/smi/SmiManager.html#findSmiObject(java.lang.String, java.lang.String)||shape="rect"]]**[[String>>url:http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true||title="class or interface in java.lang" shape="rect"]][[String>>url:http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true||title="class or interface in java.lang" shape="rect"]]{{code language="none"}}( moduleName,  objectName){{/code}}
163 )))|(% colspan="1" %)(% colspan="1" %)
164 (((
165 Find and return the [[SmiObject>>url:http://www.snmp4j.org/smi/doc/com/snmp4j/smi/SmiObject.html||shape="rect"]] with the given object name in the given MIB module or by the given OID.
166 )))|(% colspan="1" %)(% colspan="1" %)
167 (((
168
169 )))|(% colspan="1" style="text-align: center;" %)(% colspan="1" style="text-align: center;" %)
170 (((
171 [[image:https://doc.snmp.app/s/en_GB/7901/04c8b7bf0a5b4889210956b8230224e43d124b25/_/images/icons/emoticons/check.svg||title="(tick)" border="0" class="emoticon emoticon-tick"]]
172 )))
173 |(% colspan="1" %)(% colspan="1" %)
174 (((
175 **[[findSmiModule>>url:http://www.snmp4j.org/smi/doc/com/snmp4j/smi/SmiManager.html#findSmiModule(java.lang.String)||shape="rect"]]**[[String>>url:http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true||title="class or interface in java.lang" shape="rect"]]
176
177 {{code language="none"}}
178 ( moduleName)
179 {{/code}}
180 )))|(% colspan="1" %)(% colspan="1" %)
181 (((
182 Find and return the [[SmiModule>>url:http://www.snmp4j.org/smi/doc/com/snmp4j/smi/SmiModule.html||shape="rect"]] with the specified name.
183 )))|(% colspan="1" %)(% colspan="1" %)
184 (((
185
186 )))|(% colspan="1" style="text-align: center;" %)(% colspan="1" style="text-align: center;" %)
187 (((
188 [[image:https://doc.snmp.app/s/en_GB/7901/04c8b7bf0a5b4889210956b8230224e43d124b25/_/images/icons/emoticons/check.svg||title="(tick)" border="0" class="emoticon emoticon-tick"]]
189 )))
190 |(% colspan="1" %)(% colspan="1" %)
191 (((
192 **[[findSmiObject>>url:http://www.snmp4j.org/smi/doc/com/snmp4j/smi/SmiManager.html#findSmiObject(java.lang.String, com.snmp4j.smi.SmiObjectFilter)||shape="rect"]]**[[String>>url:http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true||title="class or interface in java.lang" shape="rect"]][[SmiObjectFilter>>url:http://ww.snmp4j.org/smi/doc/com/snmp4j/smi/SmiObjectFilter.html||shape="rect"]]
193
194 {{code language="none"}}
195 ( moduleName, <S> filter)
196 {{/code}}
197
198
199 )))|(% colspan="1" %)(% colspan="1" %)
200 (((
201 Find a  [[SmiObject>>url:http://www.snmp4j.org/smi/doc/com/snmp4j/smi/SmiObject.html||shape="rect"]] by the given filter.
202 )))|(% colspan="1" %)(% colspan="1" %)
203 (((
204
205 )))|(% colspan="1" style="text-align: center;" %)(% colspan="1" style="text-align: center;" %)
206 (((
207 [[image:https://doc.snmp.app/s/en_GB/7901/04c8b7bf0a5b4889210956b8230224e43d124b25/_/images/icons/emoticons/check.svg||title="(tick)" border="0" class="emoticon emoticon-tick"]]
208 )))
209
210 (% class="auto-cursor-target" %)
211 \\