com.sun.management.comm
Interface SnmpAdaptorServerMBean

All Superinterfaces:

CommunicatorServerMBean

All Known Subinterfaces:

SnmpV3AdaptorServerMBean

All Known Implementing Classes:

SnmpAdaptorServer, SnmpV3AdaptorServer

public interface SnmpAdaptorServerMBean
extends CommunicatorServerMBean

Exposes the remote management interface of the SnmpAdaptorServer MBean.

Since:

Java DMK 5.1

Method Summary

SnmpMibHandler	addMib(SnmpMibAgent mib) Adds a new MIB in the SNMP MIB handler.
SnmpMibHandler	addMib(SnmpMibAgent mib, SnmpOid[] oids) Adds a new MIB in the SNMP MIB handler.
SnmpMibHandler	addMib(SnmpMibAgent mib, String contextName) Adds a new contextualized MIB in the SNMP MIB handler.
int	getActiveClientCount() Gets the number of managers currently being processed by this SNMP protocol adaptor.
boolean	getAuthRespEnabled() Returns true if this SNMP protocol adaptor sends a response in case of authentication failure.
boolean	getAuthTrapEnabled() Returns true if authentication traps are enabled.
Integer	getBufferSize() Returns the buffer size of this SNMP protocol adaptor.
String	getEnterpriseOid() Returns the enterprise OID.
InetAddressAcl	getInetAddressAcl() Returns the Ip address based ACL used by this SNMP protocol adaptor.
int	getInformPort() Returns the port used by this SNMP protocol adaptor for sending inform requests.
int	getMaxActiveClientCount() Gets the maximum number of managers that this SNMP protocol adaptor can process concurrently.
int	getMaxTries() Gets the number of times to try sending an inform request before giving up.
String[]	getMibs() Returns the names of the MIBs available in this SNMP protocol adaptor.
SnmpPduFactory	getPduFactory() Returns the message factory of this SNMP protocol adaptor.
String	getProtocol() Returns the protocol of this SNMP protocol adaptor.
int	getServedClientCount() Gets the number of managers that have been processed by this SNMP protocol adaptor since its creation.
Long	getSnmpInASNParseErrs() Returns the snmpInASNParseErrs value defined in MIB-II.
Long	getSnmpInBadCommunityNames() Returns the snmpInBadCommunityNames value defined in MIB-II.
Long	getSnmpInBadCommunityUses() Returns the snmpInBadCommunityUses value defined in MIB-II.
Long	getSnmpInBadVersions() Returns the snmpInBadVersions value defined in MIB-II.
Long	getSnmpInGetNexts() Returns the snmpInGetNexts value defined in MIB-II.
Long	getSnmpInGetRequests() Returns the snmpInGetRequests value defined in MIB-II.
Long	getSnmpInPkts() Returns the snmpInPkts value defined in MIB-II.
Long	getSnmpInSetRequests() Returns the snmpInSetRequests value defined in MIB-II.
Long	getSnmpInTotalReqVars() Returns the snmpInTotalReqVars value defined in MIB-II.
Long	getSnmpInTotalSetVars() Returns the snmpInTotalSetVars value defined in MIB-II.
Long	getSnmpOutBadValues() Returns the snmpOutBadValues value defined in MIB-II.
Long	getSnmpOutGenErrs() Returns the snmpOutGenErrs value defined in MIB-II.
Long	getSnmpOutGetResponses() Returns the snmpOutGetResponses value defined in MIB-II.
Long	getSnmpOutNoSuchNames() Returns the snmpOutNoSuchNames value defined in MIB-II.
Long	getSnmpOutPkts() Returns the snmpOutPkts value defined in MIB-II.
Long	getSnmpOutTooBigs() Returns the snmpOutTooBigs value defined in MIB-II.
Long	getSnmpOutTraps() Returns the snmpOutTraps value defined in MIB-II.
Long	getSnmpProxyDrops() Returns the snmpProxyDrops value defined in rfc 1907 NMPv2-MIB .
Long	getSnmpSilentDrops() Returns the snmpSilentDrops value defined in rfc 1907 NMPv2-MIB .
int	getTimeout() Gets the timeout to wait for an inform response from the manager.
Integer	getTrapPort() Returns the port used by this SNMP protocol adaptor for sending traps.
SnmpUserDataFactory	getUserDataFactory() Get the user-data factory associated with this SNMP protocol adaptor.
boolean	removeMib(SnmpMibAgent mib) Removes the specified MIB from the SNMP protocol adaptor.
void	setAuthRespEnabled(boolean enabled) Sets the flag indicating if responses need to be sent in case of authentication failure.
void	setAuthTrapEnabled(boolean enabled) Sets the flag indicating if traps need to be sent in case of authentication failure.
void	setBufferSize(Integer s) Sets the buffer size of this SNMP protocol adaptor.
void	setEnterpriseOid(String oid) Sets the enterprise OID.
void	setInformPort(int port) Sets the port used by this SNMP protocol adaptor for sending inform requests.
void	setMaxActiveClientCount(int c) Sets the maximum number of managers this SNMP protocol adaptor can process concurrently.
void	setMaxTries(int newMaxTries) Changes the maximum number of times to try sending an inform request before giving up.
void	setPduFactory(SnmpPduFactory factory) Sets the message factory of this SNMP protocol adaptor.
void	setTimeout(int newTimeout) Changes the timeout to wait for an inform response from the manager.
void	setTrapPort(Integer port) Sets the port used by this SNMP protocol adaptor for sending traps.
void	setUserDataFactory(SnmpUserDataFactory factory) Set the user-data factory of this SNMP protocol adaptor.
SnmpInformRequest	snmpInformRequest(InetAddress address, String cs, SnmpInformHandler cb, SnmpOid trapOid, SnmpVarBindList varBindList) Sends an inform using SNMP V2 inform request format.
Vector	snmpInformRequest(SnmpInformHandler cb, SnmpOid trapOid, SnmpVarBindList varBindList) Sends an inform using SNMP V2 inform request format.
SnmpInformRequest	snmpInformRequest(SnmpPeer peer, SnmpInformHandler cb, SnmpOid trapOid, SnmpVarBindList varBindList) Sends an inform using SNMP V2 inform request format.
void	snmpPduTrap(InetAddress address, SnmpPduPacket pdu) Send the specified trap PDU to the passed InetAddress.
void	snmpPduTrap(SnmpPeer peer, SnmpPduPacket pdu) Send the specified trap PDU to the passed SnmpPeer.
void	snmpV1Trap(InetAddress address, String cs, int generic, int specific, SnmpVarBindList varBindList) Sends a trap using SNMP V1 trap format.
void	snmpV1Trap(int generic, int specific, SnmpVarBindList varBindList) Sends a trap using SNMP V1 trap format.
void	snmpV1Trap(SnmpPeer peer, SnmpIpAddress agentAddr, SnmpOid enterpOid, int generic, int specific, SnmpVarBindList varBindList, SnmpTimeticks time) Sends a trap using SNMP V1 trap format.
void	snmpV2Trap(InetAddress address, String cs, SnmpOid trapOid, SnmpVarBindList varBindList) Sends a trap using SNMP V2 trap format.
void	snmpV2Trap(SnmpOid trapOid, SnmpVarBindList varBindList) Sends a trap using SNMP V2 trap format.
void	snmpV2Trap(SnmpPeer peer, SnmpOid trapOid, SnmpVarBindList varBindList, SnmpTimeticks time) Sends a trap using SNMP V2 trap format.

