T
- The type of configuration handled by this alert handler.@PublicAPI(stability=VOLATILE, mayInstantiate=false, mayExtend=true, mayInvoke=false) public interface AlertHandler<T extends AlertHandlerCfg>
Modifier and Type | Method and Description |
---|---|
void |
finalizeAlertHandler()
Performs any necessary cleanup that may be necessary when this alert handler is finalized.
|
AlertHandlerCfg |
getAlertHandlerConfiguration()
Retrieves the current configuration for this alert handler.
|
void |
initializeAlertHandler(T configuration)
Initializes this alert handler based on the information in the provided configuration entry.
|
boolean |
isConfigurationAcceptable(T configuration,
List<LocalizableMessage> unacceptableReasons)
Indicates whether the provided configuration is acceptable for this alert handler.
|
void |
sendAlertNotification(AlertGenerator generator,
String alertType,
LocalizableMessage alertMessage)
Sends an alert notification based on the provided information.
|
void initializeAlertHandler(T configuration) throws ConfigException, InitializationException
configuration
- The configuration to use to initialize this alert handler.ConfigException
- If the provided entry does not contain a valid configuration for this alert handler.InitializationException
- If a problem occurs during initialization that is not related to the server configuration.AlertHandlerCfg getAlertHandlerConfiguration()
boolean isConfigurationAcceptable(T configuration, List<LocalizableMessage> unacceptableReasons)
configuration
- The configuration for which to make tje determination.unacceptableReasons
- A list to which human-readable reasons may be added to explain why the configuration is not
acceptable.true
if the provided configuration is acceptable, or false
if it is not.void finalizeAlertHandler()
void sendAlertNotification(AlertGenerator generator, String alertType, LocalizableMessage alertMessage)
generator
- The alert generator that created the alert.alertType
- The alert type name for this alert.alertMessage
- A message (possibly null
) that can provide more information about this alert.Copyright 2010-2022 ForgeRock AS.