BEA Systems, Inc.

WebLogic Server 8.1 API Reference

weblogic.management.configuration
Interface SNMPProxyMBean


public interface SNMPProxyMBean
extends ConfigurationMBean

The MBean representing the SNMP agents to be proxied by the current one.

Author:
Copyright © 2002 BEA Systems, Inc. All Rights Reserved.

Field Summary
static long CACHING_STUB_SVUID
          Description of the Field
 
Fields inherited from class weblogic.management.configuration.ConfigurationMBean
CACHING_STUB_SVUID
 
Method Summary
 java.lang.String getCommunity()
          Defines the community name to be passed on for all requests to the proxied agent.
 java.lang.String getOidRoot()
          Defines the root of the OID tree on which the proxied agent responds.
 int getPort()
          Defines the Port number used for communication with the other SNMP Agents.
 long getTimeout()
          Defines the time interval that the WebLogic SNMP proxy agent waits for a response to requests forwarded to another SNMP agent.
 void setCommunity(java.lang.String community)
          Sets the community attribute of the SNMPProxyMBean object
 void setOidRoot(java.lang.String oid)
          Sets the oidRoot attribute of the SNMPProxyMBean object
 void setPort(int port)
          Sets the port attribute of the SNMPProxyMBean object
 void setTimeout(long timeout)
          Sets the timeout attribute of the SNMPProxyMBean object
 
Methods inherited from interface weblogic.management.configuration.ConfigurationMBean
freezeCurrentValue, getNotes, restoreDefaultValue, setComments, setDefaultedMBean, setNotes, setPersistenceEnabled
 
Methods inherited from interface weblogic.management.WebLogicMBean
getMBeanInfo, getName, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setName, setParent
 
Methods inherited from interface javax.management.DynamicMBean
getAttribute, getAttributes, invoke, setAttribute, setAttributes
 
Methods inherited from interface javax.management.MBeanRegistration
postDeregister, postRegister, preRegister
 
Methods inherited from interface javax.management.NotificationBroadcaster
addNotificationListener, getNotificationInfo, removeNotificationListener
 

Field Detail

CACHING_STUB_SVUID

public static final long CACHING_STUB_SVUID
Description of the Field
Method Detail

getPort

public int getPort()
Defines the Port number used for communication with the other SNMP Agents.

Legal Minimum Value: 0
Legal Maximum Value: 65535
Returns:
The port value

setPort

public void setPort(int port)
             throws javax.management.InvalidAttributeValueException,
                    ConfigurationException
Sets the port attribute of the SNMPProxyMBean object

Parameters:
port - The new port value
Throws:
javax.management.InvalidAttributeValueException - Description of the Exception
ConfigurationException - Description of the Exception

getOidRoot

public java.lang.String getOidRoot()
Defines the root of the OID tree on which the proxied agent responds.

Legal Value: (value != null) && (value.trim().length() > 0)
Returns:
The oidRoot value

setOidRoot

public void setOidRoot(java.lang.String oid)
                throws javax.management.InvalidAttributeValueException,
                       ConfigurationException
Sets the oidRoot attribute of the SNMPProxyMBean object

Parameters:
oid - The new oidRoot value
Throws:
javax.management.InvalidAttributeValueException - Description of the Exception
ConfigurationException - Description of the Exception

getCommunity

public java.lang.String getCommunity()
Defines the community name to be passed on for all requests to the proxied agent. Default value is the community name contained in incoming SNMP requests to the Master SNMP agent.

Default Value: "na"
Legal Value: (value != null) && (value.trim().length() > 0)
Returns:
The community value

setCommunity

public void setCommunity(java.lang.String community)
                  throws javax.management.InvalidAttributeValueException,
                         ConfigurationException
Sets the community attribute of the SNMPProxyMBean object

Parameters:
community - The new community value
Throws:
javax.management.InvalidAttributeValueException - Description of the Exception
ConfigurationException - Description of the Exception

getTimeout

public long getTimeout()
Defines the time interval that the WebLogic SNMP proxy agent waits for a response to requests forwarded to another SNMP agent. If the interval elapses without a response, the WebLogic SNMP agent sends an error to the requesting manager.

Default Value: 5000
Legal Minimum Value: 0
Returns:
The timeout value

setTimeout

public void setTimeout(long timeout)
                throws javax.management.InvalidAttributeValueException,
                       ConfigurationException
Sets the timeout attribute of the SNMPProxyMBean object

Parameters:
timeout - The new timeout value
Throws:
javax.management.InvalidAttributeValueException - Description of the Exception
ConfigurationException - Description of the Exception

Documentation is available at
http://download.oracle.com/docs/cd/E13222_01/wls/docs81b