AlertStorageManager

java.lang.Object

com.inductiveautomation.ignition.gateway.alert.storage.AlertStorageManager

All Implemented Interfaces:: ExtensionPointManager

public abstract class AlertStorageManager extends Object implements ExtensionPointManager

The AlertStorageManager keeps track of all AlertStorageProfiles

Field Summary

Fields

Modifier and Type

Field

Description

static final String

LOG_BASE_NAME

The base logger name for the alert notification system.
Constructor Summary

Constructors

Constructor

Description

AlertStorageManager()
Method Summary

Modifier and Type

Method

Description

abstract void

addAlertStorageProfileType(AlertStorageProfileType type)

Adds a new type of alert storage profile to the system.

abstract AlertStorageProfile

getProfile(Long id)

Returns the alert storage profile (or null if none is defined) for a given id.

abstract AlertStorageProfile

getProfile(String name)

Returns the alert storage profile (or null if none is defined) for a given name.

abstract List<String>

getProfileNames()

Returns a list of the names of the currently configured alert storage profiles

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

Methods inherited from interface com.inductiveautomation.ignition.gateway.model.ExtensionPointManager
getExtensionPoint, getExtensionPoints

Field Details
- LOG_BASE_NAME
  
  public static final String LOG_BASE_NAME
  
  The base logger name for the alert notification system. Subsystems and sub elements should build off this name.
  See Also:
  
  Constant Field Values
Constructor Details
- AlertStorageManager
  
  public AlertStorageManager()
Method Details
- addAlertStorageProfileType
  
  public abstract void addAlertStorageProfileType(AlertStorageProfileType type) throws Exception
  
  Adds a new type of alert storage profile to the system. Also makes sure that the persistent settings record indicated in the type is known by the internal schema manager
  
  Parameters:
  
  type - The new type of alert storage profile to add.
  
  Throws:
  
  Exception - If automatic schema updating fails.
- getProfile
  
  public abstract AlertStorageProfile getProfile(Long id)
  
  Returns the alert storage profile (or null if none is defined) for a given id.
- getProfile
  
  public abstract AlertStorageProfile getProfile(String name)
  
  Returns the alert storage profile (or null if none is defined) for a given name.
- getProfileNames
  
  public abstract List<String> getProfileNames()
  
  Returns a list of the names of the currently configured alert storage profiles