org.apache.ambari.server.notifications.dispatchers

Class AmbariSNMPDispatcher

java.lang.Object

org.apache.ambari.server.notifications.dispatchers.SNMPDispatcher

org.apache.ambari.server.notifications.dispatchers.AmbariSNMPDispatcher

All Implemented Interfaces:

NotificationDispatcher

public class AmbariSNMPDispatcher
extends SNMPDispatcher

The AmbariSNMPDispatcher class is used to dispatch AlertNotification via SNMP using predefined Ambari OIDs.

The base OID for Ambari is 1.3.6.1.4.1.18060.16. Off of this, we define the following:
 .0 - apacheAmbariTraps
 .1 - apacheAmbariAlerts
 From these two roots, we define other bindings:
 .1.1 - apacheAmbariAlertTable
 .1.1.1 - apacheAmbariAlertEntry
 .1.1.1.2 - alertDefinitionName
 

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.ambari.server.notifications.dispatchers.SNMPDispatcher

SNMPDispatcher.InvalidSnmpConfigurationException, SNMPDispatcher.SnmpVersion, SNMPDispatcher.TrapSecurity

Field Summary

Fields

Modifier and Type	Field and Description
static String	AMBARI_ALERT_COMPONENT_NAME_OID
static String	AMBARI_ALERT_DEFINITION_HASH_OID
static String	AMBARI_ALERT_DEFINITION_ID_OID
static String	AMBARI_ALERT_DEFINITION_NAME_OID
static String	AMBARI_ALERT_ENTRY_OID
static String	AMBARI_ALERT_HOST_NAME_OID
static String	AMBARI_ALERT_NAME_OID
static String	AMBARI_ALERT_SERVICE_NAME_OID
static String	AMBARI_ALERT_STATE_OID
static String	AMBARI_ALERT_TABLE_OID
static String	AMBARI_ALERT_TEXT_OID
static String	AMBARI_ALERT_TRAP_OID
static String	AMBARI_ALERTS_OID
static String	APACHE_AMBARI_TRAPS_OID
static String	BASE_AMBARI_OID

Fields inherited from class org.apache.ambari.server.notifications.dispatchers.SNMPDispatcher

BODY_OID_PROPERTY, COMMUNITY_PROPERTY, PORT_PROPERTY, SECURITY_AUTH_PASSPHRASE_PROPERTY, SECURITY_LEVEL_PROPERTY, SECURITY_PRIV_PASSPHRASE_PROPERTY, SECURITY_USERNAME_PROPERTY, SNMP_VERSION_PROPERTY, SUBJECT_OID_PROPERTY, TRAP_OID_PROPERTY

Constructor Summary

Constructors

Modifier	Constructor and Description
	AmbariSNMPDispatcher(Integer port)
protected	AmbariSNMPDispatcher(org.snmp4j.Snmp snmp)

Method Summary

Modifier and Type	Method and Description
protected Set<String>	getSetOfDefaultNeededPropertyNames()
String	getType() Gets the type of dispatcher.
protected org.snmp4j.PDU	prepareTrap(Notification notification, SNMPDispatcher.SnmpVersion snmpVersion) Creates protocol data unit (PDU) with corresponding SNMP version for alert notification.

Methods inherited from class org.apache.ambari.server.notifications.dispatchers.SNMPDispatcher

createTrapTarget, dispatch, getDispatchProperty, getPort, getSecurityLevel, getSnmpVersion, getTransportMapping, isDigestSupported, isNotificationContentGenerationRequired, sendTraps, validateTargetConfig

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

BASE_AMBARI_OID

public static final String BASE_AMBARI_OID

See Also:

Constant Field Values

APACHE_AMBARI_TRAPS_OID

public static final String APACHE_AMBARI_TRAPS_OID

See Also:

Constant Field Values

AMBARI_ALERT_TRAP_OID

public static final String AMBARI_ALERT_TRAP_OID

See Also:

Constant Field Values

AMBARI_ALERTS_OID

public static final String AMBARI_ALERTS_OID

See Also:

Constant Field Values

AMBARI_ALERT_TABLE_OID

public static final String AMBARI_ALERT_TABLE_OID

See Also:

Constant Field Values

AMBARI_ALERT_ENTRY_OID

public static final String AMBARI_ALERT_ENTRY_OID

See Also:

Constant Field Values

AMBARI_ALERT_DEFINITION_ID_OID

public static final String AMBARI_ALERT_DEFINITION_ID_OID

See Also:

Constant Field Values

AMBARI_ALERT_DEFINITION_NAME_OID

public static final String AMBARI_ALERT_DEFINITION_NAME_OID

See Also:

Constant Field Values

AMBARI_ALERT_DEFINITION_HASH_OID

public static final String AMBARI_ALERT_DEFINITION_HASH_OID

See Also:

Constant Field Values

AMBARI_ALERT_NAME_OID

public static final String AMBARI_ALERT_NAME_OID

See Also:

Constant Field Values

AMBARI_ALERT_TEXT_OID

public static final String AMBARI_ALERT_TEXT_OID

See Also:

Constant Field Values

AMBARI_ALERT_STATE_OID

public static final String AMBARI_ALERT_STATE_OID

See Also:

Constant Field Values

AMBARI_ALERT_HOST_NAME_OID

public static final String AMBARI_ALERT_HOST_NAME_OID

See Also:

Constant Field Values

AMBARI_ALERT_SERVICE_NAME_OID

public static final String AMBARI_ALERT_SERVICE_NAME_OID

See Also:

Constant Field Values

AMBARI_ALERT_COMPONENT_NAME_OID

public static final String AMBARI_ALERT_COMPONENT_NAME_OID

See Also:

Constant Field Values

Constructor Detail

AmbariSNMPDispatcher

protected AmbariSNMPDispatcher(org.snmp4j.Snmp snmp)

AmbariSNMPDispatcher

public AmbariSNMPDispatcher(Integer port)
                     throws IOException

Throws:

IOException

Method Detail

getType

public String getType()

Gets the type of dispatcher. The type of each different dispatcher should be unique.

Specified by:

getType in interface NotificationDispatcher

Overrides:

getType in class SNMPDispatcher

Returns:

the dispatcher's type (never null).

prepareTrap

protected org.snmp4j.PDU prepareTrap(Notification notification,
                                     SNMPDispatcher.SnmpVersion snmpVersion)
                              throws SNMPDispatcher.InvalidSnmpConfigurationException

Creates protocol data unit (PDU) with corresponding SNMP version for alert notification. Uses default Ambari OIDs

Overrides:

prepareTrap in class SNMPDispatcher

Parameters:

notification - alert notification to dispatch

snmpVersion - SNMP version

Returns:

PDU containing notification info

Throws:

SNMPDispatcher.InvalidSnmpConfigurationException - if notification's dispatch properties don't contain any of required properties.

getSetOfDefaultNeededPropertyNames

protected Set<String> getSetOfDefaultNeededPropertyNames()

Overrides:

getSetOfDefaultNeededPropertyNames in class SNMPDispatcher

Returns:

Set that contains names of properties that are needed for all SNMP configurations.