SNMPTrapMgr Class

Properties   Methods   Events   Config Settings   Errors  

The SNMPTrapMgr class provides a UDP-based listening point for SNMP traps.

Syntax

ipworkssnmp.SNMPTrapMgr

Remarks

The SNMPTrapMgr class provides a UDP-based listening point for SNMP traps and informs as specified by the SNMP RFCs. The class supports v1, v2c, and v3 traps.

SNMP over DTLS is also supported when SSLEnabled is set to True. The SSLCert properties are used to select a certificate for the server. The SSLStatus event provides information about the DTLS handshake. When client authentication is required, the SSLAuthenticateClients property can be set to True and the SSLClientAuthentication event can be used to examine client credentials.

The class provides both encoding/decoding and transport capabilities, making the task of developing a custom SNMP Trap manager as simple as setting a few key properties and handling a few events. SNMP data, such as for instance SNMP object id-s (OID-s) are exchanged as text strings, thus further simplifying the task of handling them.

The class is activated/deactivated by calling the Activate or Deactivate method. These methods enable or disable sending and receiving. The activation status can be found in the Active property.

Messages are received through events such as Trap, InformRequest, or DiscoveryRequest.

SNMP OIDs, types, and values are provided in the Objects collection of SNMP objects for both sent and received packets.

SNMPv3 USM security passwords are requested through the GetUserPassword event, and event parameters such as User and SecurityLevel provide information about the security attributes of received requests, and enable granular decision capability about what to provide and what not to provide.

The AddUser, RemoveUser, ShowCache, ClearCache, AddEngine, and RemoveEngine methods are used to manage an internal authentication cache. This internal cache can be used as an alternative to the GetUserPassword event, automatically checking the cache against the security parameters provided in the request signature.

Property List

---

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

Method List

---

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

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.

Config Settings

---

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

AcceptData Property (SNMPTrapMgr Class)

Enables or disables data reception.

Syntax

public boolean isAcceptData();
public void setAcceptData(boolean acceptData);

Default Value

True

Remarks

Setting the property to False temporarily disables data reception. Setting the property to True re-enables data reception.

This property is not available at design time.

Active Property (SNMPTrapMgr Class)

Indicates whether the class is active.

Syntax

public boolean isActive();
public void setActive(boolean active);

Default Value

False

Remarks

This property indicates whether the class is currently active and can send or receive data.

The class will be automatically activated if it is not already and you attempt to perform an operation which requires the class to be active.

Use the Activate and Deactivate methods to control whether the class is active.

This property is not available at design time.

LocalEngineId Property (SNMPTrapMgr Class)

The Engine Id (for SNMPv3).

Syntax

public byte[] getLocalEngineId();
public void setLocalEngineId(byte[] localEngineId);

Default Value

""

Remarks

This property is necessary for properly handling InformRequest packets.

LocalHost Property (SNMPTrapMgr Class)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

public String getLocalHost();
public void setLocalHost(String localHost);

Default Value

""

Remarks

This property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

Note: LocalHost is not persistent. You must always set it in code, and never in the property window.

LocalPort Property (SNMPTrapMgr Class)

The port in the local host where the class is bound to.

Syntax

public int getLocalPort();
public void setLocalPort(int localPort);

Default Value

162

Remarks

The LocalPort property must be set before the class is activated (Active is set to True). It instructs the class to bind to a specific port (or communication endpoint) in the local machine.

The default port is 162 (standard trap port). If that port is busy, an error will be returned, unless the ForceLocalPort configuration setting is set to False, in which case a random port will be chosen.

LocalPort cannot be changed once the class is Active. Any attempt to set the LocalPort property when the class is Active will generate an error.

Note: In Android, values below 1024 may require root permissions.

Note: on macOS and iOS, root permissions are required to set LocalPort to any value below 1024.

Objects Property (SNMPTrapMgr Class)

The objects in the current request.

Syntax

public SNMPObjectList getObjects();
public void setObjects(SNMPObjectList objects);

Remarks

