com.ibm.tivoli.maximo.pushnotification

Class PushNotificationService

java.lang.Object

psdi.server.AppService

com.ibm.tivoli.maximo.pushnotification.PushNotificationService

All Implemented Interfaces:

java.rmi.Remote, MboServerInterface, MaxRemoteProxy, AppServiceRemote, Dependable, Service, ServiceRemote, FixedLoggerNames, FixedLoggers

public class PushNotificationService
extends AppService
implements AppServiceRemote

A Service class that contains general purpose methods related to PushNotifService. This class is used as a service class so that general purpose utility methods relating to the Push Notification.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PUSHNOTF_LOGGER
static MXLogger	PUSHNOTFLOGGER

Fields inherited from interface psdi.util.logging.FixedLoggers

APPLOGGER, CRONTASKLOGGER, CRONTASKMGRLOGGER, CRONTASKMGRSQLLOGGER, DBCONNECTIONLOGGER, DDLOGGER, DMLOGGER, EVENTLOGGER, EXCEPTIONLOGGER, MAILLOGGER, MAXIMOLOGGER, MTLOGGER, NULLMBOPOINTER, SECURITY, SENDFAILEDLOGGER, SERVICELOGGER, SQLLOGGER

Fields inherited from interface psdi.util.logging.FixedLoggerNames

appenderPrefix, LOGGERNAME_APP, LOGGERNAME_CRONTASK, LOGGERNAME_CRONTASKMGR, LOGGERNAME_DBCONNECTION, LOGGERNAME_DD, LOGGERNAME_DM, LOGGERNAME_DMPREVIEW, LOGGERNAME_EVENT, LOGGERNAME_EXCEPTION, LOGGERNAME_MAIL, LOGGERNAME_MAXIMO, LOGGERNAME_MT, LOGGERNAME_NULLMBOPOINTER, LOGGERNAME_SECURITY, LOGGERNAME_SENDFAILED, LOGGERNAME_SERVICE, LOGGERNAME_SQL, LOGGERNAME_SQL_CRONTASKMGR, LOGGERNAME_TXN, loggerPrefix

Constructor Summary

Constructors

Constructor and Description
PushNotificationService()
PushNotificationService(MXServer mxServer)

Method Summary

Modifier and Type	Method and Description
NotificationMessage	getNotificationMessage(NotificationMessage notificationMessage, java.lang.String deviceId) This method creates a new notification message object for the device.
NotificationMessage	getNotificationMessage(java.lang.String msg, java.lang.String deviceId) This method creates a new notification message object for the device.
MboSetRemote	getProviderDevTypeSet(UserInfo userInfo, java.lang.String deviceType, java.lang.String projectName) Get Provider info for a device type (Android, iOS)
MboRemote	getProviderMbo() Get Provider info for a device type (Android, iOS)
java.lang.String	getProviderName()
BaseRouterHandler	getRouterHandler()
void	sendMessage(UserInfo userInfo, NotificationMessage notificationMessage) This method is used to send push notification message.
void	sendMessage(UserInfo userInfo, NotificationMessage notificationMessage, java.lang.String eventName) This method is used to send push notification message.
void	sendMessage(UserInfo userInfo, NotificationMessage notificationMessage, java.lang.String eventName, java.lang.String projectName) This method is used to send push notification message.
void	sendMessage(UserInfo userInfo, java.lang.String msg) This method is used to push notification message.
void	sendMessageforUserId(UserInfo userInfo, java.lang.String msgRecevingUserId, NotificationMessage notificationMessage, java.lang.String eventName, java.lang.String projectName)
void	sendMessageforUserId(UserInfo userInfo, java.lang.String notifMessageJsonStr, java.lang.String msgRecevingUserId, java.lang.String notifMessage, java.lang.String eventName, java.lang.String projectName) This method is used to send push notification message.
void	setProviderName(java.lang.String providername)

Methods inherited from class psdi.server.AppService

checkSecurity, configure, destroy, freeDBConnection, freeMboSet, getCriteria, getCurrentState, getDBConnection, getLiveObjCount, getLoad, getMaximoDD, getMaxVar, getMboSet, getMXServer, getName, getProfile, getProxy, getSchemaOwner, getServiceInfo, getServiceLogger, getSetForRelationship, getSetFromKeys, getStateCmdList, getStateList, getURL, init, initCriteriaList, isAppService, isRunning, isSingletonService, restart, setProxy, setRunning, setURL, verifyUser, verifyUser

Methods inherited from class java.lang.Object

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

Methods inherited from interface psdi.server.AppServiceRemote

