com.highdeal.notification
Class NotifBook

java.lang.Object
  com.highdeal.notification.NotifBook

public class NotifBook
extends java.lang.Object

Book of the notification descriptions.

This book contains all the the notifications which may be thrown by the Notification Service. There is two ways to access the notification descriptions. The first way is to use the constants defined in this book like for example AUTHENTICATION_FAILURE. The other way, is a dynamic way, invoking the method searchNotificationDescription(int) to search a description by its name or invoking the method searchNotificationDescription(com.highdeal.notification.NotifBook.NotificationDescriptionHandler) to search a set of notifications corresponding to a specified search criteria.

See Also:

NotificationDescription

Nested Class Summary

static interface

NotifBook.NotificationDescriptionHandler This interface must be implemented by classes in charge for filtering notification descriptions.

Field Summary

static NotificationDescription[]	ABM_GROUP Notification group 'abm'
static NotificationDescription[]	ADMIN_GROUP Notification group 'admin'
static NotificationDescription	ALERT_AMOUNT Description of the notification 'ALERT_AMOUNT'.
static NotificationDescription	AUTHENTICATION_FAILURE Description of the notification 'AUTHENTICATION_FAILURE'.
static NotificationDescription	DB_FAILURE Description of the notification 'DB_FAILURE'.
static NotificationDescription	DB_LINK_DOWN Description of the notification 'DB_LINK_DOWN'.
static NotificationDescription	DB_LINK_UP Description of the notification 'DB_LINK_UP'.
static NotificationDescription	EXPIRATION_ALERT Description of the notification 'EXPIRATION_ALERT'.
static NotificationDescription	INSTANCE_DOWN Description of the notification 'INSTANCE_DOWN'.
static NotificationDescription	INSTANCE_UP Description of the notification 'INSTANCE_UP'.
static NotificationDescription	OUT_OF_MEMORY Description of the notification 'OUT_OF_MEMORY'.
static NotificationDescription	PNR_SCHEDULER_INTERRUPTED Description of the notification 'PNR_SCHEDULER_INTERRUPTED'.
static NotificationDescription	PNR_SCHEDULER_SLEEPS Description of the notification 'PNR_SCHEDULER_SLEEPS'.
static NotificationDescription	PNR_SCHEDULER_WAKESUP Description of the notification 'PNR_SCHEDULER_WAKESUP'.
static NotificationDescription	USER_ALERT Description of the notification 'USER_ALERT'.

Constructor Summary

NotifBook()

Method Summary

static NotificationDescription[]	getGroup(java.lang.String name) Returns all the notifications of a notification group.
static NotificationDescription	searchNotificationDescription(int uid) Searches a specific NotificationDescription thanks to the unique identifier and returns it.
static void	searchNotificationDescription(NotifBook.NotificationDescriptionHandler handler) Searches NotificationDescriptions and handles them through NotificationDescriptionHandler.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

USER_ALERT

public static final NotificationDescription USER_ALERT

Description of the notification 'USER_ALERT'.

Main Properties

uid	12
prettyName	userAlert
level	inform

Additional Info

index	name	description
0	serviceProvider	The service provider of the subscriber account
1	subscriberAccountCode	The code of the subscriber account
2	code	The code that identifies the user alert
3	message	The message describing the user alert
4	properties	A list of properties that give additional information about the user alert

ALERT_AMOUNT

public static final NotificationDescription ALERT_AMOUNT

Description of the notification 'ALERT_AMOUNT'.

Main Properties

uid	0
prettyName	alertAmount
level	inform

Additional Info

index	name	description
0	serviceProvider	The service provider of the subscriber account
1	subscriberAccountCode	The code of the subscriber account
2	balanceType	Is "prepaid" or "creditLimit" whether the related balance is a prepaid account or a credit limit balance.
3	balanceCode	The code of the balance for which an amount alert has been triggered.
4	balanceAmount	The amount of the balance with its currency
5	alertMsg	The user message of the alert
6	alertAmount	The amount of the alert

EXPIRATION_ALERT

public static final NotificationDescription EXPIRATION_ALERT

Description of the notification 'EXPIRATION_ALERT'.

Main Properties

uid	1
prettyName	expirationAlert
level	inform

Additional Info

index	name	description
0	serviceProvider	The service provider of the subscriber account
1	subscriberAccountCode	The code of the subscriber account
2	balanceType	Is "prepaid".
3	balanceCode	The code of the balance for which an amount alert has been triggered.
4	alertMsg	The user message of the alert
5	alertState	The state related to the alert