The SNMP objects being sent or received in the current request. The collection is first cleared, then populated every time an SNMP packet is received. It is also used to create outgoing SNMP packets.

This collection is indexed from 0 to size -1.

Please refer to the SNMPObject type for a complete list of fields.

RequestId Property (SNMPTrapMgr Class)

The request-id to mark outgoing packets with.

Syntax

public int getRequestId();
public void setRequestId(int requestId);

Default Value

1

Remarks

If a custom value is needed for RequestId, the property must be set before sending the request. The class increments RequestId automatically after sending each packet.

This property is not available at design time.

SSLAuthenticateClients Property (SNMPTrapMgr Class)

If set to True, the server asks the client(s) for a certificate.

Syntax

public boolean isSSLAuthenticateClients();
public void setSSLAuthenticateClients(boolean SSLAuthenticateClients);

Default Value

False

Remarks

This property is used in conjunction with the SSLClientAuthentication event. Please refer to the documentation of the SSLClientAuthentication event for details.

SSLCert Property (SNMPTrapMgr Class)

The certificate to be used during Secure Sockets Layer (SSL) negotiation.

Syntax

public Certificate getSSLCert();
public void setSSLCert(Certificate SSLCert);

Remarks

This property includes the digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.

Please refer to the Certificate type for a complete list of fields.

SSLEnabled Property (SNMPTrapMgr Class)

Whether DTLS is enabled.

Syntax

public boolean isSSLEnabled();
public void setSSLEnabled(boolean SSLEnabled);

Default Value

False

Remarks

This setting specifies whether DTLS is enabled in the class. When False (default) the class operates in plaintext mode. When True DTLS is enabled.

This property is not available at design time.

Activate Method (SNMPTrapMgr Class)

Activates the class.

Syntax

public void activate();

Remarks

This method activates the component and will allow it to send or receive data.

The class will be automatically activated if it is not already and you attempt to perform an operation which requires the class to be active.

Note: Use the Active property to check whether the component is active.

AddEngine Method (SNMPTrapMgr Class)

Adds the engine specified by EngineId to the internal authentication cache.

Syntax

public void addEngine(byte[] engineId, int engineBoots, int engineTime);

Remarks

The internal authentication cache can be used as an alternative to the GetUserPassword event, automatically checking the cache against the security parameters provided in the request signature.

The ShowCache method is used to show the contents of the internal authentication cache.

The ClearCache method can be used to completely clear the cache.

If the engine parameters are unknown, the SNMPMgr class's Discover method can be used to perform a discovery with the agent. The RemoteEngineId, RemoteEngineTime, and RemoteEngineBoots properties will hold the values that can then be passed to this method.

AddUser Method (SNMPTrapMgr Class)

Adds a user for the engine specified by EngineId to the internal authentication cache.

Syntax

public void addUser(String user, byte[] engineId, int authenticationProtocol, String authenticationPassword, int encryptionAlgorithm, String encryptionPassword);

Remarks

The internal authentication cache can be used as an alternative to the GetUserPassword event, automatically checking the cache against the security parameters provided in the request signature.

The ShowCache method is used to show the contents of the internal authentication cache.

The ClearCache method can be used to completely clear the cache.

Valid Authentication Protocols are:

Valid Encryption Algorithms are:

ClearCache Method (SNMPTrapMgr Class)

Clears the internal authentication database.

Syntax

public void clearCache();

Remarks

All user and engine records are removed from the internal authentication cache as a result of this call.

Config Method (SNMPTrapMgr Class)

Sets or retrieves a configuration setting.

Syntax

public String config(String configurationString);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings 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, you must call Config("PROPERTY"). The value will be returned as a string.

Deactivate Method (SNMPTrapMgr Class)

Deactivates the class.

Syntax

public void deactivate();

Remarks

This method deactivates the component and will prohibit it from sending and receiving data.

Note: Use the Active property to check whether the component is active.

DoEvents Method (SNMPTrapMgr Class)

This method processes events from the internal message queue.

Syntax

public void doEvents();

Remarks

