AlertContainer (Fine Grained Service Monitoring System 7.0.0 API)

java.lang.Object
- org.miloss.fgsms.plugins.sla.AlertContainer

```
public class AlertContainer
extends Object
```
A simple structure to make the processing of alerting easier fgsms processes alerts asynchronously either via a Singleton message processor that runs in a separate thread or via Jboss's Work Manager, depending on what's available. This container specifies everything necessary for an implementation action class to successfully process the action.

Since:

6.0

Author:

AO

See Also:
org.miloss.fgsms.helper.SLACommon, org.miloss.fgsms.helper.SLAProcessorSingleton, WorkManager

Field Summary

Fields
Modifier and Type	Field and Description
`protected SituationCategoryType`	`alerttype` This is the type of alert, generally speaking, a performance or status report
`protected long`	`currentTimeMillis` The time this even occurred.
`protected String`	`faultMsg` The fault message is usually a high readable string
`protected String`	`htmlEncodedFaultMessage` This is an html encoded fault message, usually with formatting for an email message or something similar.
`protected String`	`incidentid` a unique UUID of this alert, with is also recorded in the SLA table of the performance database.
`protected String`	`modifiedurl` The url of the fgsms policy that this alert is related to
`protected boolean`	`pooled` indicates that the current context is running inside of jboss, useful for accessing database connections
`protected String`	`relatedMessageId` This is the id of the transaction that caused the SLA rule to trigger.
`protected boolean`	`sendtoAdminsOnly`
`protected SLAAction`	`slaActionBaseType` A reference to the action that will be processed by this alert container.
`protected String`	`SLAID` this is the UUID of the SLA Rule/Action set.
`protected ServicePolicy`	`t` a reference to the service policy for this object, do not modify it

Constructor Summary

Constructors
Constructor and Description
`AlertContainer(String faultMsg, String htmlEncodedFaultMessage, String modifiedurl, String relatedMessageId, long currentTimeMillis, String incidentid, boolean pooled, boolean sendtoAdminsOnly, SLAAction slaActionBaseType, String SLAID, ServicePolicy t, SituationCategoryType typeofalert)` creates a new alert container

Method Summary

Methods
Modifier and Type	Method and Description
`SituationCategoryType`	`getAlerttype()` This is the type of alert, generally speaking, a performance or status report
`long`	`getCurrentTimeMillis()` The time this even occurred.
`String`	`getFaultMsg()` The fault message is usually a high readable string
`String`	`getHtmlEncodedFaultMessage()` This is an html encoded fault message, usually with formatting for an email message or something similar.
`String`	`getIncidentid()` a unique UUID of this alert, with is also recorded in the SLA table of the performance database.
`String`	`getModifiedurl()` The url of the fgsms policy that this alert is related to
`String`	`getRelatedMessageId()` This is the id of the transaction that caused the SLA rule to trigger.
`ServicePolicy`	`getServicePolicy()` a reference to the service policy for this object, do not modify it
`SLAAction`	`getSlaActionBaseType()` A reference to the action that will be processed by this alert container.
`String`	`getSLAID()` this is the UUID of the SLA Rule/Action set.
`boolean`	`isPooled()` indicates that the current context is running inside of jboss, useful for accessing database connections
`boolean`	`isSendtoAdminsOnly()` A reference to the action that will be processed by this alert container.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - alerttype
```
protected SituationCategoryType alerttype
```
    This is the type of alert, generally speaking, a performance or status report
    
    See Also:
    PerformanceReport, AvailabilitySituation
  - faultMsg
```
protected String faultMsg
```
    The fault message is usually a high readable string
  - htmlEncodedFaultMessage
```
protected String htmlEncodedFaultMessage
```
    This is an html encoded fault message, usually with formatting for an email message or something similar.
  - modifiedurl
```
protected String modifiedurl
```
    The url of the fgsms policy that this alert is related to
  - relatedMessageId
```
protected String relatedMessageId
```
    This is the id of the transaction that caused the SLA rule to trigger. There is no guarantee that this is defined. This ID is a UUID that may relate to a web service transaction, an availability ID or something else.
  - currentTimeMillis
```
protected long currentTimeMillis
```
    The time this even occurred. fgsms processes SLAs asynchronously
  - incidentid
```
protected String incidentid
```
    a unique UUID of this alert, with is also recorded in the SLA table of the performance database.
  - pooled
```
protected boolean pooled
```
    indicates that the current context is running inside of jboss, useful for accessing database connections
  - sendtoAdminsOnly
```
protected boolean sendtoAdminsOnly
```
  - slaActionBaseType
```
protected SLAAction slaActionBaseType
```
    A reference to the action that will be processed by this alert container. This is used for asynchronous processes, do not modify
  - SLAID
```
protected String SLAID
```
    this is the UUID of the SLA Rule/Action set. use this to find the corresponding record in the policy for further processing
  - t
```
protected ServicePolicy t
```
    a reference to the service policy for this object, do not modify it
- Constructor Detail
  - AlertContainer
```
public AlertContainer(String faultMsg,
              String htmlEncodedFaultMessage,
              String modifiedurl,
              String relatedMessageId,
              long currentTimeMillis,
              String incidentid,
              boolean pooled,
              boolean sendtoAdminsOnly,
              SLAAction slaActionBaseType,
              String SLAID,
              ServicePolicy t,
              SituationCategoryType typeofalert)
```
    creates a new alert container
    
    Parameters:
    faultMsg -
    htmlEncodedFaultMessage -
    modifiedurl - the policy url
    relatedMessageId - a specific transaction that triggered the action, may be null
    currentTimeMillis - the time it was triggered
    incidentid - this is the id that will or has been recorded in the sla table of the performance database. this is useful for providing web links to get more information
    pooled - whether or not we are running in jboss and using jndi lookups for database connections
    sendtoAdminsOnly - typically only used for email alerts
    slaActionBaseType - this is a reference to the specific action being triggered in the SLA identified by SLAID. This is necessary as some Actions have context parameters
    SLAID - a unique id of the SLA
    ServicePolicy - of the thing this action was triggered on
    typeofalert - This is the type of alert, generally speaking, a AvailabilitySituation or PerformanceReport report
    See Also:
    PerformanceReport, AvailabilitySituation
- Method Detail
  - getAlerttype
```
public SituationCategoryType getAlerttype()
```
    This is the type of alert, generally speaking, a performance or status report
    
    See Also:
    PerformanceReport, AvailabilitySituation
  - getFaultMsg
```
public String getFaultMsg()
```
    The fault message is usually a high readable string
  - getHtmlEncodedFaultMessage
```
public String getHtmlEncodedFaultMessage()
```
    This is an html encoded fault message, usually with formatting for an email message or something similar.
  - getModifiedurl
```
public String getModifiedurl()
```
    The url of the fgsms policy that this alert is related to
  - getRelatedMessageId
```
public String getRelatedMessageId()
```
    This is the id of the transaction that caused the SLA rule to trigger. There is no guarantee that this is defined. This ID is a UUID that may relate to a web service transaction, an availability ID or something else.
  - getCurrentTimeMillis
```
public long getCurrentTimeMillis()
```
    The time this even occurred. fgsms processes SLAs asynchronously
  - getIncidentid
```
public String getIncidentid()
```
    a unique UUID of this alert, with is also recorded in the SLA table of the performance database.
  - isPooled
```
public boolean isPooled()
```
    indicates that the current context is running inside of jboss, useful for accessing database connections
  - isSendtoAdminsOnly
```
public boolean isSendtoAdminsOnly()
```
    A reference to the action that will be processed by this alert container. This is used for asynchronous processes, do not modify
  - getSlaActionBaseType
```
public SLAAction getSlaActionBaseType()
```
    A reference to the action that will be processed by this alert container. This is used for asynchronous processes, do not modify
  - getSLAID
```
public String getSLAID()
```
    this is the UUID of the SLA Rule/Action set. use this to find the corresponding record in the policy for further processing
  - getServicePolicy
```
public ServicePolicy getServicePolicy()
```
    a reference to the service policy for this object, do not modify it

Class AlertContainer

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

alerttype

faultMsg

htmlEncodedFaultMessage

modifiedurl

relatedMessageId

currentTimeMillis

incidentid

pooled

sendtoAdminsOnly

slaActionBaseType

SLAID

t

Constructor Detail

AlertContainer

Method Detail

getAlerttype

getFaultMsg

getHtmlEncodedFaultMessage

getModifiedurl

getRelatedMessageId

getCurrentTimeMillis

getIncidentid

isPooled

isSendtoAdminsOnly

getSlaActionBaseType

getSLAID

getServicePolicy