com.prosyst.mprm.admin.alertboard

Interface AlertBoardReader

public interface AlertBoardReader

Provides methods for reading alerts from the mPRM alert board. The alert board gathers all alerts raised in the mPRM backend hosts and managed devices.

Method Summary

Modifier and Type	Method and Description
void	addAlertListener(AlertListener listener) Deprecated. use addAlertListener(AlertListener, String, String)
void	addAlertListener(AlertListener listener, java.lang.String username, java.lang.String ldapFilter) With this method application can declare that it likes to receive notifications for raising and pulling down of alerts on the alert board.
Enumerator	getAlerts() Returns an Enumeration of Alert objects representing alerts in the alert board targeted to the default user.
Enumerator	getAlerts(java.lang.String username) Returns an Enumeration of Alert objects representing alerts in the alert board targeted to a given user.
AlertSet	getAlertSetInfo(java.lang.String alertMessage) Returns the AlertSet for a particular alert message.
Enumerator	getAllAlerts(int timeout) Returns an Enumeration of Alert objects representing alerts in the alert board targeted to the default user.
Enumerator	getBackendAlerts(java.lang.String[] hostRoles) Returns an Enumeration of Alert objects representing alerts in the alert board, that have been raised by the control center modules and targeted to the default user.
Enumerator	getBackendAlerts(java.lang.String username, java.lang.String[] hostRoles) Returns an Enumeration of Alert objects representing alerts in the alert board, that have been raised by the given backend hosts and targeted to a given user.
Enumerator	getByLdapFilter(java.lang.String ldapFilter) Returns an Enumeration of Alert objects representing alerts in the alert board targeted to the default user and filtered by given ldap filter specifying the alert source.
Enumerator	getByLdapFilter(java.lang.String username, java.lang.String ldapFilter) Returns an Enumeration of Alert objects representing alerts in the alert board targeted to a given user and filtered by given LDAP filter specifying the alert source.
Enumerator	getByLdapFilter(java.lang.String message, java.lang.String username, java.lang.String ldapFilter) Returns an Enumerator of Alert objects representing alerts in the alert board having a message, identified by the message argument and target to a user/group identified by the username argument and additionally filtered by the given ldapFilter
Enumerator	getDeviceAlerts(java.lang.String deviceType, java.lang.String deviceId) Returns an Enumeration of Alert objects representing alerts in the alert board, that have been raised for the device with given type and id, and targeted to the default user.
Enumerator	getDeviceAlerts(java.lang.String username, java.lang.String deviceType, java.lang.String deviceId) Returns an Enumeration of Alert objects representing alerts related to a given device and targeted to a given user.
AlertSet[]	getDistinctAlertSetsByLdapFilter(int maxCount, java.lang.String username, java.lang.String ldapFilter) Returns an array of AlertSet objects, representing all alerts classified by a message and target to a user/group identified by the username argument and additionally filtered by the given ldapFilter
Enumerator	getGatewayAlerts(java.lang.String gatewayId) Deprecated. As of mPRM 4.0, the preferred way is to use getDeviceAlerts(String, String) method.
Enumerator	getGatewayAlerts(java.lang.String username, java.lang.String gatewayId) Deprecated. As of mPRM 4.0, the preferred way is to use getDeviceAlerts(String, String, String) method.
void	removeAlertListener(AlertListener listener) Removes an alert listener.

Method Detail

getAlerts

Enumerator getAlerts(java.lang.String username)
              throws ManagementException

Returns an Enumeration of Alert objects representing alerts in the alert board targeted to a given user. Null value as username argument means that alerts targeted to any users will be returned.

Parameters:

username - specifies the targeted user the retrieved alerts will be filtered by.

Returns:

an enumeration of retrieved alerts.

Throws:

ManagementException - if a system error occurs.

getAlerts

Enumerator getAlerts()
              throws ManagementException

Returns an Enumeration of Alert objects representing alerts in the alert board targeted to the default user.