When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.

HashPasswords Method (SNMPTrapMgr Class)

Hashes all passwords in the cache.

Syntax

public void hashPasswords();

Remarks

Forces computation of all passwords hashes in the cache. Used together with the HashPassword event to enable implementations of external password hash storage.

RemoveEngine Method (SNMPTrapMgr Class)

Removes the engine specified by EngineId from the internal authentication cache.

Syntax

public void removeEngine(byte[] engineId);

Remarks

The internal authentication cache can be used as an alternative to the GetUserPassword event, automatically checking the cache against the security parameters provided in the request signature.

The ShowCache method is used to show the contents of the internal authentication cache.

The ClearCache method can be used to completely clear the cache.

RemoveUser Method (SNMPTrapMgr Class)

Removes the user specified by User of the engine specified by EngineId from the internal authentication cache.

Syntax

public void removeUser(String user, byte[] engineId);

Remarks

The internal authentication cache can be used as an alternative to the GetUserPassword event, automatically checking the cache against the security parameters provided in the request signature.

The ShowCache method is used to show the contents of the internal authentication cache.

The ClearCache method can be used to completely clear the cache.

Reset Method (SNMPTrapMgr Class)

Clears the object arrays.

Syntax

public void reset();

Remarks

Clears the object arrays, and sets the trap and error properties to their default values. This is useful for reinitializing all the properties that are used to create outgoing packets before building a new packet.

Note: SNMPVersion will be reset to snmpverV2c (2).

ShowCache Method (SNMPTrapMgr Class)

Lists all entries in the internal user and engine database.

Syntax

public void showCache();

Remarks

A CacheEntry event is fired for every record in the database.

Value Method (SNMPTrapMgr Class)

Returns the value corresponding to an OID.

Syntax

public String value(String OID);

Remarks

If the OID does not exist in the Objects collection, a trappable error is generated.

Please refer to the SNMPObject type for more information.

BadPacket Event (SNMPTrapMgr Class)

Fired for erroneous and/or malformed messages.

Syntax

public class DefaultSNMPTrapMgrEventListener implements SNMPTrapMgrEventListener {
  ...
  public void badPacket(SNMPTrapMgrBadPacketEvent e) {}
  ...
}

public class SNMPTrapMgrBadPacketEvent {
  public byte[] packet;
  public String sourceAddress;
  public int sourcePort;
  public int errorCode;
  public String errorDescription;
  public boolean report; //read-write
}

Remarks

The full message is provided in the Packet parameter.

The BadPacket event is also fired when authentication fails for received packets due to a bad password or other reasons.

If the Report parameter is set to True, an unauthenticated error report will be sent to the client, otherwise the packet will be silently ignored.

Please refer to the GetUserPassword event for more information concerning SNMPv3 authentication.

CacheEntry Event (SNMPTrapMgr Class)

Shows engines and users in the internal cache.

Syntax

public class DefaultSNMPTrapMgrEventListener implements SNMPTrapMgrEventListener {
  ...
  public void cacheEntry(SNMPTrapMgrCacheEntryEvent e) {}
  ...
}

public class SNMPTrapMgrCacheEntryEvent {
  public byte[] engineId;
  public int engineBoots;
  public int engineTime;
  public String user;
  public String authenticationProtocol;
  public String authenticationPassword;
  public String encryptionAlgorithm;
  public String encryptionPassword;
}

Remarks

CacheEntry events are triggered by a call to ShowCache. One event is fired for each user and engine. If there are no users for a particular engine, a single event is fired with the engine information, but empty values for user information.

CheckEngine Event (SNMPTrapMgr Class)

Fired to check engine parameters (timeliness, etc.).

Syntax

public class DefaultSNMPTrapMgrEventListener implements SNMPTrapMgrEventListener {
  ...
  public void checkEngine(SNMPTrapMgrCheckEngineEvent e) {}
  ...
}

public class SNMPTrapMgrCheckEngineEvent {
  public byte[] engineId;
  public int engineBoots;
  public int engineTime;
  public String user;
  public int securityLevel;
  public String remoteAddress;
  public int remotePort;
  public boolean isNew;
  public boolean accept; //read-write
}

