org.miloss.fgsms.sla.actions

Class AMQPAlerter

java.lang.Object

org.miloss.fgsms.sla.actions.AMQPAlerter

All Implemented Interfaces:

PluginCommon, SLAActionInterface

public class AMQPAlerter
extends Object
implements SLAActionInterface

Uses the Qpid AMQP client library to publish alerts

Since:

5.0, major refactor since 6.3

Author:

AO

Constructor Summary

Constructors

Constructor and Description
AMQPAlerter()

Method Summary

Methods

Modifier and Type	Method and Description
List<PolicyType>	GetAppliesTo() Returns a list of service policy types that this plugin can be applied to use Utility.getAllPolicyTypes() if it applies to everything.
String	GetDisplayName() end user facing display name
String	GetHtmlFormattedHelp() returns html formatted help to guide users towards proper usage.
List<NameValuePair>	GetOptionalParameters() returns a list of optional parameters
List<NameValuePair>	GetRequiredParameters() returns a list of required parameters
void	ProcessAction(AlertContainer alert) sends an alert using the AMQP APIs (not JMS) Calls ProcessActionRet(alert)
void	ProcessAction(AlertContainer alert, List<NameValuePair> params) Process an action.
boolean	ProcessActionRet(AlertContainer alert) Returns true if the message was delivered successfully
boolean	ValidateConfiguration(List<NameValuePair> params, AtomicReference<String> outError) validates the configuration before saving it.

Methods inherited from class java.lang.Object

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

Constructor Detail

AMQPAlerter

public AMQPAlerter()

Method Detail

ProcessAction

public void ProcessAction(AlertContainer alert)

sends an alert using the AMQP APIs (not JMS) Calls ProcessActionRet(alert)

ProcessActionRet

public boolean ProcessActionRet(AlertContainer alert)

Returns true if the message was delivered successfully

Parameters:

alert -

Returns:

GetRequiredParameters

public List<NameValuePair> GetRequiredParameters()

Description copied from interface: PluginCommon

returns a list of required parameters

Specified by:

GetRequiredParameters in interface PluginCommon

Returns:

GetOptionalParameters

public List<NameValuePair> GetOptionalParameters()

Description copied from interface: PluginCommon

returns a list of optional parameters

Specified by:

GetOptionalParameters in interface PluginCommon

Returns:

ValidateConfiguration

public boolean ValidateConfiguration(List<NameValuePair> params,
                            AtomicReference<String> outError)

Description copied from interface: SLAActionInterface

validates the configuration before saving it. This is called by both the user interface as well as whenever someone attempts to add or change a service policy containing this federation target.

Specified by:

ValidateConfiguration in interface SLAActionInterface

Returns:

True if the configuration is valid, false otherwise

GetHtmlFormattedHelp

public String GetHtmlFormattedHelp()

Description copied from interface: PluginCommon

returns html formatted help to guide users towards proper usage. Always include the following fields

• Applies to - what policies types it applies to
• Required and optional parameters
• Description
• State if this is processed as data comes in, or periodically (some aggregated data)

Html is allowed, javascript is not

Specified by:

GetHtmlFormattedHelp in interface PluginCommon

Returns:

GetDisplayName

public String GetDisplayName()

Description copied from interface: PluginCommon

end user facing display name

Specified by:

GetDisplayName in interface PluginCommon

Returns:

ProcessAction

public void ProcessAction(AlertContainer alert,
                 List<NameValuePair> params)

Description copied from interface: SLAActionInterface

Process an action. This could do anything you want it to do. Such as call a web service, send an email, an SMS or a JMS message.

This function should never throw an unhandled exception. Please do your best.

Here's a few useful examples for getting configuration settings from fgsms that you'll probably need that aren't provided with the parameters to this interface.

Get Configurating Settings, also (General Settings from the GUI)

As a developer, you have two choices for getting access to properties that can be used to accomplish your tasks.

1. Access the General Settings table from the fgsms config database. The General Settings capability of fgsms (as of 6.0) provides access to global settings that can be used for any purpose. Each setting is easily configurable via web service or via the web user interfaces fgsmsWeb and fgsmsBootstrap. These settings are per instance of fgsms, which translates to per configuration database. See the example below for a how-to.
2. Access the Per SLA Plugin Action settings - These settings are configured Per Service, Per SLA, Per SLA Plugin Action. These can be configured via web service SetServicePolicyRequestMsg. You can access this through the parameter parameterNameValue.

Example: Obtaining General Settings (per fgsms instance)

 String val=null;
 KeyNameValueEnc setting = DBSettingsLoader.GetPropertiesFromDB(true, "MyPlugin", "MyName");
 if (setting!=null && setting.getKeyNameValue()!=null)
 {
   val=setting.getKeyNameValue().getPropertyValue();
 }
 //use val for something, log if it's null
 

Note: The value could be encrypted.

Encrypting/Decrypting a setting

When obtaining general settings, or perhaps in per SLA Action settings, passwords and other sensitive data may need to be stored. If it is encrypted using fgsms's encryption module (AES256), it can be decrypted using the following example. If the key is not encrypted, the original value is returned. See the documentation from Utility. Use care when decrypting sensitive data, this data should not remain in memory for extended periods of time in an unencrypted state

 String val=Utility.DE(val);
 

Audit Logging

AuditLogger.LogItem(this.getClass().getCanonicalName(), "CheckRule", "system", "my message", new SecurityWrapper(), null);
 

Getting the status of something

Sometimes alerts are triggered on a status change, but it's may not be obvious as to whether the current status is OK or not. Use the following code snippet to make that determination. Null values may be returned depending on whether or not status information is available.

   SLACommon.GetCurrentStatus((boolean pooled, String policyurl, Boolean out_status, Long out_timestamp, String out_message);
 

Open the fgsms databases

 Connection con = Utility.GetPerformanceDBConnection();
 //or use Utility.ConfigurationDBConnection(); for the configuration database
 try {
 // do something
 } catch (Exception ex) {
 // log some message
 } finally {
 if (con != null) {
 try {
 con.close();
 } catch (Exception e) {
 }
 }
 }
 

Specified by:

ProcessAction in interface SLAActionInterface

Parameters:

alert - This alert container has a reference to the policy. Do not make modifications to it, unpredictable results may occur. Also provided is a human readable fault message, the actual Rule(s) that caused the trigger to occur, (note: this may be another plugin) and various other parameters. The AlertContainer should never be null.

See Also:

AlertContainer, RuleBaseType, Utility, AuditLogger, DBSettingsLoader, SLACommon, SetServicePolicyRequestMsg, ServicePolicy, org.miloss.fgsms.services.interfaces.policyconfiguration.SLAActionGeneric, SLA

GetAppliesTo

public List<PolicyType> GetAppliesTo()

Description copied from interface: PluginCommon

Returns a list of service policy types that this plugin can be applied to use Utility.getAllPolicyTypes() if it applies to everything. Also Utility.IsContains()

Specified by:

GetAppliesTo in interface PluginCommon

Returns: