org.miloss.fgsms.sla

Class SLACommon

java.lang.Object

org.miloss.fgsms.sla.SLACommon

public class SLACommon
extends Object

Provides a number of key functions that are related to SLA management, alerting, and status setting This does most of the SLA work

Author:

AO

Constructor Summary

Constructors

Constructor and Description
SLACommon()

Method Summary

Methods

Modifier and Type	Method and Description
static void	AlertGlobalAdminsNewPolicyCreated(String agentUsername, String url, boolean pooled, PolicyType p) sends and informative alert to everyone in the database that has the admin role (site admins)
static void	AlertUserSLADeleted(String currentUser, String subscribersUsername, List<String> subscribersEmail, String uRL, String id, boolean pooled) sends an email to email subscribed users for alerts, letting them know that the SLA was deleted, along with their subscription
static void	AlertUserSLASubscribed(String subscribersUsername, List<String> subscribersEmail, SetAlertRegistrationsRequestMsg request, boolean pooled)
protected void	DoAlerts(AlertContainer alert) Handles each alert and calls the corresponding function to process the alert
static String	GenerateManageLink(String uri, String baseurl)
static String	GenerateSubscriptionLink(String property)
static javax.mail.internet.InternetAddress[]	GetAllfgsmsAdminsEmailAddressNotPooled() Deprecated.
static javax.mail.internet.InternetAddress[]	GetAllfgsmsAdminsEmailAddressPooled()
static String	getBundleString(String key) loads a resource from the properties file
static SecurityWrapper	GetClassLevel(boolean pooled)
static void	GetCurrentStatus(boolean pooled, String policyurl, AtomicReference<Boolean> out_status, AtomicReference<Long> out_timestamp, AtomicReference<String> out_message) Gets the current status of an item.
static String	GetHostName() Returns the current machine's hostname using InetAddress.getLocalHost().getHostName().toLowerCase(); The hostname will always be lower case.
static javax.mail.internet.InternetAddress[]	GetSubscribersNotPooled(String guid) Deprecated.
static javax.mail.internet.InternetAddress[]	GetSubscribersPooled(String guid) Returns a list of user's email addresses that are subscribed to a specific SLA with email actions
static boolean	ListContainsStatisticalRules(ArrayOfSLA serviceLevelAggrements)
static List<ServicePolicy>	LoadFederationServicePoliciesPooled() used by Federation Scheduler for publication
static ServicePolicy	LoadPolicyNotPooled(String uRI) Deprecated.
static ServicePolicy	LoadPolicyPooled(String uRI) Loads a policy using a caching mechanism, used by DCS and DAS if the policy does not exist, it will NOT be created
static List<ProcessPolicy>	LoadProcessPoliciesPooledByHostname(String hostname) will never return null, but returned value may be an empty list if no policies are defined
static List<ServicePolicy>	LoadServicePoliciesNotPooled() used by NT SLA for web services
static List<ServicePolicy>	LoadServicePoliciesPooled() used by NT SLA for web services
static Properties	LoadSLAPropertiesNotPooled() Deprecated.
static Properties	LoadSLAPropertiesPooled() returns all of the mail settings, use from pooled connections with jndi
static boolean	PolicyExists(String uri, boolean pooled) Checks for the existence of a policy
static void	ProcessAlerts(String faultMsg, String htmlEncodedFaultMessage, String modifiedurl, String relatedMessageId, long currentTimeMillis, String incidentid, boolean pooled, boolean sendtoAdminsOnly, List<SLAAction> slaActionBaseType, String SLAID, ServicePolicy t, AlertType at) Handles sending of alert messages.
static MachinePolicy	ProcessMachineLevelSLAs(AddMachineAndProcessDataRequestMsg req, boolean pooled)
static List<ProcessPolicy>	ProcessProcessLevelSLAs(AddMachineAndProcessDataRequestMsg req, boolean pooled)
static void	ProcessStatisticalSLARules(AddStatisticalDataRequestMsg req, boolean pooled) processes broker rules for when a queue or topic doesn't exist and QueueOrTopicDoesNotExist, BrokerQueueSizeGreaterThan Map contains the key (topic name), value, size of the queue
static void	RecordSLAFault(AtomicReference<String> faultMsg, String uRL, String relatedMsgID, long timeInMillis, String incidentid, boolean pooled)
static void	TriggerStatusChange(String uri, Boolean oldstatus, String oldmsg, Boolean currenstatus, String s, boolean pooled) Call this function when a monitored item changes status.
static boolean	ValidateSLAs(AtomicReference<String> outmsg, ServicePolicy pol) Returns true if the proposed SLA configuration is valid

