com.sun.management.comm
Interface SnmpV3AdaptorServerMBean

All Superinterfaces:

CommunicatorServerMBean, SnmpAdaptorServerMBean

All Known Implementing Classes:

SnmpV3AdaptorServer

public interface SnmpV3AdaptorServerMBean
extends SnmpAdaptorServerMBean

Exposes the remote management interface of the SnmpV3AdaptorServer MBean.

Since:

Java DMK 5.1

Method Summary

SnmpMibHandler	addMib(SnmpMibAgent mib, String contextName) Adds a new contextualized MIB in the SNMP MIB handler.
SnmpMibHandler	addMib(SnmpMibAgent mib, String contextName, SnmpOid[] oids) Adds a new contextualized MIB in the SNMP MIB handler.
boolean	disableCommunityStringAtContext() Deactivate the community string to context translation.
boolean	enableCommunityStringAtContext() Activate the community string to context translation.
int[]	getAccessControlModelIds() Returns an array of access control model Ids.
String[]	getAccessControlModelNames() Returns an array of access control model names.
String[]	getContexts() Returns an array of context names.
SnmpEngineId	getEngineId() Returns the associated SnmpEngineId value.
String[]	getMibs(String context) Returns the names of the MIBs registered in the passed contextName.
int[]	getMsgProcessingModelIds() Returns an array of message processing model Ids.
String[]	getMsgProcessingModelNames() Returns an array of message processing model names.
int[]	getSecurityModelIds() Returns an array of security model Ids.
String[]	getSecurityModelNames() Returns an array of security model names.
Long	getSnmpInvalidMsgs() Returns snmpInvalidMsgs as defined in rfc 2572 SNMP-MPD-MIB.
Long	getSnmpUnknownContexts() Returns snmpUnknownContexts as defined in rfc 2573 SNMP-TARGET-MIB.
Long	getSnmpUnknownSecurityModels() Returns snmpUnknownSecurityModels as defined in rfc 2572 SNMP-MPD-MIB.
String[]	getUsmSecurityAlgorithms() Returns an array of User based Security Model supported algorithms.
boolean	isCommunityStringAtContextEnabled() The community to context translation activation status.
boolean	removeMib(SnmpMibAgent mib, String contextName) Removes a contextualized MIB from the SNMP protocol adaptor.
SnmpV3InformRequest	snmpV3UsmInformRequest(SnmpUsmPeer informPeer, SnmpInformHandler cb, SnmpOid trapOid, SnmpVarBindList list) Sends an inform request using SNMP V3 inform request format.
void	snmpV3UsmTrap(InetAddress addr, String principal, int securityLevel, String contextName, SnmpOid trapOid, SnmpVarBindList list) Sends a trap to the specified address using Usm as security model.
void	snmpV3UsmTrap(InetAddress addr, String principal, int securityLevel, String contextName, SnmpOid trapOid, SnmpVarBindList list, SnmpTimeticks time) Sends a trap to the specified address using Usm as security model.
void	snmpV3UsmTrap(SnmpUsmPeer peer, SnmpOid trapOid, SnmpVarBindList list, SnmpTimeticks time) Sends a trap to the specified SnmpUsmPeer using Usm as security model.
void	snmpV3UsmTrap(String principal, int securityLevel, String contextName, SnmpOid trapOid, SnmpVarBindList list) Sends a trap to all IP addresses in IPAcl using Usm as security model.

Methods inherited from interface com.sun.management.comm.SnmpAdaptorServerMBean

addMib, addMib, getActiveClientCount, getAuthRespEnabled, getAuthTrapEnabled, getBufferSize, getEnterpriseOid, getInetAddressAcl, getInformPort, getMaxActiveClientCount, getMaxTries, getMibs, getPduFactory, getProtocol, getServedClientCount, getSnmpInASNParseErrs, getSnmpInBadCommunityNames, getSnmpInBadCommunityUses, getSnmpInBadVersions, getSnmpInGetNexts, getSnmpInGetRequests, getSnmpInPkts, getSnmpInSetRequests, getSnmpInTotalReqVars, getSnmpInTotalSetVars, getSnmpOutBadValues, getSnmpOutGenErrs, getSnmpOutGetResponses, getSnmpOutNoSuchNames, getSnmpOutPkts, getSnmpOutTooBigs, getSnmpOutTraps, getSnmpProxyDrops, getSnmpSilentDrops, getTimeout, getTrapPort, getUserDataFactory, removeMib, setAuthRespEnabled, setAuthTrapEnabled, setBufferSize, setEnterpriseOid, setInformPort, setMaxActiveClientCount, setMaxTries, setPduFactory, setTimeout, setTrapPort, setUserDataFactory, snmpInformRequest, snmpInformRequest, snmpInformRequest, snmpPduTrap, snmpPduTrap, snmpV1Trap, snmpV1Trap, snmpV1Trap, snmpV2Trap, snmpV2Trap, snmpV2Trap

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

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

Method Detail

getEngineId

SnmpEngineId getEngineId()

Returns the associated SnmpEngineId value.

Returns:

The engine Id.

getSecurityModelIds

int[] getSecurityModelIds()

Returns an array of security model Ids.

Returns:

The security model Ids.

getSecurityModelNames

String[] getSecurityModelNames()

Returns an array of security model names.

Returns:

The security model names.

getMsgProcessingModelIds

int[] getMsgProcessingModelIds()

Returns an array of message processing model Ids.

Returns:

The message processing model Ids.

getMsgProcessingModelNames

String[] getMsgProcessingModelNames()

Returns an array of message processing model names.

Returns:

The message processing model names.

getAccessControlModelIds

int[] getAccessControlModelIds()

Returns an array of access control model Ids.