Remarks

The Accept parameter determines if the engine will be accepted or not. If you set Accept to False prior to exiting the event, the processing on the message will stop and a BadPacket event will be fired.

The default value of Accept is True if and only if:

a) the engine already exists in the internal authentication cache (the IsNew parameter is False) and the timeliness has been verified;

b) the engine does not exist in the internal authentication cache (the IsNew parameter is True), but the packet has been authenticated by the class (SecurityLevel >= 1).

In all other cases, the default value for Accept is False, and you are responsible for accepting or not accepting the engine based on other considerations.

If Accept is true upon event exit, then:

a) if the engine already exists in the internal authentication cache, its time is updated to reflect the new time and the processing of the packet continues;

b) if the engine does not exist in the internal authentication cache, it is added there and if User is authenticated, the User will be added too.

Connected Event (SNMPTrapMgr Class)

Fired immediately after a connection completes (or fails).

Syntax

public class DefaultSNMPTrapMgrEventListener implements SNMPTrapMgrEventListener {
  ...
  public void connected(SNMPTrapMgrConnectedEvent e) {}
  ...
}

public class SNMPTrapMgrConnectedEvent {
  public String remoteAddress;
  public int remotePort;
  public int statusCode;
  public String description;
}

Remarks

This event fires after a connection completes or fails.

StatusCode is the value returned by the system TCP/IP stack. This will be 0 if the connection was successful.

Description contains a human readable description of the status. This will be "OK" if the connection was successful.

RemoteAddress is the IP address of the remote host.

RemotePort is the port on the remote host.

Disconnected Event (SNMPTrapMgr Class)

Fired when a connection is closed.

Syntax

public class DefaultSNMPTrapMgrEventListener implements SNMPTrapMgrEventListener {
  ...
  public void disconnected(SNMPTrapMgrDisconnectedEvent e) {}
  ...
}

public class SNMPTrapMgrDisconnectedEvent {
  public String remoteAddress;
  public int remotePort;
  public int statusCode;
  public String description;
}

Remarks

This event fires after a connection is broken.

StatusCode is the value returned by the system TCP/IP stack. This will be 0 if the connection was broken normally.

Description contains a human readable description of the status. This will be "OK" if the connection was broken normally.

RemoteAddress is the IP address of the remote host.

RemotePort is the port on the remote host.

DiscoveryRequest Event (SNMPTrapMgr Class)

Fired when an SNMPv3 discovery packet is received.

Syntax

public class DefaultSNMPTrapMgrEventListener implements SNMPTrapMgrEventListener {
  ...
  public void discoveryRequest(SNMPTrapMgrDiscoveryRequestEvent e) {}
  ...
}

public class SNMPTrapMgrDiscoveryRequestEvent {
  public byte[] engineId;
  public int engineBoots;
  public int engineTime;
  public String user;
  public int securityLevel;
  public String sourceAddress;
  public int sourcePort;
  public boolean respond; //read-write
}

Remarks

EngineId, EngineBoots, EngineTime, and User are the values received from SourceAddress.

For SNMPv3, the User parameter shows the user that was supplied with the packet. This parameter MUST be used together with the SecurityLevel parameter which shows the level of security in the message.

The SecurityLevel parameter shows whether the request has been authenticated. If SecurityLevel is 0, the request has NOT been authenticated (i.e. the packet signature has not been verified). For an authenticated, non encrypted request, SecurityLevel is 1. For an authenticated and encrypted request, SecurityLevel is 2.

Respond is True by default, and will automatically send a response using the value in LocalEngineId. To suppress the response, set Respond to False.

The value returned to SourceAddress for EngineBoots is always 0, and EngineTime is the number of seconds since January 1st, 1970 (GMT).

Error Event (SNMPTrapMgr Class)

Fired when information is available about errors during data delivery.

Syntax