Methods inherited from interface com.sun.jdmk.comm.CommunicatorServerMBean

getHost, getPort, getState, getStateString, isActive, setPort, start, stop, waitState

Method Detail

getInetAddressAcl

InetAddressAcl getInetAddressAcl()

Returns the Ip address based ACL used by this SNMP protocol adaptor.

Returns:

The InetAddressAcl implementation.

getTrapPort

Integer getTrapPort()

Returns the port used by this SNMP protocol adaptor for sending traps. By default, port 162 is used.

Returns:

The port number for sending SNMP traps.

setTrapPort

void setTrapPort(Integer port)

Sets the port used by this SNMP protocol adaptor for sending traps.

Parameters:

port - The port number for sending SNMP traps.

getInformPort

int getInformPort()

Returns the port used by this SNMP protocol adaptor for sending inform requests. By default, port 162 is used.

Returns:

The port number for sending SNMP inform requests.

setInformPort

void setInformPort(int port)

Sets the port used by this SNMP protocol adaptor for sending inform requests.

Parameters:

port - The port number for sending SNMP inform requests.

getServedClientCount

int getServedClientCount()

Gets the number of managers that have been processed by this SNMP protocol adaptor since its creation.

Returns:

The number of managers handled by this SNMP protocol adaptor since its creation. This counter is not reset by the stop method.

