Skip navigation links

Oracle Fusion Middleware
Java API Reference for Oracle WebLogic Server
12c (12.2.1)

Part Number E55141-01
P4 Change 1723563 on 2015/10/09


weblogic.management.configuration
Interface SNMPProxyMBean

All Superinterfaces:
ConfigurationMBean, DescriptorBean, DynamicMBean, MBeanRegistration, NotificationBroadcaster, SettableBean, WebLogicMBean

public interface SNMPProxyMBean
extends ConfigurationMBean

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


Field Summary
static String AUTH_NOPRIV
          Constant for authNoPriv security level
static String AUTH_PRIV
          Constant for authPriv security level
static String NOAUTH_NOPRIV
          Constant for noAuthNoPriv security level

 

Fields inherited from interface weblogic.management.configuration.ConfigurationMBean
DEFAULT_EMPTY_BYTE_ARRAY

 

Method Summary
abstract  String getCommunity()
          The community name to be passed on for all SNMPv1 requests to this proxied SNMP agent.
abstract  String getOidRoot()
          The root of the object identifier (OID) tree that this proxied SNMP agent controls.
abstract  int getPort()
          The port number on which this proxied SNMP agent is listening.
abstract  String getSecurityLevel()
          The security level that the proxied SNMP agent expects for the specified security name.
abstract  String getSecurityName()
          The user name on whose behalf the WebLogic SNMP agent forwards v3 requests.
abstract  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.
abstract  void setCommunity(String community)
          Sets the value of the Community attribute.
abstract  void setOidRoot(String oid)
          Sets the value of the OidRoot attribute.
abstract  void setPort(int port)
          Sets the value of the Port attribute.
abstract  void setSecurityLevel(String level)
          Sets the security level that the proxied SNMP agent expects for the specified security name.
abstract  void setSecurityName(String securityName)
          Sets the user name on whose behalf the agent forwards v3 requests.
abstract  void setTimeout(long timeout)
          Sets the value of the Timeout attribute.

 

Methods inherited from interface weblogic.management.configuration.ConfigurationMBean
freezeCurrentValue, getId, getInheritedProperties, getName, getNotes, isDynamicallyCreated, isInherited, isSet, restoreDefaultValue, setComments, setDefaultedMBean, setName, setNotes, setPersistenceEnabled, unSet

 

Methods inherited from interface weblogic.management.WebLogicMBean
getMBeanInfo, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setParent

 

Methods inherited from interface javax.management.DynamicMBean
getAttribute, getAttributes, invoke, setAttribute, setAttributes

 

Methods inherited from interface javax.management.MBeanRegistration
postDeregister, postRegister, preDeregister, preRegister

 

Methods inherited from interface javax.management.NotificationBroadcaster
addNotificationListener, getNotificationInfo, removeNotificationListener

 

Methods inherited from interface weblogic.descriptor.DescriptorBean
addPropertyChangeListener, createChildCopyIncludingObsolete, getParentBean, isEditable, removePropertyChangeListener

 

Field Detail

NOAUTH_NOPRIV

static final String NOAUTH_NOPRIV
Constant for noAuthNoPriv security level
See Also:
Constant Field Values

AUTH_NOPRIV

static final String AUTH_NOPRIV
Constant for authNoPriv security level
See Also:
Constant Field Values

AUTH_PRIV

static final String AUTH_PRIV
Constant for authPriv security level
See Also:
Constant Field Values

Method Detail

getPort

int getPort()

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

Returns:
The port value

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

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

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

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.

setSecurityLevel

void setSecurityLevel(String level)
Sets the security level that the proxied SNMP agent expects for the specified security name.

Skip navigation links

Copyright 1996, 2015, Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.

Oracle Fusion Middleware
Java API Reference for Oracle WebLogic Server
12c (12.2.1)

Part Number E55141-01
P4 Change 1723563 on 2015/10/09