public class DefaultSNMPTrapMgrEventListener implements SNMPTrapMgrEventListener {
  ...
  public void error(SNMPTrapMgrErrorEvent e) {}
  ...
}

public class SNMPTrapMgrErrorEvent {
  public int errorCode;
  public String description;
}

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class throws an exception.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

GetUserPassword Event (SNMPTrapMgr Class)

Retrieves a password associated with a user.

Syntax

public class DefaultSNMPTrapMgrEventListener implements SNMPTrapMgrEventListener {
  ...
  public void getUserPassword(SNMPTrapMgrGetUserPasswordEvent e) {}
  ...
}

public class SNMPTrapMgrGetUserPasswordEvent {
  public int passwordType;
  public String user;
  public byte[] engineId;
  public String password; //read-write
  public int algorithm; //read-write
}

Remarks

The GetUserPassword event is fired after initial inspection of SNMPv3 requests.

The type of password required is provided in the PasswordType parameter: 1 for authentication, and 2 for encryption (privacy).

The password corresponding to User and EngineId must be provided in the Password parameter. If the password is valid, processing will continue to other events such as GetRequest, SetRequest, etc.

If the PasswordType parameter is 1 (authentication is used), the Algorithm parameter can be set. Possible values are:

If the PasswordType parameter is 2 (encryption is used), the Algorithm parameter must also be set. Possible values are:

If the password does not match the signature in the request, a BadPacket event will be fired, at which point you can decide whether to report the error to the client (see the description of the BadPacket event for more information).

If the User is invalid or unknown, set the password to empty string (default) to ignore the request. This will result in a BadPacket event being fired, at which point you can decide whether to report the error to the client or not.

GetUserSecurityLevel Event (SNMPTrapMgr Class)

Sets the security level for an incoming packet.

Syntax

public class DefaultSNMPTrapMgrEventListener implements SNMPTrapMgrEventListener {
  ...
  public void getUserSecurityLevel(SNMPTrapMgrGetUserSecurityLevelEvent e) {}
  ...
}

public class SNMPTrapMgrGetUserSecurityLevelEvent {
  public String user;
  public byte[] engineId;
  public int securityLevel; //read-write
}

Remarks

The GetUserSecurityLevel event is fired after the first inspection of each SNMPv3 request. The SecurityLevel parameter determines the level of security for the message.

On entry, the SecurityLevel parameter contains the default security level for User if the user is located in the internal cache, or if the User is not found in the cache, the SecurityLevel will be -1.

The value of SecurityLevel upon exiting the event, determines how the message will be processed:

HashPassword Event (SNMPTrapMgr Class)

Fired before and after a password is hashed.

Syntax

public class DefaultSNMPTrapMgrEventListener implements SNMPTrapMgrEventListener {
  ...
  public void hashPassword(SNMPTrapMgrHashPasswordEvent e) {}
  ...
}

public class SNMPTrapMgrHashPasswordEvent {
  public String password;
  public int authAlgorithm;
  public String hash; //read-write
}

Remarks

SNMPv3 passwords are hashed in order to obtain authentication and encryption keys. This is an expensive operation, and in certain situations it may be preferable to store the hashed passwords externally and supply them on demand.

If a hash is required, the event fires with an empty string in the Hash parameter. In this case, you can choose to supply a value for the hash and stop the class from computing the hash.

The event also fires every time a hash is computed. In this case, the Hash parameter contains the value of the computed hash.

AuthAlgorithm contains either 1 for HMAC-MD5-96, 2 for HMAC-SHA-96 or 3 for HMAC-192-SHA-256

InformRequest Event (SNMPTrapMgr Class)

Fired when an InformRequest packet is received.

Syntax

public class DefaultSNMPTrapMgrEventListener implements SNMPTrapMgrEventListener {
  ...
  public void informRequest(SNMPTrapMgrInformRequestEvent e) {}
  ...
}

public class SNMPTrapMgrInformRequestEvent {
  public int requestId;
  public int SNMPVersion;
  public String community;
  public String user;
  public int securityLevel;
  public String sourceAddress;
  public int sourcePort;
  public int errorIndex; //read-write
  public int errorStatus; //read-write
  public String errorDescription;
  public boolean respond; //read-write
}

