Installing Upgrading Designing Configuring Deploying Monitoring Administering Troubleshooting Reference JBI Components
Close Print View
Reference: Alert Configuration Service
 

Classic Java CAPS

Java CAPS Management and Monitoring APIs

Java CAPS Management Client

JavaDocs

Targets

Getting Started Using APIs

To Start Using APIs to Create Applications

Connecting to the Server Through APIs

Connection Type Definition

CAPSManagementClientFactory Definition

The Alert Management API

Support for Databases

AlertConfigurationService

AlertNotificationService

Services -- JavaCAPSManagementAPI

Administration Service

Runtime Management Service

Configuration Service

Deployment Service

Installation Service

Performance Measurement Service

Alert Management Service

Alert Administration Service

Alert Notification Service

Alert Configuration Service

JMS Management Service

Log Management Service

BPEL Management Service

Master Data Management (MDM) Service

Sun Adapters Management Service

Target Option Behavior for the Management Client

Writing Java Code to Access APIs Using Java Code Samples

Setting Up Databases

To Set Up a Database Using Enterprise Manager

To Set Up a Database Using a Scripting Utility

Using Oracle and Other Databases for Alert Persistence

To Set Up an Oracle Database for Alert Persistence

Oracle Script Examples

Setting Up Scripting Engines

Downloading, Installing, and Setting Up A Scripting Environment

Setting Up a Scripting Environment to Invoke Java CAPS Management and Monitoring APIs

To Modify the Environment Variables in env.bat

Using a Scripting Language to Exercise the Java CAPS Management and Monitoring APIs

Exercising the Administration Service

Exercising the Configuration Service

Exercising the Deployment Service

Exercising the Installation Service

Exercising the Runtime Management Service

Exercising the JMS Management Service

Exercising the BPEL Management Service

Exercising the HTTP Administration Service

Exercising the Notification Service

JRuby Integrated into NetBeans IDE

Java CAPS JMS Reference

WebLogic Server Components

Understanding Sun Master Index Configuration Options (Repository)

Understanding Sun Master Index Processing (Repository)

Understanding the Sun Match Engine

Understanding the Business Rules Method Palette

About Application Adapters

About Communication Adapters

About Database Adapters

About Web Server Adapters

What's New in the Sun TCP/IP HL7 Adapter

Java EE Based Components

Sun Master Data Management Suite Primer

Understanding Sun Master Index Configuration Options

Understanding the Master Index Match Engine

Understanding the Master Index Standardization Engine

United States Patient Solution Using MDM

Australia Patient Solution Using MDM

United Kingdom Patient Solution Using MDM

Alert Configuration Service

Alert Configuration Service Method Names and Descriptions

API Method Name
Descriptions
enableAlertsPersistence
Enables alerts persistence in the alerts database. Enabling provides reliable alerts delivery in case of delivery channel failure or application server restart.
disableAlertsPersistence
Disables alerts persistence in the alerts database.
isAlertsPersistenceEnabled
Returns the last setting of the alert persistence enabling operation. True if enabled, otherwise false.
isAlertsJournalEnabled
Returns the last setting of the alert journal enabling operation. True if enabled, otherwise false.
setPersistenceDataSourceJndiName
Sets the JNDI name of the data source database to be used for persistence. If not provided at least once the persistence will be disabled even if enableAlertsPersistence is set to true.
getPersistenceDataSourceJndiName
Returns the last set JNDI name for the alert persistence data source.
setPersistenceDataBaseType
Sets the database type to be used for persistence. Derby is the assumed default database. If a different database is used, this method should be called prior to enabling the persistence.
getPersistenceDataBaseType
The return value represents the last set DB type.
setPersistedAlertsMaxAge
Sets the maximum time a persisted alert is stored in the alert database before it is deleted as part of the removal policy.
getPersistedAlertsMaxAge
Returns the last setting for the allowed persisted alert age. A value of 0 current time could cause all persisted alerts to be deleted. When a negative value is used this policy element is ignored.
setPersistedAlertsMaxCount
Sets the maximum number of alerts allowed to be persisted before an alert is deleted as part of the removal policy in effect. If persistence is on and the count set to zero, it negates journaling being on.
getPersistedAlertsMaxCount
Returns the last setting for the maximum of alerts allowed to be persisted. A value of 0 means no alerts are persisted.
setPersistedAlertsLevel
The priority based alert level that is part of the removal policy. The priorities are as follows (from low to high): INFO, WARNING, MINOR, MAJOR, CRITICAL, and FATAL. All alerts from the provided level and below will be candidates for removal.
getPersistedAlertsLevel
The returned value represents the last setting for the level of alerts that are allowed to be removed from persistence for each target.
setPersistedAlertsRemovelPolicy
Sets the effective policy for the removal of persisted alerts.
getPersistedAlertsRemovalPolicy
Returns the return value representing an array of the last setting the policy used when persisted alerts are to be removed. An empty array means no policy is enforced.
enablePersistedAlertsPolicyExecution
Enables or disables the ability to use the removal policy.
isPersistedAlertsPolicyExecutionEnabled
The returned value represents the last setting that enables/disables the persisted alerts removal policy.
setPersistedAlertsRemovelPolicyExecInterval
Sets how often the persisted alerts removal policy is executed.
getPersistedAlertsRemovelPolicyExecInterval
Returns the returned value representing The last interval setting of the persisted alerts removal policy is executed.
setInMemoryAlertsCacheMaxSize
Sets the maximum number of alerts that can be cached in memory prior to being delivered to the registered listeners.
getInMemoryAlertsCacheMaxSize
Returns the returned value representing the last setting of the maximum size of memory in the alerts cache.
setAlertTableName
Sets the persisted alerts table name.
getPersistedAlertsCount
Returns the total number of alerts currently persisted. This value is volatile and could change.
enableAlertsPersistence
This API enables the caller to set all the parameters defined in the other APIs in this interface. All the settings are applied prior to enabling the persistence.