checkSecurity, getCriteria, getCurrentState, getLiveObjCount, getMboSet, getName, getSchemaOwner, getSetForRelationship, getSetFromKeys, getStateCmdList, getStateList, getURL, verifyUser, verifyUser

Methods inherited from interface psdi.server.ServiceRemote

isAppService, isSingletonService, restart

Field Detail

PUSHNOTF_LOGGER

public static final java.lang.String PUSHNOTF_LOGGER

See Also:

Constant Field Values

PUSHNOTFLOGGER

public static final MXLogger PUSHNOTFLOGGER

Constructor Detail

PushNotificationService

public PushNotificationService()
                        throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

PushNotificationService

public PushNotificationService(MXServer mxServer)
                        throws java.rmi.RemoteException

Parameters:

srvEnv - -- the "Server Environment" this Service is being created in.

Throws:

java.rmi.RemoteException

Method Detail

sendMessage

public void sendMessage(UserInfo userInfo,
                        java.lang.String msg)
                 throws MXException,
                        java.rmi.RemoteException

This method is used to push notification message.

Parameters:

userInfo -

msg -

Throws:

MXException

java.rmi.RemoteException

sendMessage

public void sendMessage(UserInfo userInfo,
                        NotificationMessage notificationMessage)
                 throws MXException,
                        java.rmi.RemoteException

This method is used to send push notification message.

Parameters:

userInfo -

notificationMessage -

Throws:

MXException

java.rmi.RemoteException

sendMessage

public void sendMessage(UserInfo userInfo,
                        NotificationMessage notificationMessage,
                        java.lang.String eventName)
                 throws MXException,
                        java.rmi.RemoteException

This method is used to send push notification message.

Parameters:

userInfo -

notificationMessage -

eventName -

Throws:

MXException

java.rmi.RemoteException

sendMessage

public void sendMessage(UserInfo userInfo,
                        NotificationMessage notificationMessage,
                        java.lang.String eventName,
                        java.lang.String projectName)
                 throws MXException,
                        java.rmi.RemoteException

This method is used to send push notification message.

Parameters:

userInfo -

notificationMessage -

eventName -

Throws:

MXException

java.rmi.RemoteException

sendMessageforUserId

public void sendMessageforUserId(UserInfo userInfo,
                                 java.lang.String notifMessageJsonStr,
                                 java.lang.String msgRecevingUserId,
                                 java.lang.String notifMessage,
                                 java.lang.String eventName,
                                 java.lang.String projectName)
                          throws MXException,
                                 java.rmi.RemoteException

This method is used to send push notification message. It is used for background tasks where task is executed with an admin user but the message is send to a different user. For example, A notification message in a queue processed by MIF. An escalation code processing an escalation to trigger a message. A background cron job doing something to send a message.

Parameters:

userInfo - : The admin user info based on MIF, escalation or cron task.

msgRecevingUserId -

notificationMessage -

Throws:

MXException

java.rmi.RemoteException

sendMessageforUserId

public void sendMessageforUserId(UserInfo userInfo,
                                 java.lang.String msgRecevingUserId,
                                 NotificationMessage notificationMessage,
                                 java.lang.String eventName,
                                 java.lang.String projectName)
                          throws MXException,
                                 java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

getProviderDevTypeSet

public MboSetRemote getProviderDevTypeSet(UserInfo userInfo,
                                          java.lang.String deviceType,
                                          java.lang.String projectName)
                                   throws MXException,
                                          java.rmi.RemoteException

Get Provider info for a device type (Android, iOS)

Parameters:

userInfo -

deviceType -

Returns:

Throws:

MXException

java.rmi.RemoteException

getProviderMbo

public MboRemote getProviderMbo()
                         throws MXException,
                                java.rmi.RemoteException

Get Provider info for a device type (Android, iOS)

Parameters:

userInfo -

deviceType -

Returns:

Throws:

MXException

java.rmi.RemoteException

getProviderName

public java.lang.String getProviderName()

getNotificationMessage

public NotificationMessage getNotificationMessage(java.lang.String msg,
                                                  java.lang.String deviceId)
                                           throws MXException,
                                                  java.rmi.RemoteException

This method creates a new notification message object for the device.

Parameters:

msg -

deviceId -

Returns:

Throws:

MXException

java.rmi.RemoteException

getNotificationMessage

public NotificationMessage getNotificationMessage(NotificationMessage notificationMessage,
                                                  java.lang.String deviceId)
                                           throws MXException,
                                                  java.rmi.RemoteException

This method creates a new notification message object for the device.

Parameters:

notificationMessage -

deviceId -

Returns:

Throws:

MXException

java.rmi.RemoteException

getRouterHandler

public BaseRouterHandler getRouterHandler()

setProviderName

public void setProviderName(java.lang.String providername)