Remarks

For SNMPv3, the User parameter shows the user that was supplied with the packet. This parameter MUST be used together with the SecurityLevel parameter which shows the level of security in the message.

The SecurityLevel parameter shows whether the request has been authenticated. If SecurityLevel is 0, the request has NOT been authenticated (i.e. the packet signature has not been verified). For an authenticated, non encrypted request, SecurityLevel is 1. For an authenticated and encrypted request, SecurityLevel is 2.

The user in an InformRequest packet (SNMPv3) must be a valid user in the internal authentication cache (see the AddUser method and the CheckEngine event for more information). If not, the request is rejected, and a BadPacket event is fired before InformRequest is fired.

The list of variables in the SNMP packet, including optional values and types, is provided through the Objects collection. Each object is of type SNMPObject. This type describes the Oid, ObjectType, and Value of each SNMP object. These variables must be copied to another location before the event has completed executing, or they may be overridden by other events.

The SourceAddress and SourcePort parameters show the address and port of the sender as reported by the TCP/IP stack.

The MessageId parameter identifies the received request.

For SNMPv3, the User parameter shows the user that was supplied with the packet. This parameter MUST be used together with the SecurityLevel parameter which shows the level of security in the message.

The SecurityLevel parameter shows whether the request has been authenticated. If SecurityLevel is 0, the request has NOT been authenticated (i.e. the packet signature has not been verified). For an authenticated, non encrypted request, SecurityLevel is 1. For an authenticated and encrypted request, SecurityLevel is 2.

To send a response, the Respond parameter must be set to true. By default, this value is false, which means no response will be sent. The ErrorStatus parameter may also be set to a valid SNMP status code (the default value is 0, which represents no error).

The following is a list of valid SNMP status code values:

The ErrorIndex parameter indicates the index of the first variable (object) that caused an error. The default value is 0.

Variable indexes start with 0. ErrorIndex has no meaning when ErrorStatus is 0 (no error).

PacketTrace Event (SNMPTrapMgr Class)

Fired for every packet sent or received.

Syntax

public class DefaultSNMPTrapMgrEventListener implements SNMPTrapMgrEventListener {
  ...
  public void packetTrace(SNMPTrapMgrPacketTraceEvent e) {}
  ...
}

public class SNMPTrapMgrPacketTraceEvent {
  public byte[] packet;
  public int direction;
  public String packetAddress;
  public int packetPort;
}

Remarks

The PacketTrace event shows all the packets sent or received by the class.

Packet contains the full contents of the datagram.

Direction shows the direction of the packet: 1 for incoming packets, and 2 for outgoing packets.

In the case of an incoming packet, PacketAddress and PacketPort identify the source of the packet.

In the case of an outgoing packet, PacketAddress and PacketPort identify the destination of the packet.

SSLClientAuthentication Event (SNMPTrapMgr Class)

Fired when the client presents its credentials to the server.

Syntax

public class DefaultSNMPTrapMgrEventListener implements SNMPTrapMgrEventListener {
  ...
  public void SSLClientAuthentication(SNMPTrapMgrSSLClientAuthenticationEvent e) {}
  ...
}

public class SNMPTrapMgrSSLClientAuthenticationEvent {
  public String remoteAddress;
  public int remotePort;
  public byte[] certEncoded;
  public String certSubject;
  public String certIssuer;
  public String status;
  public boolean accept; //read-write
}

Remarks

This event fires when a client connects to the class and presents a certificate for authentication. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether to continue or not.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string "OK").

RemoteAddress is the IP address of the connecting client.

RemotePort is the source port of the connecting client.

CertEncoded is the base64 encoded certificate presented by the client.

CertSubject is the subject of the certificate presented by the client.

CertIssuer is the subject of the issuer of the certificate presented by the client.

Status is the stauts of the certificate.

Accept defines whether the certificate is accepted.

