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

Part Number E27170-02

weblogic.management.configuration
Interface SNMPTrapDestinationMBean

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

public interface SNMPTrapDestinationMBean
extends ConfigurationMBean

This MBean describes a destination to which an SNMP agent sends SNMP TRAP and INFORM notifications.

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

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
 String getCommunity()
          The password (community name) that a WebLogic Server SNMP agent sends to the SNMP manager when the agent generates SNMPv1 or SNMPv2 notifications.
 String getHost()
          The DNS name or IP address of the computer on which the SNMP manager is running.
 int getPort()
          The UDP port on which the SNMP manager is listening.
 String getSecurityLevel()
          Specifies the security protocols that the SNMP agent uses when sending SNMPv3 responses or notifications to the SNMP manager that this trap destination represents.
 String getSecurityName()
          Specifies the user name that the WebLogic Server SNMP agent encodes into SNMPv3 responses or notifications.
 void setCommunity(String community)
          Sets the value of the Community attribute.
 void setHost(String name)
          Sets the value of the Host attribute.
 void setPort(int port)
          Sets the value of the Port attribute.
 void setSecurityLevel(String level)
           
 void setSecurityName(String securityName)
           
 
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

getHost

String getHost()

The DNS name or IP address of the computer on which the SNMP manager is running.

The WebLogic SNMP agent sends trap notifications to the host and port that you specify.

Returns:
The host value
This method can NOT set a value of zero length.
Default Value:
"localhost"

setHost

void setHost(String name)
             throws InvalidAttributeValueException,
                    ConfigurationException

Sets the value of the Host attribute.

Parameters:
name - The new host value
Throws:
InvalidAttributeValueException
ConfigurationException
See Also:
SNMPTrapDestinationMBean.getHost()

getPort

int getPort()

The UDP port on which the SNMP manager is listening.

Returns:
The port value
Default Value:
162
Maximum Value:
65535
Minimum Value:
1

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:
SNMPTrapDestinationMBean.getPort()

getCommunity

String getCommunity()

The password (community name) that a WebLogic Server SNMP agent sends to the SNMP manager when the agent generates SNMPv1 or SNMPv2 notifications.

The community name that you enter in this trap destination must match the name that the SNMP manager defines.

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:
SNMPTrapDestinationMBean.getCommunity()

getSecurityName

String getSecurityName()

Specifies the user name that the WebLogic Server SNMP agent encodes into SNMPv3 responses or notifications. Requires you to create a credential map for this user name in the WebLogic Server security realm.

The credential map contains an authentication password and an optional privacy password for this user.

The user name and passwords must match the credentials required by the SNMP manager that this trap destination represents.


setSecurityName

void setSecurityName(String securityName)

getSecurityLevel

String getSecurityLevel()

Specifies the security protocols that the SNMP agent uses when sending SNMPv3 responses or notifications to the SNMP manager that this trap destination represents. Requires you to specify a security name for this trap destination.

See Also:
SNMPTrapDestinationMBean.getSecurityName()
This method can NOT set a null value.
Default Value:
SNMPTrapDestinationMBean.NOAUTH_NOPRIV
Valid Values:
SNMPTrapDestinationMBean.NOAUTH_NOPRIV, SNMPTrapDestinationMBean.AUTH_NOPRIV, SNMPTrapDestinationMBean.AUTH_PRIV
Default value in production mode:
SNMPTrapDestinationMBean.AUTH_NOPRIV

setSecurityLevel

void setSecurityLevel(String level)

Copyright 1996, 2013, 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.1.2)

Part Number E27170-02