Returns:

enumeration of Alert objects.

Throws:

ManagementException - if a system error occurs.

getAllAlerts

Enumerator getAllAlerts(int timeout)
                 throws ManagementException

Returns an Enumeration of Alert objects representing alerts in the alert board targeted to the default user.

Parameters:

timeout - defines the timeout to remote host in seconds

Returns:

enumeration of Alert objects.

Throws:

ManagementException - if a system error occurs.

getByLdapFilter

Enumerator getByLdapFilter(java.lang.String username,
                           java.lang.String ldapFilter)
                    throws ManagementException

Returns an Enumeration of Alert objects representing alerts in the alert board targeted to a given user and filtered by given LDAP filter specifying the alert source. Null value as username argument means that alerts targeted to any users will be returned.

Parameters:

username - specifies the targeted user the retrieved alerts will be filtered by.

ldapFilter - specifies a source criteria of the requested alerts

Returns:

enumeration of Alert objects.

Throws:

ManagementException - if a system error occurs.

getByLdapFilter

Enumerator getByLdapFilter(java.lang.String ldapFilter)
                    throws ManagementException

Returns an Enumeration of Alert objects representing alerts in the alert board targeted to the default user and filtered by given ldap filter specifying the alert source.

Parameters:

ldapFilter - specifies a source criteria of the requested alerts

Returns:

enumeration of Alert objects.

Throws:

ManagementException - if a system error occurs.

getBackendAlerts

Enumerator getBackendAlerts(java.lang.String username,
                            java.lang.String[] hostRoles)
                     throws ManagementException

Returns an Enumeration of Alert objects representing alerts in the alert board, that have been raised by the given backend hosts and targeted to a given user. Null value as username argument means that alerts targeted to any users will be returned.

Parameters:

hostRoles - array of the target backend host roles. Elements of the array can be one of Role.CC, Role.MS, Role.RAS, or id of particular Management Server. Supplying Role.MS means that all management servers will be included.

username - specifies the targeted user the retrieved alerts will be filtered by.

Returns:

enumeration of Alert objects.

Throws:

ManagementException - if a system error occurs.

getBackendAlerts

Enumerator getBackendAlerts(java.lang.String[] hostRoles)
                     throws ManagementException

Returns an Enumeration of Alert objects representing alerts in the alert board, that have been raised by the control center modules and targeted to the default user.

Parameters:

hostRoles - array of the target backend host roles. Elements of the array can be one of Role.CC, Role.MS, Role.RAS, or id of particular Management Server. Supplying Role.MS means that all management servers will be included.

Returns:

enumeration of Alert objects.

Throws:

ManagementException - if a system error occurs.

getGatewayAlerts

Enumerator getGatewayAlerts(java.lang.String username,
                            java.lang.String gatewayId)
                     throws ManagementException

Deprecated. As of mPRM 4.0, the preferred way is to use getDeviceAlerts(String, String, String) method.

Returns an Enumeration of Alert objects representing alerts in the alert board, that have been raised by the OSGi Gateway with given id and targeted to a given user.

Parameters:

username - specifies the user or group. Null value as username argument means that alerts targeted to any users will be returned.

gatewayId - specifies the gateway identifier. Null value as gatewayId argument means that alerts raised on all managed gateways will be returned.

Returns:

enumeration of Alert objects.

Throws:

ManagementException - if a system error occurs.

getDeviceAlerts

Enumerator getDeviceAlerts(java.lang.String username,
                           java.lang.String deviceType,
                           java.lang.String deviceId)
                    throws ManagementException

Returns an Enumeration of Alert objects representing alerts related to a given device and targeted to a given user.

Parameters:

username - specifies the user or group. Null value as a username argument means that alerts targeted to any users will be returned.

deviceType - device type. Null value as deviceId argument means that alerts related on all managed devices of the specified type will be returned.

deviceId - device id.

Returns:

enumeration of Alert objects.

Throws:

ManagementException - if a system error occurs.

getGatewayAlerts

Enumerator getGatewayAlerts(java.lang.String gatewayId)
                     throws ManagementException

Deprecated. As of mPRM 4.0, the preferred way is to use getDeviceAlerts(String, String) method.

Returns an Enumeration of Alert objects representing alerts in the alert board, that have been raised by the OSGi Gateway with given id and targeted to the default user. Null value as gatewayId argument means that alerts raised on all managed gateways will be returned.

Parameters:

gatewayId - specifies the gateway identifier Null value as gatewayId argument means that alerts raised on all managed gateways will be returned.

Returns:

an enumeration of retrieved alerts.

Throws:

ManagementException - if a system error occurs.

getDeviceAlerts

Enumerator getDeviceAlerts(java.lang.String deviceType,
                           java.lang.String deviceId)
                    throws ManagementException

Returns an Enumeration of Alert objects representing alerts in the alert board, that have been raised for the device with given type and id, and targeted to the default user. Null value as deviceType and deviceId argument means that alerts raised on all managed devices will be returned.

Parameters:

deviceType - device type.

deviceId - device id.

Returns:

an enumeration of retrieved alerts.

Throws:

ManagementException - if a system error occurs.

addAlertListener

void addAlertListener(AlertListener listener)
               throws ManagementException

Deprecated. use addAlertListener(AlertListener, String, String)

With this method application can register for receiving notifications for raising and removing of alerts on the alert board.

Parameters:

listener - application defined alert listener.

Throws:

ManagementException - if a system error occurs.

addAlertListener

void addAlertListener(AlertListener listener,
                      java.lang.String username,
                      java.lang.String ldapFilter)
               throws ManagementException

With this method application can declare that it likes to receive notifications for raising and pulling down of alerts on the alert board.

Parameters:

listener - application defined alert listener.

username - specifies the user or group.null value means that the listener will be notified for alerts targeted to any user.

ldapFilter - an LDAP filter restricting the events to receive

Throws:

ManagementException - if a system error occurs.

removeAlertListener

void removeAlertListener(AlertListener listener)

Removes an alert listener.

Parameters:

listener - application defined alert listener.

getDistinctAlertSetsByLdapFilter

AlertSet[] getDistinctAlertSetsByLdapFilter(int maxCount,
                                            java.lang.String username,
                                            java.lang.String ldapFilter)
                                     throws ManagementException

Returns an array of AlertSet objects, representing all alerts classified by a message and target to a user/group identified by the username argument and additionally filtered by the given ldapFilter

Parameters:

maxCount - restricts the result array size if there are a great number of distinct alert messages

username - specifies the user or group.null value means that the alerts targeted to any user will be returned

ldapFilter - specifies an additional filtering of the alerts the application is interested of. null value means no additional filtering to be made

Returns:

An array of AlertSet objects representing all (or maxCount if their number is greater than the maxCount argument) alert sets.

Throws:

ManagementException - if a system error occurs

getAlertSetInfo

AlertSet getAlertSetInfo(java.lang.String alertMessage)
                  throws ManagementException

Returns the AlertSet for a particular alert message.

Parameters:

alertMessage - alert message.

Returns:

alert set.

Throws:

ManagementException - if a system error occurs

getByLdapFilter

Enumerator getByLdapFilter(java.lang.String message,
                           java.lang.String username,
                           java.lang.String ldapFilter)
                    throws ManagementException

Returns an Enumerator of Alert objects representing alerts in the alert board having a message, identified by the message argument and target to a user/group identified by the username argument and additionally filtered by the given ldapFilter

Parameters:

message - specifies the alert message of interest. null value means all alert messages

username - specifies the user or group.null value means that the alerts targeted to any user will be returned

ldapFilter - specifies an additional filtering of the alerts the application is interested of. null value means no additional filtering to be made

Returns:

enumeration of Alert objects.

Throws:

ManagementException - if a system error occurs.