Methods inherited from class java.lang.Object

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

Constructor Detail

SLACommon

public SLACommon()

Method Detail

getBundleString

public static String getBundleString(String key)

loads a resource from the properties file

Parameters:

key -

Returns:

GetHostName

public static String GetHostName()

Returns the current machine's hostname using InetAddress.getLocalHost().getHostName().toLowerCase(); The hostname will always be lower case. This function should never throw an exception. If the current machine does not have a valid hostname or it is not dns resolvable, then "ADDRESS_UNKNOWN" is returned

Returns:

LoadServicePoliciesPooled

public static List<ServicePolicy> LoadServicePoliciesPooled()

used by NT SLA for web services

Returns:

either an empty list, or a list containing service policies that contain SLA's

LoadServicePoliciesNotPooled

public static List<ServicePolicy> LoadServicePoliciesNotPooled()

used by NT SLA for web services

Returns:

LoadPolicyPooled

public static ServicePolicy LoadPolicyPooled(String uRI)

Loads a policy using a caching mechanism, used by DCS and DAS if the policy does not exist, it will NOT be created

Parameters:

uRI -

Returns:

LoadPolicyNotPooled

@Deprecated
public static ServicePolicy LoadPolicyNotPooled(String uRI)

Deprecated.

used by qpid agents

Parameters:

uRI -

Returns:

GenerateSubscriptionLink

public static String GenerateSubscriptionLink(String property)

GetSubscribersNotPooled

@Deprecated
public static javax.mail.internet.InternetAddress[] GetSubscribersNotPooled(String guid)

Deprecated.

Returns a list of user's email addresses that are subscribed to a specific SLA with email actions

Parameters:

guid -

Returns:

GetSubscribersPooled

public static javax.mail.internet.InternetAddress[] GetSubscribersPooled(String guid)

Returns a list of user's email addresses that are subscribed to a specific SLA with email actions

Parameters:

guid -

Returns:

TriggerStatusChange

public static void TriggerStatusChange(String uri,
                       Boolean oldstatus,
                       String oldmsg,
                       Boolean currenstatus,
                       String s,
                       boolean pooled)

Call this function when a monitored item changes status. This function will handle all actions related to the change, such as sending emails

Parameters:

uri -

oldstatus -

oldmsg -

currenstatus -

s -

pooled -

RecordSLAFault

public static void RecordSLAFault(AtomicReference<String> faultMsg,
                  String uRL,
                  String relatedMsgID,
                  long timeInMillis,
                  String incidentid,
                  boolean pooled)

LoadSLAPropertiesPooled

public static Properties LoadSLAPropertiesPooled()

returns all of the mail settings, use from pooled connections with jndi

Returns:

LoadSLAPropertiesNotPooled

@Deprecated
public static Properties LoadSLAPropertiesNotPooled()

Deprecated.

returns all of the mail settings, use from nonpooled connections, connections loaded from properties file in common

Returns:

AlertGlobalAdminsNewPolicyCreated

public static void AlertGlobalAdminsNewPolicyCreated(String agentUsername,
                                     String url,
                                     boolean pooled,
                                     PolicyType p)

sends and informative alert to everyone in the database that has the admin role (site admins)

Parameters:

agentUsername -

url -

pooled -

p -

GenerateManageLink

public static String GenerateManageLink(String uri,
                        String baseurl)

AlertUserSLASubscribed

public static void AlertUserSLASubscribed(String subscribersUsername,
                          List<String> subscribersEmail,
                          SetAlertRegistrationsRequestMsg request,
                          boolean pooled)

AlertUserSLADeleted

public static void AlertUserSLADeleted(String currentUser,
                       String subscribersUsername,
                       List<String> subscribersEmail,
                       String uRL,
                       String id,
                       boolean pooled)