getActiveClientCount

int getActiveClientCount()

Gets the number of managers currently being processed by this SNMP protocol adaptor.

Returns:

The number of managers currently being processed by this SNMP protocol adaptor.

getMaxActiveClientCount

int getMaxActiveClientCount()

Gets the maximum number of managers that this SNMP protocol adaptor can process concurrently.

Returns:

The maximum number of managers that this SNMP protocol adaptor can process concurrently.

setMaxActiveClientCount

void setMaxActiveClientCount(int c)
                             throws IllegalStateException

Sets the maximum number of managers this SNMP protocol adaptor can process concurrently.

Parameters:

c - The number of managers.

Throws:

IllegalStateException - This method has been invoked while the communicator was ONLINE or STARTING.

getProtocol

String getProtocol()

Returns the protocol of this SNMP protocol adaptor.

Specified by:

getProtocol in interface CommunicatorServerMBean

Returns:

The string "snmp".

getBufferSize

Integer getBufferSize()

Returns the buffer size of this SNMP protocol adaptor. By default, buffer size 1024 is used.

Returns:

The buffer size.

setBufferSize

void setBufferSize(Integer s)
                   throws IllegalStateException

Sets the buffer size of this SNMP protocol adaptor.

Parameters:

s - The buffer size.

Throws:

IllegalStateException - This method has been invoked while the communicator was ONLINE or STARTING.

getMaxTries

int getMaxTries()

Gets the number of times to try sending an inform request before giving up.

Returns:

The maximum number of tries.

setMaxTries

void setMaxTries(int newMaxTries)

Changes the maximum number of times to try sending an inform request before giving up.

Parameters:

newMaxTries - The maximum number of tries.

getTimeout

int getTimeout()

Gets the timeout to wait for an inform response from the manager.

Returns:

The value of the timeout property.

setTimeout

void setTimeout(int newTimeout)

Changes the timeout to wait for an inform response from the manager.

Parameters:

newTimeout - The timeout (in milliseconds).

getPduFactory

SnmpPduFactory getPduFactory()

Returns the message factory of this SNMP protocol adaptor.

Returns:

The factory object.

setPduFactory

void setPduFactory(SnmpPduFactory factory)

Sets the message factory of this SNMP protocol adaptor.

Parameters:

factory - The factory object (null means the default factory).

setUserDataFactory

void setUserDataFactory(SnmpUserDataFactory factory)

Set the user-data factory of this SNMP protocol adaptor.

Parameters:

factory - The factory object (null means no factory).

See Also:

SnmpUserDataFactory

getUserDataFactory

SnmpUserDataFactory getUserDataFactory()

Get the user-data factory associated with this SNMP protocol adaptor.

Returns:

The factory object (null means no factory).

See Also:

SnmpUserDataFactory

getAuthTrapEnabled

boolean getAuthTrapEnabled()

Returns true if authentication traps are enabled.

When this feature is enabled, the SNMP protocol adaptor sends an authenticationFailure trap each time an authentication fails.

The default behavior is to send authentication traps.

Returns:

true if authentication traps are enabled, false otherwise.

setAuthTrapEnabled

void setAuthTrapEnabled(boolean enabled)

Sets the flag indicating if traps need to be sent in case of authentication failure.

Parameters:

enabled - Flag indicating if traps need to be sent.

getAuthRespEnabled

boolean getAuthRespEnabled()

Returns true if this SNMP protocol adaptor sends a response in case of authentication failure.

