# MibBrowser Class

The MIBBrowser class is used to parse SNMP MIB Module definitions.

## Syntax

```text
ipworkssnmp.MibBrowser
```

## Remarks

The MIBBrowser class allows easy loading and querying of definitions in the SNMP Management Information Base (MIB) specifications.

The [LoadMib](#loadmib-method-mibbrowser-class) method allows loading of MIB modules, which get stored in an internal tree structure for further queries.

If modules reference (import) other modules, recursive loading of modules is performed automatically and/or controlled by the [ImportSymbols](#importsymbols-event-mibbrowser-class) event.

The MIB tree is navigated through the [SelectNode](#selectnode-method-mibbrowser-class) method, which enables pointing to a node in the tree specified by [NodeOid](#nodeoid-property-mibbrowser-class) and [NodeLabel](#nodelabel-property-mibbrowser-class). Other node information is provided through the [NodeModuleName](#nodemodulename-property-mibbrowser-class), [NodeFileName](#nodefilename-property-mibbrowser-class), [NodeSyntax](#nodesyntax-property-mibbrowser-class), [NodeType](#nodetype-property-mibbrowser-class), and [NodeAccess](#nodeaccess-property-mibbrowser-class) properties.

The node selector parameter in [SelectNode](#selectnode-method-mibbrowser-class) can be a label such as "internet", an OID such as "1.3.6.4", a combination of the two: "iso.3.dod.internet", or a label in a particular module such as "RFC1213-MIB!interfaces".

Node children and successors are provided by the [ListChildren](#listchildren-method-mibbrowser-class) and [ListSuccessors](#listsuccessors-method-mibbrowser-class) methods. The individual node information is provided via the [MibNode](#mibnode-event-mibbrowser-class) event.

Module traps are listed via the [ListTraps](#listtraps-method-mibbrowser-class) method. The individual trap information is provided through the [TrapNode](#trapnode-event-mibbrowser-class) event.

## Property List

*The following is the full list of the properties of the class with short descriptions. Click on the links for further details.*

|  |  |
| --- | --- |
| [ExactMatch](#exactmatch-property-mibbrowser-class) | Controls the way the OID matching is done (complete or partial). |
| [NodeAccess](#nodeaccess-property-mibbrowser-class) | The access permissions for the selected node. |
| [NodeDescription](#nodedescription-property-mibbrowser-class) | Textual description of the selected node. |
| [NodeFileName](#nodefilename-property-mibbrowser-class) | The absolute path of the file where the selected node is declared. |
| [NodeFullLabel](#nodefulllabel-property-mibbrowser-class) | The full label of the selected node. |
| [NodeIndex](#nodeindex-property-mibbrowser-class) | The index of the node in a table. |
| [NodeLabel](#nodelabel-property-mibbrowser-class) | The label of the selected node. |
| [NodeModuleName](#nodemodulename-property-mibbrowser-class) | The name of the module where the selected node is declared. |
| [NodeOid](#nodeoid-property-mibbrowser-class) | The Object ID of the selected node. |
| [NodeSubId](#nodesubid-property-mibbrowser-class) | The SubId of the currently selected node. |
| [NodeSyntax](#nodesyntax-property-mibbrowser-class) | The syntax of the selected node. |
| [NodeSyntaxString](#nodesyntaxstring-property-mibbrowser-class) | The node syntax of the selected node in text format. |
| [NodeType](#nodetype-property-mibbrowser-class) | The type of the selected node. |
| [NodeTypeString](#nodetypestring-property-mibbrowser-class) | The node type of the selected node in text format. |

## Method List

*The following is the full list of the methods of the class with short descriptions. Click on the links for further details.*

|  |  |
| --- | --- |
| [Config](#config-method-mibbrowser-class) | Sets or retrieves a configuration setting. |
| [ListChildren](#listchildren-method-mibbrowser-class) | Lists the immediate children of the selected node. |
| [ListSuccessors](#listsuccessors-method-mibbrowser-class) | Lists all successors of the selected node. |
| [ListTraps](#listtraps-method-mibbrowser-class) | Lists all the traps defined in the loaded modules. |
| [LoadMib](#loadmib-method-mibbrowser-class) | Parses the file FileName and adds the parsed nodes to the collection of existing nodes. |
| [Reset](#reset-method-mibbrowser-class) | Reset all properties of the class. |
| [SelectNode](#selectnode-method-mibbrowser-class) | Used to select individual nodes in the loaded MIB module(s). |

## Event List

*The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.*

|  |  |
| --- | --- |
| [Error](#error-event-mibbrowser-class) | Errors that occur while loading/parsing MIB modules are fired through this event. |
| [ImportSymbols](#importsymbols-event-mibbrowser-class) | List of imported symbols and the respective modules where they are declared. |
| [MibNode](#mibnode-event-mibbrowser-class) | This event fires once for every child or successor of the currently selected node when invoking ListChildren or ListSuccessors . |
| [TrapNode](#trapnode-event-mibbrowser-class) | Lists module trap information. |

## Config Settings

*The following is a list of config settings for the class with short descriptions. Click on the links for further details.*

|  |  |
| --- | --- |
| [AutoLoadMibs](#AutoLoadMibs) | Determines whether imported MIB modules are loaded automatically. |
| [CacheDescriptions](#CacheDescriptions) | Controls caching of Node descriptions. |
| [CacheMibs](#CacheMibs) | Controls MIB module caching. |
| [CheckNoKnownRoots](#CheckNoKnownRoots) | Controls whether or not the class fails when a file with no known root is loaded. |
| [DisplayHint](#DisplayHint) | The DISPLAY-HINT property for the current node. |
| [MibExtensions](#MibExtensions) | Controls the file extensions that the class will search for. |
| [NodeIsColumnar](#NodeIsColumnar) | Whether the current node is columnar. |
| [NodeIsScalar](#NodeIsScalar) | Whether the current node is scalar. |
| [ReturnEnumValues](#ReturnEnumValues) | Comma-separated list of the current node's enumeration textual-conventions. |
| [UndefinedSymbols](#UndefinedSymbols) | Comma-separated list of nodes that have not been resolved. |
| [BuildInfo](#BuildInfo) | Information about the product's build. |
| [GUIAvailable](#GUIAvailable) | Whether or not a message loop is available for processing events. |
| [LicenseInfo](#LicenseInfo) | Information about the current license. |
| [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. |
| [UseDaemonThreads](#UseDaemonThreads) | Whether threads created by the class are daemon threads. |
| [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. |
| [UseVirtualThreads](#UseVirtualThreads) | Whether threads created by the class use virtual threads instead of platform threads. |

# ExactMatch Property ([MibBrowser](#mibbrowser-class) Class)

Controls the way the OID matching is done (complete or partial).

## Syntax

```text
public boolean isExactMatch();
public void setExactMatch(boolean exactMatch);
```

## Default Value

True

## Remarks

If ExactMatch is set to True, the [SelectNode](#selectnode-method-mibbrowser-class) method will try to find an exact match for the supplied selector. If not found, an exception will be thrown.

If ExactMatch is set to False, the [SelectNode](#selectnode-method-mibbrowser-class) method will start from the root (iso) and will go as far as it can, finding the closest match for the requested node.

For instance, in SNMPv2-MIB sysUpTime is defined as "1.3.6.1.2.1.1.3". If ExactMatch is False, calling [SelectNode](#selectnode-method-mibbrowser-class) with selector "1.3.6.1.2.1.1.3.0" will populate [NodeLabel](#nodelabel-property-mibbrowser-class) with "sysUpTime.0" while the same call with ExactMatch set to True will fail since that exact OID is not defined in the MIB.

# NodeAccess Property ([MibBrowser](#mibbrowser-class) Class)

The access permissions for the selected node.

## Syntax

```text
public int getNodeAccess();

Enumerated values:
  public final static int accUnknown = 0;
  public final static int accNoAccess = 1;
  public final static int accReadOnly = 2;
  public final static int accReadCreate = 3;
  public final static int accReadWrite = 4;
  public final static int accWriteOnly = 5;
  public final static int accForNotify = 6;
```

## Default Value

0

## Remarks

The following is the list of values for NodeAccess:

|  |  |
| --- | --- |
| 0 | accUnknown |
| 1 | accNoAccess |
| 2 | accReadOnly |
| 3 | accReadCreate |
| 4 | accReadWrite |
| 5 | accWriteOnly |
| 6 | accForNotify |

This property is read-only.

# NodeDescription Property ([MibBrowser](#mibbrowser-class) Class)

Textual description of the selected node.

## Syntax

```text
public String getNodeDescription();
```

## Default Value

""

## Remarks

Because loading descriptions can consume unwanted resources, the class can control caching of descriptions in order to keep the memory footprint of the class as small as possible.

To disable caching, set the [CacheDescriptions](#CacheDescriptions) config setting to True. In this case, the class will only save the offset of the description in the MIB file in memory, and will fetch the textual description directly from the file only when required. When using caching, make sure that the path of the loaded modules does not change or the property will be unable to fetch the correct text description.

This property is read-only.

# NodeFileName Property ([MibBrowser](#mibbrowser-class) Class)

The absolute path of the file where the selected node is declared.

## Syntax

```text
public String getNodeFileName();
```

## Default Value

""

## Remarks

It is possible for a node to be re-declared in other modules. In this case the property contains a comma separated list of file names where the selected node is declared.

This property is read-only.

# NodeFullLabel Property ([MibBrowser](#mibbrowser-class) Class)

The full label of the selected node.

## Syntax

```text
public String getNodeFullLabel();
```

## Default Value

""

## Remarks

This contains the full label of the Oid of the selected node. It is unique within the MIB module where it is declared.

This property is read-only.

# NodeIndex Property ([MibBrowser](#mibbrowser-class) Class)

The index of the node in a table.

## Syntax

```text
public String getNodeIndex();
```

## Default Value

""

## Remarks

If the selected node has *stxSequence* syntax then the **NodeIndex** represents the column used to distinguish among different table rows.

**Example:**

```text
MibParser.LoadMib(""SNMPv2-MIB"")
MibParser.SelectNode("1.3.6.1.2.1.2.2")
Debug.Print MibParser1.NodeLabel // prints "ifTable"

MibParser.SelectNode("1.3.6.1.2.1.2.2.1")
Debug.Print MibParser1.NodeLabel  // prints "ifEntry"
Debug.Print MibParser1.NodeIndex  // prints "ifIndex"
```

This property is read-only.

# NodeLabel Property ([MibBrowser](#mibbrowser-class) Class)

The label of the selected node.

## Syntax

```text
public String getNodeLabel();
```

## Default Value

"iso"

## Remarks

This label is unique within the MIB module where it is declared.

This property is read-only.

# NodeModuleName Property ([MibBrowser](#mibbrowser-class) Class)

The name of the module where the selected node is declared.

## Syntax

```text
public String getNodeModuleName();
```

## Default Value

""

## Remarks

It is possible for a node to be redeclared in other modules. In this case the NodeModuleName contains a comma separated list of module names where the selected node is declared.

This property is read-only.

# NodeOid Property ([MibBrowser](#mibbrowser-class) Class)

The Object ID of the selected node.

## Syntax

```text
public String getNodeOid();
```

## Default Value

"1"

## Remarks

Contains the Object Id (OID) of the currently selected node. The OID uniquely identifies the selected node within the entire object hierarchy.

This property is read-only.

# NodeSubId Property ([MibBrowser](#mibbrowser-class) Class)

The SubId of the currently selected node.

## Syntax

```text
public int getNodeSubId();
```

## Default Value

1

## Remarks

For instance, if you select the node "dod" in "rfc1155.smi", the NodeSubId value will be 6.

This property is read-only.

# NodeSyntax Property ([MibBrowser](#mibbrowser-class) Class)

The syntax of the selected node.

## Syntax

```text
public int getNodeSyntax();

Enumerated values:
  public final static int stxBoolean = 1;
  public final static int stxInteger = 2;
  public final static int stxBitString = 3;
  public final static int stxOctetString = 4;
  public final static int stxNull = 5;
  public final static int stxObjectId = 6;
  public final static int stxEnumerated = 10;
  public final static int stxSequenceOf = 15;
  public final static int stxSequence = 16;
  public final static int stxSet = 17;
  public final static int stxChoice = 18;
  public final static int stxNetworkAddress = 21;
  public final static int stxIpAddress = 64;
  public final static int stxCounter = 65;
  public final static int stxGauge = 66;
  public final static int stxTimeTicks = 67;
  public final static int stxOpaque = 68;
  public final static int stxNSAP = 69;
  public final static int stxCounter64 = 70;
  public final static int stxUInteger = 71;
  public final static int stxUnknown = 59;
```

## Default Value

6

## Remarks

The syntax defines what type of data the selected node contains. Common data types include:

|  |  |
| --- | --- |
| Boolean (1) | Boolean variable. |
| Integer (2) | A 32-bit signed integer. |
| OctetString (4) | An octet string variable that is binary or textual data. |
| Null (5) | NULL value. |
| ObjectId (6) | Object identifier. |
| IpAddress (64) | A 32-bit Internet address (aaa.bbb.ccc.ddd) |
| Counter (65) | A counter that increases until it reaches a maximum value of (2^32). |
| Gauge (66) | A non-negative int that can increase or decrease, but never exceed a maximum value. |
| TimeTicks (67) | A counter that measures time in hundredths of a second. |
| Opaque (68) | This type supports the capability to pass ASN.1 syntax. |
| Counter64 (70) | A counter that increases until it reaches a maximum value of (2^64). |
| UInteger (71) | A 32-bit unsigned integer. |

Additional type definitions can be found in the SNMP RFC's.

This property is read-only.

# NodeSyntaxString Property ([MibBrowser](#mibbrowser-class) Class)

The node syntax of the selected node in text format.

## Syntax

```text
public String getNodeSyntaxString();
```

## Default Value

""

## Remarks

For instance, for the node "system" in "SNMPv2-MIB", [NodeSyntax](#nodesyntax-property-mibbrowser-class) returns 6 (*stxObjectId*), while NodeSyntaxString returns "OBJECT IDENTIFIER".

This property is read-only.

# NodeType Property ([MibBrowser](#mibbrowser-class) Class)

The type of the selected node.

## Syntax

```text
public int getNodeType();

Enumerated values:
  public final static int mcrObjectType = 0;
  public final static int mcrObjectIdentity = 1;
  public final static int mcrModuleIdentity = 2;
  public final static int mcrNotificationType = 3;
  public final static int mcrTrapType = 4;
  public final static int mcrObjectGroup = 5;
  public final static int mcrNotificationGroup = 6;
  public final static int mcrCompliance = 7;
  public final static int mcrCapabilities = 8;
```

## Default Value

1

## Remarks

The following are the possible values for NodeType:

|  |  |
| --- | --- |
| 0 | mcrObjectType |
| 1 | mcrObjectIdentity |
| 2 | mcrModuleIdentity |
| 3 | mcrNotificationType |
| 4 | mcrTrapType |
| 5 | mcrObjectGroup |
| 6 | mcrNotificationGroup |
| 7 | mcrCompliance |
| 8 | mcrCapabilities |

This property is read-only.

# NodeTypeString Property ([MibBrowser](#mibbrowser-class) Class)

The node type of the selected node in text format.

## Syntax

```text
public String getNodeTypeString();
```

## Default Value

"OBJECT IDENTITY"

## Remarks

For instance, for the node "system" in "SNMPv2-MIB", [NodeType](#nodetype-property-mibbrowser-class) returns 2 (*mcrObjectIdentity*), while NodeTypeString returns "OBJECT-IDENTITY".

This property is read-only.

# Config Method ([MibBrowser](#mibbrowser-class) Class)

Sets or retrieves a configuration setting.

## Syntax

```text
public String config(String configurationString);
```

## Remarks

Config is a generic method available in every class. It is used to set and retrieve [configuration settings](#config-settings-mibbrowser-class) for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these *internal properties* is provided through the Config method.

To set a configuration setting named *PROPERTY*, you must call *Config("PROPERTY=VALUE")*, where *VALUE* is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a [configuration setting](#config-settings-mibbrowser-class), you must call *Config("PROPERTY")*. The value will be returned as a string.

# ListChildren Method ([MibBrowser](#mibbrowser-class) Class)

Lists the immediate children of the selected node.

## Syntax

```text
public void listChildren();
```

## Remarks

The [MibNode](#mibnode-event-mibbrowser-class) event fires once for every SubId of the selected node and provides all info related to that SubId.

For instance, the following code:

```text
MibParser.LoadMib("RFC1155-SMI")
MibParser.SelectNode("internet")
MibParser.ListChildren()
```

 will generate the following output through the [MibNode](#mibnode-event-mibbrowser-class) event:

```text
  directory    1.3.6.1.1
  mgmt         1.3.6.1.2
  experimental 1.3.6.1.3
  private      1.3.6.1.4
```

# ListSuccessors Method ([MibBrowser](#mibbrowser-class) Class)

Lists all successors of the selected node.

## Syntax

```text
public void listSuccessors();
```

## Remarks

The [MibNode](#mibnode-event-mibbrowser-class) event fires once for each successor of the selected node and provides all information related to it.

# ListTraps Method ([MibBrowser](#mibbrowser-class) Class)

Lists all the traps defined in the loaded modules.

## Syntax

```text
public void listTraps();
```

## Remarks

The [TrapNode](#trapnode-event-mibbrowser-class) event fires once for every trap and provides all info related to it.

For instance, the following code:

```text
MibParser.LoadMib("mib_ii.mib")
MibParser.ListTraps()
```

 will generate the following output through the [TrapNode](#trapnode-event-mibbrowser-class) event:

```text
  coldStart             0 snmp
  warmStart             1 snmp
  linkDown              2 snmp
  linkUp                3 snmp
  authenticationFailure 4 snmp
```

# LoadMib Method ([MibBrowser](#mibbrowser-class) Class)

Parses the file FileName and adds the parsed nodes to the collection of existing nodes.

## Syntax

```text
public void loadMib(String fileName);
```

## Remarks

This method can be used to load and parse a MIB file into the class.

Some MIB modules contain references to other modules within their imports sections. When loading a MIB that contains external imports, the [ImportSymbols](#importsymbols-event-mibbrowser-class) event will fire for each external reference. These modules must be loaded if possible to generate a complete representation for the loaded MIB.

It is possible for the component to attempt to load all external references automatically. To do this, use [Config](#config-method-mibbrowser-class) and set "*AutoLoadMibs=True*". Setting this configuration property causes the class to attempt to find and load any external references included in the current MIB. The class will only find external modules if they reside in the same directory as the current module. Alternatively, the class can load additional modules by calling LoadMib while inside the [ImportSymbols](#importsymbols-event-mibbrowser-class) event.

If the [AutoLoadMibs](#AutoLoadMibs) config setting is set to False, and no explicit action is taken to load necessary modules inside the [ImportSymbols](#importsymbols-event-mibbrowser-class) event, some symbols may remain unresolved. These symbols will not appear in the MibNode hierarchy until the module containing their definition is loaded. Order is unimportant when loading additional MIB modules. A complete list of unresolved symbols can be found by retrieving the [UndefinedSymbols](#UndefinedSymbols) config setting (separated by "\r\n").

Note that *FileName* also accepts MIB data. If MIB data is used, the class will expect the NodeFileName to be at the beginning of the string, surrounded by "[]". For example:

```text
[RFC-1215]RFC-1215 DEFINITIONS ::= BEGIN......END
```

# Reset Method ([MibBrowser](#mibbrowser-class) Class)

Reset all properties of the class.

## Syntax

```text
public void reset();
```

## Remarks

This method resets all of the node properties as well as the internal collection of parsed nodes.

# SelectNode Method ([MibBrowser](#mibbrowser-class) Class)

Used to select individual nodes in the loaded MIB module(s).

## Syntax

```text
public void selectNode(String selector);
```

## Remarks

SelectNode is used for selecting individual nodes and should be called before querying node information.

The *Selector* parameter can be a label such as "internet", an OID such as "1.3.6.4", a combination of the two: "iso.3.dod.internet", or a label in a particular module such as "RFC1213-MIB!interfaces".

Either '.' or ':' can be used to separate SubIds. If a SubId starts with "0x" or follows the ":" separator then its hexadecimal value is used. For instance, "0x1.0x3.0x6.0x1A" is the same as "1:3:6:1A".

All properties and methods of the class will operate on the selected node. For example, calling [ListSuccessors](#listsuccessors-method-mibbrowser-class) will only list the successors of the selected node.

# Error Event ([MibBrowser](#mibbrowser-class) Class)

Errors that occur while loading/parsing MIB modules are fired through this event.

## Syntax

```text
public class DefaultMibBrowserEventListener implements MibBrowserEventListener {
  ...
  public void error(MibBrowserErrorEvent e) {}
  ...
}

public class MibBrowserErrorEvent {
  public int errorCode;
  public String description;
}
```

## Remarks

*ErrorCode* contains an error code and *Description* contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the [Error Codes](#trappable-errors-mibbrowser-class) section.

# ImportSymbols Event ([MibBrowser](#mibbrowser-class) Class)

List of imported symbols and the respective modules where they are declared.

## Syntax

```text
public class DefaultMibBrowserEventListener implements MibBrowserEventListener {
  ...
  public void importSymbols(MibBrowserImportSymbolsEvent e) {}
  ...
}

public class MibBrowserImportSymbolsEvent {
  public String symbols;
  public String moduleName;
}
```

## Remarks

The *Symbols* parameter is a comma separated list of all symbols that must be imported from *ModuleName*.

The module is loaded through the [LoadMib](#loadmib-method-mibbrowser-class) method.

# MibNode Event ([MibBrowser](#mibbrowser-class) Class)

This event fires once for every child or successor of the currently selected node when invoking ListChildren or ListSuccessors .

## Syntax

```text
public class DefaultMibBrowserEventListener implements MibBrowserEventListener {
  ...
  public void mibNode(MibBrowserMibNodeEvent e) {}
  ...
}

public class MibBrowserMibNodeEvent {
  public String nodeLabel;
  public String nodeOid;
  public int nodeType;
  public String nodeTypeString;
  public int nodeSyntax;
  public String nodeSyntaxString;
  public int nodeAccess;
  public String nodeIndex;
  public String nodeParentName;
  public String nodeDescription;
  public String nodeModuleName;
  public String nodeFileName;
}
```

## Remarks

When calling either [ListChildren](#listchildren-method-mibbrowser-class) or [ListSuccessors](#listsuccessors-method-mibbrowser-class), the MibNode event will fire once for every child of the currently selected node. The [ListChildren](#listchildren-method-mibbrowser-class) method will cause the event will fire once for each of the immediate children of the current node. [ListSuccessors](#listsuccessors-method-mibbrowser-class) cause this event to fire for each of the immediate children of the current node, as well as the entire tree of successors of those children.

*NodeLabel* is the name or textual representation of the current node, and is unique to its siblings. The *NodeOid* is the OID of the listed node and uniquely identifies the node within the entire MIB. The remaining parameters offer additional information about the listed node.

Information about the listed node is only available through the **MibNode** event parameters. All class properties remain related to the currently selected node.

If a MibNode is declared in more than one file or module, then the *NodeFileName* and *NodeModuleName* parameters will contain a comma separated list of files/modules where the node is declared.

For instance, the following code:

```text
MibParser.LoadMib("RFC1155-SMI")
MibParser.SelectNode("internet") // OID 1.3.6.1
MibParser.ListSuccessors()
```

 will generate the following output through the event:

```text
  directory    1.3.6.1.1
  mgmt         1.3.6.1.2
  experimental 1.3.6.1.3
  private      1.3.6.1.4
  enterprises  1.3.6.1.4.1
```

# TrapNode Event ([MibBrowser](#mibbrowser-class) Class)

Lists module trap information.

## Syntax

```text
public class DefaultMibBrowserEventListener implements MibBrowserEventListener {
  ...
  public void trapNode(MibBrowserTrapNodeEvent e) {}
  ...
}

public class MibBrowserTrapNodeEvent {
  public String trapName;
  public int specificTrap;
  public String trapEnterprise;
  public String trapVariables;
  public String trapDescription;
  public String trapReferences;
  public String trapModuleName;
  public String trapFileName;
}
```

## Remarks

When calling [ListTraps](#listtraps-method-mibbrowser-class), the TrapNode event fires once for every trap found in the module.

The following are the descriptions of the event parameters:

|  |  |
| --- | --- |
| TrapName | The name of the trap (its label). |
| TrapSpecificTrap | The specific id of this trap. |
| TrapEnterprise | The defining entity. |
| TrapVariables | A comma separated list of the symbols that should be present inside the trap. |
| TrapDescription | A textual memo about the node. |
| TrapModuleName | The module that contains the trap definition. |
| TrapFileName | The filename of the MIB where the trap is defined. |

If a trap has been defined in more than one module or file, then *ModuleName* and *FileName* will contain a comma separated list of values.

# Config Settings ([MibBrowser](#mibbrowser-class) Class)

 The class accepts one or more of the following *configuration settings*. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these *internal properties* is provided through the [Config](#config-method-mibbrowser-class) method.

### MibBrowser Config Settings

**AutoLoadMibs**: Determines whether imported MIB modules are loaded automatically.When *true* (default), the class will attempt to automatically load MIB imports. Only the path of the current module will be searched.

**CacheDescriptions**: Controls caching of Node descriptions.The default value is *true*.

When *false*, the class will only save the offset of the descriptions from the MIB file in memory, and will fetch the textual descriptions directly from the file only when required. When caching is disabled, make sure that the path of the loaded modules does not change or the property will be unable to fetch the correct text descriptions.

When *true*, the class will save the full descriptions in memory, avoiding additional fetches to the MIB file but increasing the memory usage of the class. Useful if the location of the MIB file is subject to changes or if the file is provided directly to the [LoadMib](#loadmib-method-mibbrowser-class) method rather than through a file path.

**CacheMibs**: Controls MIB module caching. If set to *true* (default), a file will never be loaded/parsed more than once.

**CheckNoKnownRoots**: Controls whether or not the class fails when a file with no known root is loaded.If set to *true* the class will fail with an error when [LoadMib](#loadmib-method-mibbrowser-class) is called and no root node can be found for the nodes defined in the file. When this value is *false* (default), [Error](#error-event-mibbrowser-class) will fire with this alert.

**DisplayHint**: The DISPLAY-HINT property for the current node.This is set to the DISPLAY-HINT property for the current node specified in [NodeIndex](#nodeindex-property-mibbrowser-class).

Note that this config is read only.

**MibExtensions**: Controls the file extensions that the component will search for.When loading a MIB file with AutoLoadMibs set to *true*, this configuration setting controls what file extensions the component will search to find imported symbols. The default value is ".mib", which means the component will search files with a .mib extension or with no extension. If you set the value to ".txt, .mib", it will also search files with a .txt extension.

**NodeIsColumnar**: Whether the current node is columnar.This setting may be queried after calling [SelectNode](#selectnode-method-mibbrowser-class) or within the [MibNode](#mibnode-event-mibbrowser-class) event to determine if the current node is columnar.

**NodeIsScalar**: Whether the current node is scalar.This setting may be queried after calling [SelectNode](#selectnode-method-mibbrowser-class) or within the [MibNode](#mibnode-event-mibbrowser-class) event to determine if the current node is scalar.

**ReturnEnumValues**: Comma-separated list of the current node's enumeration textual-conventions.If set to *true*, and the current node references an enumeration textual-convention, then the values of the enumeration will be returned in the following format:

"label1(Value), label2(Value), label3(Value)..."

**UndefinedSymbols**: Comma-separated list of nodes that have not been resolved.After loading a MIB file, this config can be used to list all MIB nodes that have no parent and are not the root node itself.

If an undefined symbol is found within the current MIB file, it will only print the symbol name. If the symbol is referenced from another module, it will print both the symbol name and the module name (like "symbolname MODULE-NAME").

For more information, please refer to the [LoadMib](#loadmib-method-mibbrowser-class) method.

### Base Config Settings

**BuildInfo**: Information about the product's build.When queried, this setting will return a string containing information about the product's build.

**GUIAvailable**: Whether or not a message loop is available for processing events.In a GUI-based application, long-running blocking operations may cause the application to stop responding to input until the operation returns. The class will attempt to discover whether or not the application has a message loop and, if one is discovered, it will process events in that message loop during any such blocking operation.

In some non-GUI applications, an invalid message loop may be discovered that will result in errant behavior. In these cases, setting [GUIAvailable](#GUIAvailable) to *false* will ensure that the class does not attempt to process external events.

**LicenseInfo**: Information about the current license.When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:

- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.

**MaskSensitiveData**: Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to *true* to mask sensitive data. The default is *true*.

**UseDaemonThreads**: Whether threads created by the class are daemon threads.If set to True (default), when the class creates a thread, the thread's Daemon property will be explicitly set to True. When set to False, the class will not set the Daemon property on the created thread. The default value is True.

**UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *false*, the class will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to *true* tells the class to use the internal implementation instead of using the system security libraries.

 This setting is set to *false* by default on all platforms.

**UseVirtualThreads**: Whether threads created by the class use virtual threads instead of platform threads.If set to *true*, when the class creates a thread, it will be created as a virtual thread instead of a platform thread. Virtual threads are lightweight threads managed by the JVM that are multiplexed onto a small pool of carrier threads, significantly reducing memory usage and platform thread count under high-concurrency workloads. Requires Java 24 or later. The default value is *false*.

# Trappable Errors ([MibBrowser](#mibbrowser-class) Class)

### MibBrowser Errors

|  |  |
| --- | --- |
| 1000 | Missing token. |
| 1001 | Unexpected token. |
| 1002 | Unexpected end of file. |
| 1003 | MIB error. |
| 1004 | Nested MIBs are not supported. |
| 1005 | Missing import. |