sends an email to email subscribed users for alerts, letting them know that the SLA was deleted, along with their subscription

Parameters:

currentUser -

subscribersUsername -

subscribersEmail -

uRL -

id -

pooled -

GetAllfgsmsAdminsEmailAddressNotPooled

@Deprecated
public static javax.mail.internet.InternetAddress[] GetAllfgsmsAdminsEmailAddressNotPooled()

Deprecated.

GetAllfgsmsAdminsEmailAddressPooled

public static javax.mail.internet.InternetAddress[] GetAllfgsmsAdminsEmailAddressPooled()

ListContainsStatisticalRules

public static boolean ListContainsStatisticalRules(ArrayOfSLA serviceLevelAggrements)

LoadProcessPoliciesPooledByHostname

public static List<ProcessPolicy> LoadProcessPoliciesPooledByHostname(String hostname)

will never return null, but returned value may be an empty list if no policies are defined

Parameters:

hostname -

Returns:

ProcessMachineLevelSLAs

public static MachinePolicy ProcessMachineLevelSLAs(AddMachineAndProcessDataRequestMsg req,
                                    boolean pooled)

ProcessProcessLevelSLAs

public static List<ProcessPolicy> ProcessProcessLevelSLAs(AddMachineAndProcessDataRequestMsg req,
                                          boolean pooled)

ProcessStatisticalSLARules

public static void ProcessStatisticalSLARules(AddStatisticalDataRequestMsg req,
                              boolean pooled)

processes broker rules for when a queue or topic doesn't exist and QueueOrTopicDoesNotExist, BrokerQueueSizeGreaterThan Map contains the key (topic name), value, size of the queue

Parameters:

req -

pooled -

ProcessAlerts

public static void ProcessAlerts(String faultMsg,
                 String htmlEncodedFaultMessage,
                 String modifiedurl,
                 String relatedMessageId,
                 long currentTimeMillis,
                 String incidentid,
                 boolean pooled,
                 boolean sendtoAdminsOnly,
                 List<SLAAction> slaActionBaseType,
                 String SLAID,
                 ServicePolicy t,
                 AlertType at)

Handles sending of alert messages. Items are added a queue and processed either via Jboss's worker pool or via a singleton SLA processor thread.

Parameters:

faultMsg - human readable fault message

htmlEncodedFaultMessage - html formatted alert message

modifiedurl - the policy url

relatedMessageId - a related record that caused this action to be trigger, may be null

currentTimeMillis - the time it was trigger

incidentid - a unique identifier for the SLA, it will be recorded using this ID

pooled - are we in jboss and can we use jndi for database lookups?

sendtoAdminsOnly -

slaActionBaseType - the action to trigger

SLAID - the UUID of the SLA Rule/Action set

t - service policy

at - alert type

PolicyExists

public static boolean PolicyExists(String uri,
                   boolean pooled)

Checks for the existence of a policy

Parameters:

uri -

pooled -

Returns:

ValidateSLAs

public static boolean ValidateSLAs(AtomicReference<String> outmsg,
                   ServicePolicy pol)

Returns true if the proposed SLA configuration is valid

Parameters:

outmsg -

pol -

Returns:

LoadFederationServicePoliciesPooled

public static List<ServicePolicy> LoadFederationServicePoliciesPooled()

used by Federation Scheduler for publication

Returns:

either an empty list, or a list containing service policies that contain SLA's

DoAlerts

protected void DoAlerts(AlertContainer alert)

Handles each alert and calls the corresponding function to process the alert

Parameters:

alert -

GetClassLevel

public static SecurityWrapper GetClassLevel(boolean pooled)

GetCurrentStatus

public static void GetCurrentStatus(boolean pooled,
                    String policyurl,
                    AtomicReference<Boolean> out_status,
                    AtomicReference<Long> out_timestamp,
                    AtomicReference<String> out_message)

Gets the current status of an item.

Parameters:

pooled -

policyurl -

out_status - NULL if status is unknown, true = runnning

out_timestamp - NULL if status is unknown, else time since epoch

out_message -

Since:

6.2