Returns:

The access control model Ids.

getAccessControlModelNames

String[] getAccessControlModelNames()

Returns an array of access control model names.

Returns:

The access control model names.

getUsmSecurityAlgorithms

String[] getUsmSecurityAlgorithms()

Returns an array of User based Security Model supported algorithms.

Returns:

The supported algorithms.

getContexts

String[] getContexts()

Returns an array of context names.

Returns:

The context names.

getMibs

String[] getMibs(String context)

Returns the names of the MIBs registered in the passed contextName.

Parameters:

context - The context name.

Returns:

An array of MIB names.

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.

Specified by:

addMib in interface SnmpAdaptorServerMBean

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.

addMib

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

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

Parameters:

mib - The MIB to add.

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

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

Returns:

A reference to the SNMP MIB handler.

Throws:

IllegalArgumentException - If the parameter is null.

removeMib

boolean removeMib(SnmpMibAgent mib,
                  String contextName)

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

Parameters:

mib - The MIB to be removed.

contextName - The context name used at registration time. If null or contextName.length == 0, will be removed from the default context. If null is passed, will be registered in the default context.

Returns:

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

snmpV3UsmInformRequest

SnmpV3InformRequest snmpV3UsmInformRequest(SnmpUsmPeer informPeer,
                                           SnmpInformHandler cb,
                                           SnmpOid trapOid,
                                           SnmpVarBindList list)
                                           throws IllegalStateException,
                                                  IOException,
                                                  SnmpStatusException

Sends an inform request using SNMP V3 inform request format.
The inform is sent to the specified InetAddress destination. The inform is sent in an SNMP V3 message. Engine Id of the inform receiver will be discovered using Snmp V3 engine Id discovery.
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:

informPeer - The peer to which the inform is sent.

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

trapOid - The OId identifying the trap.

list - 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.

snmpV3UsmTrap

void snmpV3UsmTrap(String principal,
                   int securityLevel,
                   String contextName,
                   SnmpOid trapOid,
                   SnmpVarBindList list)
                   throws IOException,
                          SnmpStatusException

Sends a trap to all IP addresses in IPAcl using Usm as security model.

Parameters:

principal - The user name to use.

securityLevel - The V3 message flags.

contextName - The V3 context name. The contextEngineId is the local engine Id.

trapOid - The OId identifying the trap.

list - 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.

snmpV3UsmTrap

void snmpV3UsmTrap(InetAddress addr,
                   String principal,
                   int securityLevel,
                   String contextName,
                   SnmpOid trapOid,
                   SnmpVarBindList list)
                   throws IOException,
                          SnmpStatusException

Sends a trap to the specified address using Usm as security model.

Parameters:

addr - The trap address destination.

principal - The user name to use.

securityLevel - The V3 message flags.

contextName - The V3 context name. The contextEngineId is the local engine Id.

trapOid - The OId identifying the trap.

list - 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.

snmpV3UsmTrap

void snmpV3UsmTrap(InetAddress addr,
                   String principal,
                   int securityLevel,
                   String contextName,
                   SnmpOid trapOid,
                   SnmpVarBindList list,
                   SnmpTimeticks time)
                   throws IOException,
                          SnmpStatusException

Sends a trap to the specified address using Usm as security model.

Parameters:

addr - The trap address destination.

principal - The user name to use.

securityLevel - The V3 message flags.

contextName - The V3 context name. The contextEngineId is the local engine Id.

trapOid - The OID identifying the trap.

list - 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.

snmpV3UsmTrap

void snmpV3UsmTrap(SnmpUsmPeer peer,
                   SnmpOid trapOid,
                   SnmpVarBindList list,
                   SnmpTimeticks time)
                   throws IOException,
                          SnmpStatusException,
                          IllegalArgumentException

Sends a trap to the specified SnmpUsmPeer using Usm as security model. Security parameters and context name used are the one located in SnmpUsmPeer. Be sure to update them. NO Usm discovery is needed when sending trap.

Parameters:

peer - The trap destination.

trapOid - The OID identifying the trap.

list - 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.

IllegalArgumentException - If no SnmpUsmParameters are set.

enableCommunityStringAtContext

boolean enableCommunityStringAtContext()

Activate the community string to context translation. When making SNMP V1 and V2, you can access the scoped MIB. To do so, you need to have a community string of the following form : @. Requests having such a community string will be routed to the scoped MIBs. By default this translation is activated.

Returns:

boolean True, activation succeeded.

disableCommunityStringAtContext

boolean disableCommunityStringAtContext()

Deactivate the community string to context translation. When making SNMP V1 and V2, you can access the scoped MIB. To do so, you need to have a community string of the following form : @. Requests having such a community string will be routed to the scoped MIBs. By default this translation is activated.

Returns:

boolean True, deactivation succeeded.

isCommunityStringAtContextEnabled

boolean isCommunityStringAtContextEnabled()

The community to context translation activation status.

Returns:

boolean True, the translation will be applied on each received SNMP V1 and V2 community string.

getSnmpUnknownSecurityModels

Long getSnmpUnknownSecurityModels()

Returns snmpUnknownSecurityModels as defined in rfc 2572 SNMP-MPD-MIB.

Returns:

snmpUnknownSecurityModels counter.

getSnmpInvalidMsgs

Long getSnmpInvalidMsgs()

Returns snmpInvalidMsgs as defined in rfc 2572 SNMP-MPD-MIB.

Returns:

snmpInvalidMsgs counter.

getSnmpUnknownContexts

Long getSnmpUnknownContexts()

Returns snmpUnknownContexts as defined in rfc 2573 SNMP-TARGET-MIB.

Returns:

snmpUnknownContexts counter.