weblogic.management.configuration
Interface SNMPProxyMBean

All Superinterfaces:

ConfigurationMBean

public interface SNMPProxyMBean
extends ConfigurationMBean

This MBean represents an SNMP agent that is proxied by a WebLogic Server SNMP agent.

Deprecation of MBeanHome and Type-Safe Interfaces

This is a type-safe interface for a WebLogic Server MBean, which you can import into your client classes and access through weblogic.management.MBeanHome. As of 9.0, the MBeanHome interface and all type-safe interfaces for WebLogic Server MBeans are deprecated. Instead, client classes that interact with WebLogic Server MBeans should use standard JMX design patterns in which clients use the javax.management.MBeanServerConnection interface to discover MBeans, attributes, and attribute types at runtime. For more information, see "Developing Manageable Applications with JMX."

Changes take effect after you redeploy the module or restart the server.

NOAUTH_NOPRIV

static final String NOAUTH_NOPRIV

Constant for noAuthNoPriv security level

AUTH_NOPRIV

static final String AUTH_NOPRIV

Constant for authNoPriv security level

AUTH_PRIV

static final String AUTH_PRIV

Constant for authPriv security level

getPort

int getPort()

The port number on which this proxied SNMP agent is listening.

Returns:

The port value

Maximum Value:

65535

Minimum Value:

0

setPort

void setPort(int port)
             throws InvalidAttributeValueException,
                    ConfigurationException

Sets the value of the Port attribute.

Parameters:

port - The new port value

Throws:

InvalidAttributeValueException

ConfigurationException

See Also:

SNMPProxyMBean.getPort()

getOidRoot

String getOidRoot()

The root of the object identifier (OID) tree that this proxied SNMP agent controls.

Returns:

The oidRoot value

This method can NOT set a value of zero length.

setOidRoot

void setOidRoot(String oid)
                throws InvalidAttributeValueException,
                       ConfigurationException

Sets the value of the OidRoot attribute.

Parameters:

oid - The new oidRoot value

Throws:

InvalidAttributeValueException

ConfigurationException

See Also:

SNMPProxyMBean.getOidRoot()

getCommunity

String getCommunity()

The community name to be passed on for all SNMPv1 requests to this proxied SNMP agent.

If you specify a security name for this proxied agent, the WebLogic SNMP agent ignores this community name. Instead, the agent encodes the security name in an SNMPv3 request and forwards the SNMPv3 request to this proxied agent.

Returns:

The community value

This method can NOT set a value of zero length.

Default Value:

"public"

setCommunity

void setCommunity(String community)
                  throws InvalidAttributeValueException,
                         ConfigurationException

Sets the value of the Community attribute.

Parameters:

community - The new community value

Throws:

InvalidAttributeValueException

ConfigurationException

See Also:

SNMPProxyMBean.getCommunity()

getTimeout

long getTimeout()

The number of milliseconds that the WebLogic Server SNMP agent waits for a response to requests that it forwards to this proxy agent.

If the interval elapses without a response, the WebLogic SNMP agent sends an error to the requesting manager.

Returns:

The timeout value

Default Value:

5000

Minimum Value:

0

setTimeout

void setTimeout(long timeout)
                throws InvalidAttributeValueException,
                       ConfigurationException

Sets the value of the Timeout attribute.

Parameters:

timeout - The new timeout value

Throws:

InvalidAttributeValueException

ConfigurationException

See Also:

SNMPProxyMBean.getTimeout()

getSecurityName

String getSecurityName()

The user name on whose behalf the WebLogic SNMP agent forwards v3 requests. If not specified, the request is forwarded as a v1 request.

If you specify a security name, you must also specify a security level that is equal to or lower than the security level that is configured for communication between the WebLogic SNMP agent and SNMP managers. For example, if the WebLogic SNMP agent requires incoming SNMPv3 requests to use the authentication protocol but no privacy protocol, the security level for this proxy must be either Authentication Only or None. Note that if you want to use the authorization or privacy protocols, you must configure credential mapping in the WebLogic Server security realm.

The WebLogic SNMP agent cannot forward or pass through the credentials that are contained in SNMPv3 requests from SNMP managers. Instead, the agent authenticates and performs other security operations on incoming requests, and then constructs a new request to forward to a proxied agent.

See Also:

SNMPProxyMBean.getSecurityLevel(), SNMPProxyMBean.getCommunity()

setSecurityName

void setSecurityName(String securityName)

Sets the user name on whose behalf the agent forwards v3 requests.

Parameters:

securityName -

getSecurityLevel

String getSecurityLevel()

The security level that the proxied SNMP agent expects for the specified security name.

This method can NOT set a null value.

Default Value:

SNMPProxyMBean.NOAUTH_NOPRIV

Valid Values:

SNMPProxyMBean.NOAUTH_NOPRIV, SNMPProxyMBean.AUTH_NOPRIV, SNMPProxyMBean.AUTH_PRIV

Default value in production mode:

SNMPProxyMBean.AUTH_NOPRIV

setSecurityLevel

void setSecurityLevel(String level)

Sets the security level that the proxied SNMP agent expects for the specified security name.