SSLStatus Event (SNMPTrapMgr Class)

Shows the progress of the secure connection.

Syntax

public class DefaultSNMPTrapMgrEventListener implements SNMPTrapMgrEventListener {
  ...
  public void SSLStatus(SNMPTrapMgrSSLStatusEvent e) {}
  ...
}

public class SNMPTrapMgrSSLStatusEvent {
  public String remoteAddress;
  public int remotePort;
  public String message;
}

Remarks

The event is fired for informational and logging purposes only. It is used to track the progress of the connection.

RemoteAddress is the IP address of the remote machine.

RemotePort is the port of the remote machine.

Message is the log message.

Trap Event (SNMPTrapMgr Class)

Fired when a SNMP trap packet is received.

Syntax

public class DefaultSNMPTrapMgrEventListener implements SNMPTrapMgrEventListener {
  ...
  public void trap(SNMPTrapMgrTrapEvent e) {}
  ...
}

public class SNMPTrapMgrTrapEvent {
  public int requestId;
  public int SNMPVersion;
  public String community;
  public String user;
  public int securityLevel;
  public String trapOID;
  public long timeStamp;
  public String agentAddress;
  public String sourceAddress;
  public int sourcePort;
}

Remarks

The TrapOID and TimeStamp parameters contain the Trap OID and TimeStamp. In the case of an SNMPv1 trap, there are two possible scenarios:

First, if the enterprise of the trap is "1.3.6.1.6.3.1.1.5", TrapOID will be a concatenation of TrapEnterprise and GenericTrap + 1. For instance a TrapOID of "1.3.6.1.6.3.1.1.5.5" has a TrapEnterprise of "1.3.6.1.6.3.1.1.5" and a GenericTrap of "4".

Second, In all other cases TrapOID will be a concatenation of the values for TrapEnterprise, GenericTrap, and SpecificTrap, separated by '.'.

For SNMPv2 and above, they are read from the variable-value list (if available).

For SNMPv3, the User parameter shows the user that was supplied with the packet. This parameter MUST be used together with the SecurityLevel parameter which shows the level of security in the message.

The SecurityLevel parameter shows whether the request has been authenticated. If SecurityLevel is 0, the request has NOT been authenticated (i.e. the packet signature has not been verified). For an authenticated, non encrypted request, SecurityLevel is 1. For an authenticated and encrypted request, SecurityLevel is 2.

The list of variables in the SNMP packet, including optional values and types, is provided through the Objects collection. Each object is of type SNMPObject. This type describes the Oid, ObjectType, and Value of each SNMP object. These variables must be copied to another location before the event has completed executing, or they may be overridden by other events.

The SourceAddress and SourcePort parameters show the address and port of the sender as reported by the TCP/IP stack.

Some parameters are only applicable depending on the SNMPVersion value. The table below shows which parameters are applicable to which SNMP versions.

Certificate Type

This is the digital certificate being used.

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields

Constructors

public Certificate();

public Certificate( certificateFile);

public Certificate( encoded);

public Certificate( storeType,  store,  storePassword,  subject);

public Certificate( storeType,  store,  storePassword,  subject,  configurationString);

public Certificate( storeType,  store,  storePassword,  encoded);

public Certificate( storeType,  store,  storePassword,  subject);

public Certificate( storeType,  store,  storePassword,  subject,  configurationString);

public Certificate( storeType,  store,  storePassword,  encoded);

SNMPObject Type

The current SNMP object.

Remarks

This type defines an SNMP object. Each object has an Oid, ObjectType, and Value. These values are populated by the class when incoming packets are received. You may use these fields to define objects to be used in outgoing packets.

Fields

Constructors

public SNMPObject();

public SNMPObject( oid);

public SNMPObject( oid,  value);

public SNMPObject( oid,  value,  objectType);

Config Settings (SNMPTrapMgr 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 method.

SNMPTrapMgr Config Settings

UDP Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (SNMPTrapMgr Class)

SNMPTrapMgr Errors

UDP Errors

SSL Errors

TCP/IP Errors