INSTANCE_UP

public static final NotificationDescription INSTANCE_UP

Description of the notification 'INSTANCE_UP'.

Main Properties

uid	2
prettyName	instanceUp
level	inform

INSTANCE_DOWN

public static final NotificationDescription INSTANCE_DOWN

Description of the notification 'INSTANCE_DOWN'.

Main Properties

uid	3
prettyName	instanceDown
level	inform

DB_LINK_DOWN

public static final NotificationDescription DB_LINK_DOWN

Description of the notification 'DB_LINK_DOWN'.

Main Properties

uid	4
prettyName	dbLinkDown
level	failure

DB_LINK_UP

public static final NotificationDescription DB_LINK_UP

Description of the notification 'DB_LINK_UP'.

Main Properties

uid	5
prettyName	dbLinkUp
level	inform

DB_FAILURE

public static final NotificationDescription DB_FAILURE

Description of the notification 'DB_FAILURE'.

Main Properties

uid	6
prettyName	dbFailure
level	failure

Additional Info

index	name	description
0	alertMsg	The message of the error

OUT_OF_MEMORY

public static final NotificationDescription OUT_OF_MEMORY

Description of the notification 'OUT_OF_MEMORY'.

Main Properties

uid	7
prettyName	outOfMemory
level	fatal

PNR_SCHEDULER_WAKESUP

public static final NotificationDescription PNR_SCHEDULER_WAKESUP

Description of the notification 'PNR_SCHEDULER_WAKESUP'.

Main Properties

uid	8
prettyName	pnrSchedulerWakesUp
level	inform

PNR_SCHEDULER_SLEEPS

public static final NotificationDescription PNR_SCHEDULER_SLEEPS

Description of the notification 'PNR_SCHEDULER_SLEEPS'.

Main Properties

uid	9
prettyName	pnrSchedulerSleeps
level	inform

PNR_SCHEDULER_INTERRUPTED

public static final NotificationDescription PNR_SCHEDULER_INTERRUPTED

Description of the notification 'PNR_SCHEDULER_INTERRUPTED'.

Main Properties

uid	10
prettyName	pnrSchedulerInterrupted
level	warn

Additional Info

index	name	description
0	alertMsg	The message of the error

AUTHENTICATION_FAILURE

public static final NotificationDescription AUTHENTICATION_FAILURE

Description of the notification 'AUTHENTICATION_FAILURE'.

Main Properties

uid	11
prettyName	authenticationFailure
level	security

Additional Info

index	name	description
0	alertMsg	The message of the error. Is "unknown login" or "wrong password".
1	login	The login if specified, "no login" otherwise

ABM_GROUP

public static final NotificationDescription[] ABM_GROUP

Notification group 'abm'

Here are the notifications included in this group:

ALERT_AMOUNT, EXPIRATION_ALERT, USER_ALERT

ADMIN_GROUP

public static final NotificationDescription[] ADMIN_GROUP

Notification group 'admin'

Here are the notifications included in this group:

INSTANCE_UP, INSTANCE_DOWN, DB_LINK_DOWN, DB_LINK_UP, DB_FAILURE, OUT_OF_MEMORY, PNR_SCHEDULER_WAKESUP, PNR_SCHEDULER_SLEEPS, PNR_SCHEDULER_INTERRUPTED, AUTHENTICATION_FAILURE

Constructor Detail

NotifBook

public NotifBook()

Method Detail

searchNotificationDescription

public static void searchNotificationDescription(NotifBook.NotificationDescriptionHandler handler)

Searches NotificationDescriptions and handles them through NotificationDescriptionHandler.

Parameters:

handler - the filtering notification handler.

Throws:

com.highdeal.util.NullArgumentException - if handler is null

searchNotificationDescription

public static final NotificationDescription searchNotificationDescription(int uid)

Searches a specific NotificationDescription thanks to the unique identifier and returns it.

Parameters:

uid - the unique identifier.

Returns:

a NotificationDescription if a notification has uid as unique id, null otherwise.

getGroup

public static final NotificationDescription[] getGroup(java.lang.String name)

Returns all the notifications of a notification group.

The name of a group ends by the suffix '_GROUP'. If name doesn't end by this suffix, it will be appended. For example, the group 'XXXX_GROUP' can be retrieved with the names 'XXXX_GROUP' or 'XXXX'.

Parameters:

name - the name of the group. Can be null.

Returns:

an array of the notifications of the notification group named name, null if name is empty or if no group named name was found.