org.apache.ambari.server.notifications.dispatchers

Class SNMPDispatcher

java.lang.Object

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

All Implemented Interfaces:

NotificationDispatcher

Direct Known Subclasses:

AmbariSNMPDispatcher

public class SNMPDispatcher
extends Object
implements NotificationDispatcher

The SNMPDispatcher class is used to dispatch Notification via SNMP.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	SNMPDispatcher.InvalidSnmpConfigurationException Exception thrown when Notification configuration doesn't contain required properties.
protected static class	SNMPDispatcher.SnmpVersion Supported versions of SNMP
protected static class	SNMPDispatcher.TrapSecurity Possible SNMP security levels

Field Summary

Fields

Modifier and Type	Field and Description
static String	BODY_OID_PROPERTY
static String	COMMUNITY_PROPERTY
static String	PORT_PROPERTY
static String	SECURITY_AUTH_PASSPHRASE_PROPERTY
static String	SECURITY_LEVEL_PROPERTY
static String	SECURITY_PRIV_PASSPHRASE_PROPERTY
static String	SECURITY_USERNAME_PROPERTY
static String	SNMP_VERSION_PROPERTY
static String	SUBJECT_OID_PROPERTY
static String	TRAP_OID_PROPERTY

Constructor Summary

Constructors

Constructor and Description
SNMPDispatcher()
SNMPDispatcher(Integer port) Creates SNMP server with specified port.
SNMPDispatcher(org.snmp4j.Snmp snmp)

Method Summary

Modifier and Type	Method and Description
protected org.snmp4j.Target	createTrapTarget(Notification notification, SNMPDispatcher.SnmpVersion snmpVersion) Creates snmp target with security model corresponding to snmp version.
void	dispatch(Notification notification) Dispatches the specified notification.
protected static String	getDispatchProperty(Map<String,String> dispatchProperties, String key) Get dispatch property with specific key from dispatch properties.
Integer	getPort()
protected SNMPDispatcher.TrapSecurity	getSecurityLevel(Map<String,String> dispatchProperties) Returns SNMPDispatcher.TrapSecurity instance corresponding to dispatch property ambari.dispatch.snmp.security.level from dispatch properties.
protected Set<String>	getSetOfDefaultNeededPropertyNames()
protected SNMPDispatcher.SnmpVersion	getSnmpVersion(Map<String,String> dispatchProperties) Returns SNMPDispatcher.SnmpVersion instance corresponding to dispatch property ambari.dispatch.snmp.version from dispatch properties.
protected org.snmp4j.transport.UdpTransportMapping	getTransportMapping()
String	getType() Gets the type of dispatcher.
boolean	isDigestSupported() Gets whether the dispatcher supports sending a digest or summary in a single Notification.
boolean	isNotificationContentGenerationRequired() Gets whether Ambari should attempt to generate the content of the Notification before giving it to the dispatcher.
protected org.snmp4j.PDU	prepareTrap(Notification notification, SNMPDispatcher.SnmpVersion snmpVersion) Creates protocol data unit (PDU) with corresponding SNMP version for alert notification.
protected void	sendTraps(Notification notification, SNMPDispatcher.SnmpVersion snmpVersion) Creates trap based on alerts notification and sends it to hosts specified in recipients list.
TargetConfigurationResult	validateTargetConfig(Map<String,Object> properties) Validates alert target configuration.

Methods inherited from class java.lang.Object

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

Field Detail

BODY_OID_PROPERTY

public static final String BODY_OID_PROPERTY

See Also:

Constant Field Values

SUBJECT_OID_PROPERTY

public static final String SUBJECT_OID_PROPERTY

See Also:

Constant Field Values

TRAP_OID_PROPERTY

public static final String TRAP_OID_PROPERTY

See Also:

Constant Field Values

PORT_PROPERTY

public static final String PORT_PROPERTY

See Also:

Constant Field Values

SNMP_VERSION_PROPERTY

public static final String SNMP_VERSION_PROPERTY

See Also:

Constant Field Values

COMMUNITY_PROPERTY

public static final String COMMUNITY_PROPERTY

See Also:

Constant Field Values

SECURITY_USERNAME_PROPERTY

public static final String SECURITY_USERNAME_PROPERTY

See Also:

Constant Field Values

SECURITY_AUTH_PASSPHRASE_PROPERTY

public static final String SECURITY_AUTH_PASSPHRASE_PROPERTY

See Also:

Constant Field Values

SECURITY_PRIV_PASSPHRASE_PROPERTY

public static final String SECURITY_PRIV_PASSPHRASE_PROPERTY

See Also:

Constant Field Values

SECURITY_LEVEL_PROPERTY

