IAlertNotifierPlugin.IAlertNotifierContext (Java Custom Interceptor and Condition Interfaces)

Enclosing interface:: IAlertNotifierPlugin

public static interface IAlertNotifierPlugin.IAlertNotifierContext

Alert Notifier Context

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`java.lang.String`	`generateAlertDetailsUrl()` Generates a URL for administrators to view the alerts details and analyze its flow map (if any)
`java.lang.String`	`generateEquivalentAlertDetailsUrl()` Generates a URL for administrators to view the details of all equivalent alert instances and analyze their flow maps (if any)
`java.lang.String`	`generateViewApplicationLogUrl()` Generates a URL for administrators to view the associated Application event logs associated with this alert (if any).
`java.lang.String`	`generateViewAuditLogUrl()` Generates a URL for administrators to view the associated Audit records associated with this alert (if any).
`java.lang.String`	`getAlertId()` Internal identifier for this Alert
`ICallSite`	`getAlertOriginCallSite()` Gives access to information related to the site that raised the alert.
`ICallSite`	`getConsumerCallSite()` Immediate upstream source of a call (or Consumer site).
`java.lang.String`	`getEquivalenceId()` Internal identifier to identify multiple alert instances as equivalent
`java.lang.String`	`getFailureConditionText()` Alert raising reason message.
`java.lang.String`	`getHostAddress()` Host address on which the alert was raised.
`java.lang.String`	`getLogicalThreadId()` Returns the LogicalThreadId (LTID) associated with the Alert (if any).
`java.lang.String`	`getMessage()` User-configured string (or default alert message).
`java.lang.String`	`getPolicyGroupName()`
`ICallSite`	`getProviderCallSite()` Immediate downstream target of a call (or Provider site).
`java.lang.String`	`getRuleTypeText()`
`IAlertNotifierPlugin.AlertSeverity`	`getSeverity()` Alert's severity level
`java.lang.String`	`getStatisticTypeId()`
`java.util.Date`	`getTimeOccured()` Alert event time occurrence.
`boolean`	`hasFlowMap()` Indicate if the alert has an associated flowmap.
`boolean`	`isEmailEnabled()` returns false if SMTP is disabled or not configured.
`IEmailMessage`	`newEmailMessage()` Create an Email Message to send using the product internal SMTP subsystem.

- Method Detail
  - getAlertId
```
java.lang.String getAlertId()
                     throws java.lang.Exception
```
    Internal identifier for this Alert
    
    Throws:
    
    java.lang.Exception
  - getEquivalenceId
```
java.lang.String getEquivalenceId()
                           throws java.lang.Exception
```
    Internal identifier to identify multiple alert instances as equivalent
    
    Throws:
    
    java.lang.Exception
  - getSeverity
```
IAlertNotifierPlugin.AlertSeverity getSeverity()
                                        throws java.lang.Exception
```
    Alert's severity level
    
    Throws:
    
    java.lang.Exception
  - getTimeOccured
```
java.util.Date getTimeOccured()
                       throws java.lang.Exception
```
    Alert event time occurrence.
    
    Throws:
    
    java.lang.Exception
  - getLogicalThreadId
```
java.lang.String getLogicalThreadId()
                             throws java.lang.Exception
```
    Returns the LogicalThreadId (LTID) associated with the Alert (if any).
    
    Returns:
    
    the LTID or null if none
    
    Throws:
    
    java.lang.Exception
  - getAlertOriginCallSite
```
ICallSite getAlertOriginCallSite()
                          throws java.lang.Exception
```
    Gives access to information related to the site that raised the alert.
    
    Returns:
    
    null if no call site associated
    
    Throws:
    
    java.lang.Exception
  - getConsumerCallSite
```
ICallSite getConsumerCallSite()
                       throws java.lang.Exception
```
    Immediate upstream source of a call (or Consumer site). For alerts raised by user-configured call instance specific statistical conditions.
    
    Returns:
    
    null if no upstream site associated
    
    Throws:
    
    java.lang.Exception
  - getProviderCallSite