When this feature is enabled, the SNMP protocol adaptor sends a response with noSuchName or readOnly when the authentication failed. If the flag is disabled, the SNMP protocol adaptor trashes the PDU silently.

The default behavior is to send responses.

Returns:

true if responses are sent.

setAuthRespEnabled

void setAuthRespEnabled(boolean enabled)

Sets the flag indicating if responses need to be sent in case of authentication failure.

Parameters:

enabled - Flag indicating if responses need to be sent.

getEnterpriseOid

String getEnterpriseOid()

Returns the enterprise OID. It is used by snmpV1Trap to fill the 'enterprise' field of the trap request.

Returns:

The OID in string format "x.x.x.x".

setEnterpriseOid

void setEnterpriseOid(String oid)
                      throws IllegalArgumentException

Sets the enterprise OID.

Parameters:

oid - The OID in string format "x.x.x.x".

Throws:

IllegalArgumentException - The string format is incorrect

getMibs

String[] getMibs()

Returns the names of the MIBs available in this SNMP protocol adaptor.

Returns:

An array of MIB names.

getSnmpOutTraps

Long getSnmpOutTraps()

Returns the snmpOutTraps value defined in MIB-II.

Returns:

The snmpOutTraps value.

getSnmpOutGetResponses

Long getSnmpOutGetResponses()

Returns the snmpOutGetResponses value defined in MIB-II.

Returns:

The snmpOutGetResponses value.

getSnmpOutGenErrs

Long getSnmpOutGenErrs()

Returns the snmpOutGenErrs value defined in MIB-II.

Returns:

The snmpOutGenErrs value.

getSnmpOutBadValues

Long getSnmpOutBadValues()

Returns the snmpOutBadValues value defined in MIB-II.

Returns:

The snmpOutBadValues value.

getSnmpOutNoSuchNames

Long getSnmpOutNoSuchNames()

Returns the snmpOutNoSuchNames value defined in MIB-II.

Returns:

The snmpOutNoSuchNames value.

getSnmpOutTooBigs

Long getSnmpOutTooBigs()

Returns the snmpOutTooBigs value defined in MIB-II.

Returns:

The snmpOutTooBigs value.

getSnmpInASNParseErrs

Long getSnmpInASNParseErrs()

Returns the snmpInASNParseErrs value defined in MIB-II.

Returns:

The snmpInASNParseErrs value.

getSnmpInBadCommunityUses

Long getSnmpInBadCommunityUses()

Returns the snmpInBadCommunityUses value defined in MIB-II.

Returns:

The snmpInBadCommunityUses value.

getSnmpInBadCommunityNames

Long getSnmpInBadCommunityNames()

Returns the snmpInBadCommunityNames value defined in MIB-II.

Returns:

The snmpInBadCommunityNames value.

getSnmpInBadVersions

Long getSnmpInBadVersions()

Returns the snmpInBadVersions value defined in MIB-II.

Returns:

The snmpInBadVersions value.

getSnmpOutPkts

Long getSnmpOutPkts()

Returns the snmpOutPkts value defined in MIB-II.

Returns:

The snmpOutPkts value.

getSnmpInPkts

Long getSnmpInPkts()

Returns the snmpInPkts value defined in MIB-II.

Returns:

The snmpInPkts value.

getSnmpInGetRequests

Long getSnmpInGetRequests()

Returns the snmpInGetRequests value defined in MIB-II.

Returns:

The snmpInGetRequests value.

getSnmpInGetNexts

Long getSnmpInGetNexts()

Returns the snmpInGetNexts value defined in MIB-II.

Returns:

The snmpInGetNexts value.

getSnmpInSetRequests

Long getSnmpInSetRequests()

Returns the snmpInSetRequests value defined in MIB-II.

Returns:

The snmpInSetRequests value.

getSnmpInTotalSetVars

Long getSnmpInTotalSetVars()

Returns the snmpInTotalSetVars value defined in MIB-II.

Returns:

The snmpInTotalSetVars value.

getSnmpInTotalReqVars

Long getSnmpInTotalReqVars()

Returns the snmpInTotalReqVars value defined in MIB-II.

Returns:

The snmpInTotalReqVars value.

getSnmpSilentDrops

Long getSnmpSilentDrops()

Returns the snmpSilentDrops value defined in rfc 1907 NMPv2-MIB .

Returns:

The snmpSilentDrops value.

getSnmpProxyDrops

Long getSnmpProxyDrops()

Returns the snmpProxyDrops value defined in rfc 1907 NMPv2-MIB .

Returns:

The snmpProxyDrops value.

addMib

SnmpMibHandler addMib(SnmpMibAgent mib)
                      throws IllegalArgumentException

Adds a new MIB in the SNMP MIB handler. This method is called automatically by SnmpMibAgent.setSnmpAdaptor(SnmpMibHandler) and SnmpMibAgent.setSnmpAdaptorName(ObjectName) and should not be called directly from remote.

Parameters:

mib - The MIB to add.

Returns:

A reference to the SNMP MIB handler.

Throws:

IllegalArgumentException - If the parameter is null.

addMib

SnmpMibHandler addMib(SnmpMibAgent mib,
                      SnmpOid[] oids)
                      throws IllegalArgumentException

Adds a new MIB in the SNMP MIB handler. This method is called automatically by SnmpMibAgent.setSnmpAdaptor(SnmpMibHandler, SnmpOid[]) and SnmpMibAgent.setSnmpAdaptorName(ObjectName, SnmpOid[]) and should not be called directly from remote.

Parameters:

mib - The MIB to add.

oids - The set of OIDs this agent implements. If null or oids.length == 0, this is equivalent to calling addMib(SnmpMibAgent mib)

Returns:

A reference to the SNMP MIB handler.

Throws:

IllegalArgumentException - If the parameter is null.

addMib

SnmpMibHandler addMib(SnmpMibAgent mib,
                      String contextName)
                      throws IllegalArgumentException

Adds a new contextualized MIB in the SNMP MIB handler. This method is called automatically by SnmpMibAgent.setSnmpAdaptor(SnmpMibHandler, String) and SnmpMibAgent.setSnmpAdaptorName(ObjectName, String) and should not be called directly from remote. When the underlying implementation does not support MIB scoping, calling this method is equivalent to calling addMib(SnmpMibAgent mib).

Note that MIB scoping is only supported by the SnmpV3AdaptorServer.

Parameters:

mib - The MIB to add.

contextName - The MIB context name. If null or contextName.length == 0, will be registered in the default context.

Returns:

A reference on the SNMP MIB handler.

Throws:

IllegalArgumentException - If the parameter is null.

removeMib

boolean removeMib(SnmpMibAgent mib)

Removes the specified MIB from the SNMP protocol adaptor. This method is called automatically by SnmpMibAgent.setSnmpAdaptor(SnmpMibHandler) and SnmpMibAgent.setSnmpAdaptorName(ObjectName) and should not be called directly from remote.

Parameters:

mib - The MIB to be removed.

Returns:

true if the specified mib was a MIB included in the SNMP MIB handler, false otherwise.

snmpV1Trap

void snmpV1Trap(int generic,
                int specific,
                SnmpVarBindList varBindList)
                throws IOException,
                       SnmpStatusException

Sends a trap using SNMP V1 trap format.
The trap is sent to each destination defined in the ACL file (if available). If no ACL file or no destinations are available, the trap is sent to the local host.

Parameters:

generic - The generic number of the trap.

specific - The specific number of the trap.

varBindList - A list of SnmpVarBind instances or null.

Throws:

IOException - An I/O error occurred while sending the trap.

SnmpStatusException - If the trap exceeds the limit defined by bufferSize.

snmpV1Trap

void snmpV1Trap(InetAddress address,
                String cs,
                int generic,
                int specific,
                SnmpVarBindList varBindList)
                throws IOException,
                       SnmpStatusException

Sends a trap using SNMP V1 trap format.
The trap is sent to the specified InetAddress destination using the specified community string (and the ACL file is not used).

Parameters:

address - The InetAddress destination of the trap.

cs - The community string to be used for the trap.

generic - The generic number of the trap.

specific - The specific number of the trap.

