org.miloss.fgsms.plugins.sla

Interface SLAActionInterface

All Superinterfaces:

PluginCommon

All Known Implementing Classes:

AMQPAlerter, CustomSLAAction, EmailAlerter, JMSAlerter, SimpleMulticastAlerter, SLAActionLog, SLAActionRestart, SLAActionRunScript, UpdateUddiRegistration, WSNotificationAlerter

public interface SLAActionInterface
extends PluginCommon

Service Level Agreement Action Plugin Interface - This will allow developers to add custom actions into fgsms. *

All implementations should be stateless

Deployment Instructions

To deploy your own implementation of an SLAActionInterface implementation, build your jar file and any supporting jars and copy them to each fgsms server that contains fgsms.AuxServices.war and fgsmsServices.war in the WEB-INF/lib folder. For actions that apply to agents, also copy your files to the lib folder of each supported agent and then update the classpath (if necessary).

To use your implementation

Use the PCS web service to set the service policy for a specific web service, adding an SLA with at least one rule and an action as SLAAction. Use SLAAction to define the implementing class as your implementing class. Optional, provide any context variables. This can also be done from fgsmsWeb and fgsmsBootstrap web user interfaces.

Note: SLA Actions can be processed at the fgsms server or at the Agent.

Since:

6.2, heavily modified at 6.3

Author:

AO

See Also:

PCS, SLARuleGeneric, SLARuleInterface, SLAAction

Method Summary

Methods

Modifier and Type	Method and Description
void	ProcessAction(AlertContainer alert, List<NameValuePair> params) Process an action.
boolean	ValidateConfiguration(List<NameValuePair> params, AtomicReference<String> outError) validates the configuration before saving it.

Methods inherited from interface org.miloss.fgsms.plugins.PluginCommon

GetAppliesTo, GetDisplayName, GetHtmlFormattedHelp, GetOptionalParameters, GetRequiredParameters

Method Detail

ProcessAction

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

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) {
 }
 }
 }
 

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.

params -

See Also:

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

ValidateConfiguration

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

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.

Parameters:

params -

outError -

Returns:

True if the configuration is valid, false otherwise

Since:

6.3