```
ICallSite getProviderCallSite()
                       throws java.lang.Exception
```
    Immediate downstream target of a call (or Provider site). For alerts raised by user-configured call instance specific statistical conditions.
    
    Returns:
    
    null if no downstream site associated
    
    Throws:
    
    java.lang.Exception
  - getHostAddress
```
java.lang.String getHostAddress()
                         throws java.lang.Exception
```
    Host address on which the alert was raised.
    
    Throws:
    
    java.lang.Exception
  - getMessage
```
java.lang.String getMessage()
                     throws java.lang.Exception
```
    User-configured string (or default alert message).
    
    Throws:
    
    java.lang.Exception
  - getFailureConditionText
```
java.lang.String getFailureConditionText()
                                  throws java.lang.Exception
```
    Alert raising reason message.
    
    Throws:
    
    java.lang.Exception
  - hasFlowMap
```
boolean hasFlowMap()
            throws java.lang.Exception
```
    Indicate if the alert has an associated flowmap.
    
    Returns:
    
    true if a flowmap is associated with this alert
    
    Throws:
    
    java.lang.Exception
  - isEmailEnabled
```
boolean isEmailEnabled()
                throws java.lang.Exception
```
    returns false if SMTP is disabled or not configured.
    
    Throws:
    
    java.lang.Exception
  - newEmailMessage
```
IEmailMessage newEmailMessage()
                       throws java.lang.Exception
```
    Create an Email Message to send using the product internal SMTP subsystem.
    
    Throws:
    
    java.lang.Exception
  - generateAlertDetailsUrl
```
java.lang.String generateAlertDetailsUrl()
                                  throws java.lang.Exception
```
    Generates a URL for administrators to view the alerts details and analyze its flow map (if any)
    
    Returns:
    
    null if not applicable
    
    Throws:
    
    java.lang.Exception
  - generateEquivalentAlertDetailsUrl
```
java.lang.String generateEquivalentAlertDetailsUrl()
                                            throws java.lang.Exception
```
    Generates a URL for administrators to view the details of all equivalent alert instances and analyze their flow maps (if any)
    
    Returns:
    
    null if not applicable
    
    Throws:
    
    java.lang.Exception
  - generateViewAuditLogUrl
```
java.lang.String generateViewAuditLogUrl()
                                  throws java.lang.Exception
```
    Generates a URL for administrators to view the associated Audit records associated with this alert (if any). Note: this is only applicable to instance-level alerts.
    
    Returns:
    
    null if not applicable
    
    Throws:
    
    java.lang.Exception
  - generateViewApplicationLogUrl
```
java.lang.String generateViewApplicationLogUrl()
                                        throws java.lang.Exception
```
    Generates a URL for administrators to view the associated Application event logs associated with this alert (if any). Note: this is only applicable to instance-level alerts.
    
    Returns:
    
    null if not applicable
    
    Throws:
    
    java.lang.Exception
  - getStatisticTypeId
```
java.lang.String getStatisticTypeId()
                             throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - getRuleTypeText
```
java.lang.String getRuleTypeText()
                          throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - getPolicyGroupName
```
java.lang.String getPolicyGroupName()
                             throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception

Interface IAlertNotifierPlugin.IAlertNotifierContext

Method Summary

Method Detail

getAlertId

getEquivalenceId

getSeverity

getTimeOccured

getLogicalThreadId

getAlertOriginCallSite

getConsumerCallSite

getProviderCallSite

getHostAddress

getMessage

getFailureConditionText

hasFlowMap

isEmailEnabled

newEmailMessage

generateAlertDetailsUrl

generateEquivalentAlertDetailsUrl

generateViewAuditLogUrl

generateViewApplicationLogUrl

getStatisticTypeId

getRuleTypeText

getPolicyGroupName