public static final String SECURITY_LEVEL_PROPERTY

See Also:

Constant Field Values

Constructor Detail

SNMPDispatcher

public SNMPDispatcher(org.snmp4j.Snmp snmp)

SNMPDispatcher

public SNMPDispatcher()
               throws IOException

Throws:

IOException

SNMPDispatcher

public SNMPDispatcher(Integer port)
               throws IOException

Creates SNMP server with specified port. In case port is null will be used random value as default

Parameters:

port - port

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

Returns:

the dispatcher's type (never null).

isNotificationContentGenerationRequired

public boolean isNotificationContentGenerationRequired()

Gets whether Ambari should attempt to generate the content of the Notification before giving it to the dispatcher. Some dispatchers may choose to format data in a way which is not easily represented in the {alert-templates.xml}.

If false then the Notification will only contain the recipients and a map of properties for the dispatcher to use.

Specified by:

isNotificationContentGenerationRequired in interface NotificationDispatcher

Returns:

true if Ambari should generate the Notification content, false otherwise.

dispatch

public void dispatch(Notification notification)

Dispatches the specified notification.

Specified by:

dispatch in interface NotificationDispatcher

Parameters:

notification - the notificationt to dispatch (not null).

validateTargetConfig

public TargetConfigurationResult validateTargetConfig(Map<String,Object> properties)

Validates alert target configuration. Checks if it can dispatch notifications with given properties set.

Specified by:

validateTargetConfig in interface NotificationDispatcher

Parameters:

properties - alert target properties

Returns:

ConfigValidationResult with validation status and message

getSetOfDefaultNeededPropertyNames

protected Set<String> getSetOfDefaultNeededPropertyNames()

Returns:

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

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.

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.

sendTraps

protected void sendTraps(Notification notification,
                         SNMPDispatcher.SnmpVersion snmpVersion)
                  throws SNMPDispatcher.InvalidSnmpConfigurationException,
                         IOException

Creates trap based on alerts notification and sends it to hosts specified in recipients list.

Parameters:

notification - alert notification to dispatch

snmpVersion - SNMP version

Throws:

SNMPDispatcher.InvalidSnmpConfigurationException - if notification's dispatch properties don't contain any of required properties or recipient list is empty.

IOException - if the SNMP trap could not be sent

createTrapTarget

protected org.snmp4j.Target createTrapTarget(Notification notification,
                                             SNMPDispatcher.SnmpVersion snmpVersion)
                                      throws SNMPDispatcher.InvalidSnmpConfigurationException

Creates snmp target with security model corresponding to snmp version.

Parameters:

notification - alerts notification

snmpVersion - SNMP version

Returns:

target with corresponding security model

Throws:

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

isDigestSupported

public boolean isDigestSupported()

Gets whether the dispatcher supports sending a digest or summary in a single Notification. Some providers may not allow the Notification to contain information on more than a single event.

Specified by:

isDigestSupported in interface NotificationDispatcher

Returns:

true if digest is supported, false otherwise.

getDispatchProperty

protected static String getDispatchProperty(Map<String,String> dispatchProperties,
                                            String key)
                                     throws SNMPDispatcher.InvalidSnmpConfigurationException

Get dispatch property with specific key from dispatch properties.

Parameters:

dispatchProperties - dispatch properties

key - property key

Returns:

property value

Throws:

SNMPDispatcher.InvalidSnmpConfigurationException - if property with such key does not exist

getSnmpVersion

protected SNMPDispatcher.SnmpVersion getSnmpVersion(Map<String,String> dispatchProperties)
                                             throws SNMPDispatcher.InvalidSnmpConfigurationException

Returns SNMPDispatcher.SnmpVersion instance corresponding to dispatch property ambari.dispatch.snmp.version from dispatch properties.

Parameters:

dispatchProperties - dispatch properties

Returns:

corresponding SnmpVersion instance

Throws:

SNMPDispatcher.InvalidSnmpConfigurationException - if dispatch properties doesn't contain required property

getSecurityLevel

protected SNMPDispatcher.TrapSecurity getSecurityLevel(Map<String,String> dispatchProperties)
                                                throws SNMPDispatcher.InvalidSnmpConfigurationException

Returns SNMPDispatcher.TrapSecurity instance corresponding to dispatch property ambari.dispatch.snmp.security.level from dispatch properties.

Parameters:

dispatchProperties - dispatch properties

Returns:

corresponding TrapSecurity instance

Throws:

SNMPDispatcher.InvalidSnmpConfigurationException - if dispatch properties doesn't contain required property

getPort

public Integer getPort()

getTransportMapping

protected org.snmp4j.transport.UdpTransportMapping getTransportMapping()