varBindList - A list of SnmpVarBind instances or null.

Throws:

IOException - An I/O error occurred while sending the trap.

SnmpStatusException - If the trap exceeds the limit defined by bufferSize.

snmpV1Trap

void snmpV1Trap(SnmpPeer peer,
                SnmpIpAddress agentAddr,
                SnmpOid enterpOid,
                int generic,
                int specific,
                SnmpVarBindList varBindList,
                SnmpTimeticks time)
                throws IOException,
                       SnmpStatusException

Sends a trap using SNMP V1 trap format.
The trap is sent to the specified SnmpPeer destination. The community string used is the one located in the SnmpPeer parameters (SnmpParameters.getRdCommunity() ).

Parameters:

peer - The SnmpPeer destination of the trap.

agentAddr - The agent address to be used for the trap.

enterpOid - The enterprise OID to be used for the trap.

generic - The generic number of the trap.

specific - The specific number of the trap.

varBindList - A list of SnmpVarBind instances or null.

time - The time stamp (overwrite the current time).

Throws:

IOException - An I/O error occurred while sending the trap.

SnmpStatusException - If the trap exceeds the limit defined by bufferSize.

snmpV2Trap

void snmpV2Trap(SnmpPeer peer,
                SnmpOid trapOid,
                SnmpVarBindList varBindList,
                SnmpTimeticks time)
                throws IOException,
                       SnmpStatusException

Sends a trap using SNMP V2 trap format.
The trap is sent to the specified SnmpPeer destination.
The community string used is the one located in the SnmpPeer parameters (SnmpParameters.getRdCommunity() ).
The variable list included in the outgoing trap is composed of the following items:

• sysUpTime.0 with the value specified by time
• snmpTrapOid.0 with the value specified by trapOid
• all the (oid,values) from the specified varBindList

Parameters:

peer - The SnmpPeer destination of the trap.

trapOid - The OID identifying the trap.

varBindList - A list of SnmpVarBind instances or null.

time - The time stamp (overwrite the current time).

Throws:

IOException - An I/O error occurred while sending the trap.

SnmpStatusException - If the trap exceeds the limit defined by bufferSize.

snmpV2Trap

void snmpV2Trap(SnmpOid trapOid,
                SnmpVarBindList varBindList)
                throws IOException,
                       SnmpStatusException

Sends a trap using SNMP V2 trap format.
The trap is sent to each destination defined in the ACL file (if available). If no ACL file or no destinations are available, the trap is sent to the local host.
The variable list included in the outgoing trap is composed of the following items:

• sysUpTime.0 with its current value
• snmpTrapOid.0 with the value specified by trapOid
• all the (oid,values) from the specified varBindList

Parameters:

trapOid - The OID identifying the trap.

varBindList - A list of SnmpVarBind instances or null.

Throws:

IOException - An I/O error occurred while sending the trap.

SnmpStatusException - If the trap exceeds the limit defined by bufferSize.

snmpV2Trap

void snmpV2Trap(InetAddress address,
                String cs,
                SnmpOid trapOid,
                SnmpVarBindList varBindList)
                throws IOException,
                       SnmpStatusException

Sends a trap using SNMP V2 trap format.
The trap is sent to the specified InetAddress destination using the specified community string (and the ACL file is not used).
The variable list included in the outgoing trap is composed of the following items:

• sysUpTime.0 with its current value
• snmpTrapOid.0 with the value specified by trapOid
• all the (oid,values) from the specified varBindList

Parameters:

address - The InetAddress destination of the trap.

cs - The community string to be used for the trap.

trapOid - The OID identifying the trap.

varBindList - A list of SnmpVarBind instances or null.

Throws:

IOException - An I/O error occurred while sending the trap.

SnmpStatusException - If the trap exceeds the limit defined by bufferSize.

snmpPduTrap

void snmpPduTrap(InetAddress address,
                 SnmpPduPacket pdu)
                 throws IOException,
                        SnmpStatusException

Send the specified trap PDU to the passed InetAddress.

Parameters:

address - The destination address.

pdu - The pdu to send.

Throws:

IOException - An I/O error occurred while sending the trap.

