com.highdeal.notification
Class NotifBook

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

public class NotifBook
extends java.lang.Object

This class represents the book of the predefined notification descriptions; It contains all the typical notifications that may be sent by the connected SAP CC system and that you must handle in your client application when developing a class that implement the NotificationHandler Java interface.

Implementation in Your Client Application

Customizing

You develop a customized class that implements the NotificationHandler Java interface and that is assigned to your notification client. There are two ways to access the notification descriptions in the NotificationHandler.

• The first way is to use the constants defined in this book like for example AUTHENTICATION_FAILURE.
• The second way, is a dynamic way, invoking the method searchNotificationDescription(int) to search a predefined description by its name or invoking the method searchNotificationDescription(com.highdeal.notification.NotifBook.NotificationDescriptionHandler) to search a set of notifications corresponding to specified search criteria.

See Also:

Notification, NotificationDescription, NotificationHandler, NotificationServiceClient

Nested Class Summary

static interface

NotifBook.NotificationDescriptionHandler This Java interface must be implemented by classes that filter notification descriptions.

Field Summary

static NotificationDescription[]	ABM_GROUP Notification group 'abm'
static NotificationDescription[]	ADMIN_GROUP Notification group 'admin'
static NotificationDescription	AMOUNT_ALERT Description of the notification 'AMOUNT_ALERT'.
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	NO_ACCESS Description of the notification 'NO_ACCESS'.
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	RENEW_RESERVATION For internal use only.
static NotificationDescription	SPENDING_STATUS_REPORT For internal use only.
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 notification descriptions of a notification group.
static java.util.Date	parseDateArgument(java.lang.String value)
static NotificationDescription	searchNotificationDescription(int uid) Searches a specific predefined NotificationDescription thanks to the unique identifier and returns it.
static void	searchNotificationDescription(NotifBook.NotificationDescriptionHandler handler) Searches NotificationDescriptions and handles them through NotifBook.NotificationDescriptionHandler.
static java.lang.String	toArgument(java.util.Date value)

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 identifier of the subscriber account
2	code	The code that identifies the user alert; This code is set in an alert triggering operator of price plan (or charging plan or refill logic).
3	message	The text message describing the user alert
4	properties	A list of properties that give additional information about the user alert; The list is set in the Alert Triggering operator.

NO_ACCESS

public static final NotificationDescription NO_ACCESS

Description of the notification 'NO_ACCESS'.

Main Properties

uid	15
prettyName	noAccess
level	inform

Additional Info

index	name	description
0	message	The message defined in the Definition tab of the No Access Function component in Core Tool
1	userDefinedArgs

SPENDING_STATUS_REPORT

public static final NotificationDescription SPENDING_STATUS_REPORT

For internal use only.

Description of the notification 'SPENDING_STATUS_REPORT'.

Main Properties

uid	14
prettyName	spendingStatusReport
level	inform

Additional Info

index	name	description
0	spendingStatusMonitoringId	The identifier of the spending status monitoring.

RENEW_RESERVATION

public static final NotificationDescription RENEW_RESERVATION

For internal use only.

Description of the notification 'RENEW_RESERVATION'.

Main Properties

uid	13
prettyName	renewReservation
level	inform

Additional Info

index	name	description
0	sessionId	The identifier of the multiservice session where the partial reservation occurred.
1	reservationId	The identifier of the reservation which was partially granted. It is also used to identify the charging session flagged as Partially Granted Reservation.
2	externalData	The data sent by the client application with the ISessionStartChargingOperation. It is temporarily stored by SAP.

AMOUNT_ALERT

public static final NotificationDescription AMOUNT_ALERT

Description of the notification 'AMOUNT_ALERT'.

Main Properties

uid	0
prettyName	amountAlert
level	inform

Additional Info

index	name	description
0	serviceProvider	The service provider of the subscriber account
1	subscriberAccountCode	The code name of the subscriber account
2	balanceType	Is "prepaid" or "creditLimit" whether the related balance is in a prepaid account or a credit limit balance
3	balanceCode	The code name of the balance for which an amount alert has been triggered
4	balanceAmount	The current amount of the balance with its currency
5	alertMsg	The text message of the alert as set in the alert code of the amount alert configured in the prepaid account or credit limit balance in the subscriber account
6	alertAmount	The amount threshold 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 name of the balance for which an amount alert has been triggered
4	alertMsg	The code of the alert as set in the expiration alert configured in the prepaid account
5	alertState	The state related to the alert
6	alertChangeDate	The date when the state change occurs
7	alertDayCount	Defines when the alert is triggered around the change date

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:

AMOUNT_ALERT, EXPIRATION_ALERT, USER_ALERT, NO_ACCESS, RENEW_RESERVATION

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 NotifBook.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 predefined NotificationDescription thanks to the unique identifier and returns it.

Parameters:

uid - The unique identifier

Returns:

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

getGroup

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

Returns all the notification descriptions of a notification group.

The name of a group ends by the suffix '_GROUP'. If name does not 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 notification descriptions of the notification group named name; Returns null if name is empty or if no group named name was found.

toArgument

public static final java.lang.String toArgument(java.util.Date value)

parseDateArgument

public static final java.util.Date parseDateArgument(java.lang.String value)