SnmpStatusException - If the trap exceeds the limit defined by bufferSize.

snmpPduTrap

void snmpPduTrap(SnmpPeer peer,
                 SnmpPduPacket pdu)
                 throws IOException,
                        SnmpStatusException

Send the specified trap PDU to the passed SnmpPeer.

Parameters:

peer - The destination peer. The Read community string is used of SnmpParameters is used as the trap community string.

pdu - The pdu to send.

Throws:

IOException - An I/O error occurred while sending the trap.

SnmpStatusException - If the trap exceeds the limit defined by bufferSize.

snmpInformRequest

Vector snmpInformRequest(SnmpInformHandler cb,
                         SnmpOid trapOid,
                         SnmpVarBindList varBindList)
                         throws IllegalStateException,
                                IOException,
                                SnmpStatusException

Sends an inform using SNMP V2 inform request format.
The inform request is sent to each destination defined in the ACL file (if available). If no ACL file or no destinations are available, the inform request is sent to the local host.
The variable list included in the outgoing inform request is composed of the following items:

• sysUpTime.0 with its current value
• snmpTrapOid.0 with the value specified by trapOid
• all the (oid,values) from the specified varBindList

To send an inform request, the SNMP adaptor server must be active.

Parameters:

cb - The callback that is invoked when a request is complete.

trapOid - The OID identifying the trap.

varBindList - A list of SnmpVarBind instances or null.

Returns:

A vector of SnmpInformRequest objects.

If there is no destination host for this inform request, the returned vector will be empty.

Throws:

IllegalStateException - This method has been invoked while the SNMP adaptor server was not active.

IOException - An I/O error occurred while sending the inform request.

SnmpStatusException - If the inform request exceeds the limit defined by bufferSize.

snmpInformRequest

SnmpInformRequest snmpInformRequest(InetAddress address,
                                    String cs,
                                    SnmpInformHandler cb,
                                    SnmpOid trapOid,
                                    SnmpVarBindList varBindList)
                                    throws IllegalStateException,
                                           IOException,
                                           SnmpStatusException

Sends an inform using SNMP V2 inform request format.
The inform is sent to the specified InetAddress destination using the specified community string.
The variable list included in the outgoing inform request is composed of the following items:

• sysUpTime.0 with its current value
• snmpTrapOid.0 with the value specified by trapOid
• all the (oid,values) from the specified varBindList

To send an inform request, the SNMP adaptor server must be active.

Parameters:

address - The InetAddress destination for this inform request.

cs - The community string to be used for the inform request.

cb - The callback that is invoked when a request is complete.

trapOid - The OID identifying the trap.

varBindList - A list of SnmpVarBind instances or null.

Returns:

The inform request object.

Throws:

IllegalStateException - This method has been invoked while the SNMP adaptor server was not active.

IOException - An I/O error occurred while sending the inform request.

SnmpStatusException - If the inform request exceeds the limit defined by bufferSize.

snmpInformRequest

SnmpInformRequest snmpInformRequest(SnmpPeer peer,
                                    SnmpInformHandler cb,
                                    SnmpOid trapOid,
                                    SnmpVarBindList varBindList)
                                    throws IllegalStateException,
                                           IOException,
                                           SnmpStatusException

Sends an inform using SNMP V2 inform request format.
The inform is sent to the specified SnmpPeer destination.
The community string used is the one located in the SnmpPeer parameters (SnmpParameters.getInformCommunity() ).
The variable list included in the outgoing inform is composed of the following items:

• sysUpTime.0 with its current value
• snmpTrapOid.0 with the value specified by trapOid
• all the (oid,values) from the specified varBindList

To send an inform request, the SNMP adaptor server must be active.

Parameters:

peer - The SnmpPeer destination for this inform request.

cb - The callback that is invoked when a request is complete.

trapOid - The OID identifying the trap.

varBindList - A list of SnmpVarBind instances or null.

Returns:

The inform request object.

Throws:

IllegalStateException - This method has been invoked while the SNMP adaptor server was not active.

IOException - An I/O error occurred while sending the inform request.

SnmpStatusException - If the inform request exceeds the limit defined by bufferSize.