psdi.server

Class BulletinBoardService

java.lang.Object

psdi.server.AppService

psdi.server.BulletinBoardService

All Implemented Interfaces:

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

public class BulletinBoardService
extends AppService
implements BulletinBoardServiceRemote, Service

BulletinBoardService is used for the communication among objects within the execution of the same thread. At most one bulletin board will exist in a MXServer. It is a service maintaining a bulletin board which allows threads to post and remove messages.

Please note that this is not for inter-thread communication, for that purpose, please see psdi.server.SharedSpace.

This service is not persistent. If the server hosting this service goes down, all already posted messages will be lost when the server starts up.

Currently this service is implemented as a singleton service, which means only one MXServer in the enterprise can host the service. However, we are considering the future plan to upgrade it to be duplicated services by enabling posted messages to be broadcasted to all the bulletin boards.

Field Summary

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
BulletinBoardService()
BulletinBoardService(MXServer mxServer)
BulletinBoardService(java.lang.String url, MXServer mxServer)

Method Summary

Modifier and Type	Method and Description
void	configure(java.util.Properties configData) Configuration information is presented in a Property object.
void	destroy() Release system resources.
java.lang.String	getURL() Used by ServiceCoordinator
void	init() Initialization should take place.
boolean	isAppService() Used by ServiceCoordinator
boolean	isInitialized() Check if class has been initialized.
boolean	isPosted(java.lang.String key) Check if a message is posted on the bulletin board by the same thread.
boolean	isPosted(java.lang.String key, UserInfo userInfo) Check if a message is posted on the bulletin board by the same user connection.
void	post(java.lang.String key) Post a message to the bulletin board.
void	post(java.lang.String key, UserInfo userInfo) Post a message to the bulletin board.
void	remove(java.lang.String key) Remove one posting of the message from the bulletin board.
void	remove(java.lang.String key, UserInfo userInfo) Remove one posting of the message from the bulletin board.
void	restart() Indicates that the Service should reload any internal cache's of information it's holding.
void	setURL(java.lang.String url) Required by ServiceRemote.

Methods inherited from class psdi.server.AppService

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface psdi.server.ServiceRemote

getName, isSingletonService

Methods inherited from interface psdi.server.Service

getName, isSingletonService

Constructor Detail

BulletinBoardService

public BulletinBoardService()
                     throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

BulletinBoardService

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

Parameters:

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

Throws:

java.rmi.RemoteException

BulletinBoardService

public BulletinBoardService(java.lang.String url,
                            MXServer mxServer)
                     throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

Method Detail

post

public void post(java.lang.String key)

Post a message to the bulletin board. The message can be any string understood by the poster and the reader. It is recommended to contain the information of the package or object and the message itself. For example: Invoice.NOOPSYSCODE.

The message will only be posted for this thread. If there is the same message posted by a different thread, it will be ignored. If the message is posted for the use by a method belonging to another object, which could be an rmi stub object, this method can NOT be used. Use the overloaded one post(String, UserInfo) instead.

Method post() has to be called in pairs with remove(). One thread can post the same message at different moment for multiple time, but there should be one remove() paired up with one post() everytime when the message is posted. If exception could occur after the message is posted and before a remove() can be called, try-finally blocks need to be used to make sure remove() is guaranteed to be called.

Example:
MXServer.getBulletinBoard().post("Invoice.NOOPSYSCODE");
try{
doSomething();
}
finally{
MXServer.getBulletinBoard().remove("Invoice.NOOPSYSCODE"); }

Specified by:

post in interface BulletinBoardServiceRemote

Parameters:

key - The message being posted. Key has to be different one another if they represent different meanings. It is recommended to contain the information of the package or object and the function. For example: Invoice.NOOPSYSCODE.

See Also:

remove(java.lang.String)

post

public void post(java.lang.String key,
                 UserInfo userInfo)

Post a message to the bulletin board. The message can be any string understood by the poster and the reader. It is recommended to contain the information of the package or object and the message itself. For example: Invoice.NOOPSYSCODE.

The message will only be posted for this user connection. If there is the same message posted by a different connection, it will be ignored. Method post() has to be called in pairs with remove(). One thread can post the same message at different moment for multiple time, but there should be one remove() paired up with one post() everytime when the message is posted. If exception could occur after the message is posted and before a remove() can be called, try-finally blocks need to be used to make sure remove() is guaranteed to be called.

Example:
MXServer.getBulletinBoard().post("Invoice.NOOPSYSCODE", UserInfo);
try{
doSomething();
}
finally{
MXServer.getBulletinBoard().remove("Invoice.NOOPSYSCODE", UserInfo); }

Specified by:

post in interface BulletinBoardServiceRemote

Parameters:

key - The message being posted. Key has to be different one another if they represent different meanings. It is recommended to contain the information of the package or object and the function. For example: Invoice.NOOPSYSCODE.

userInfo - The UserInfo object which contains the specific connection information. It has to be the one that the execution is performed on behalf, which has to be the same as the execution where reads and removes this message.

See Also:

remove(String, UserInfo)

isPosted

public boolean isPosted(java.lang.String key)

Check if a message is posted on the bulletin board by the same thread. The message will be ignored if posted by another thread. This method can only be used if the message was posted using method post(String) into the same thread.

Specified by:

isPosted in interface BulletinBoardServiceRemote

Parameters:

key - The message being checked. Key has to be different one another if they represent different meanings.

See Also:

post(java.lang.String), remove(java.lang.String)

isPosted

public boolean isPosted(java.lang.String key,
                        UserInfo userInfo)

Check if a message is posted on the bulletin board by the same user connection. The message will be ignored if posted by another user connection. This method can only be used if the message was posted using method post(String, UserInfo) by the same connection.

Specified by:

isPosted in interface BulletinBoardServiceRemote

Parameters:

key - The message being checked. Key has to be different one another if they represent different meanings.

userInfo - The UserInfo object which contains the specific connection information. It has to be the one that the execution is performed on behalf, which has to be the same as the execution where posts this message.

See Also:

post(String, UserInfo), remove(String, UserInfo)

remove

public void remove(java.lang.String key)

Remove one posting of the message from the bulletin board. One message can be posted by more than one objects to the bulleting board, remove method will just remove one of them. The post and remove should always be called in pairs. If exception could occur after the message is posted and before a remove() can be called, try-finally blocks need to be used to make sure remove() is guaranteed to be called. If a message is posted by calling method post(String), it has to be removed by remove(String). If it is posed by method post(String, UserInfo), it has to be removed by remove(String, UserInfo).

Example:
MXServer.getBulletinBoard().post("Invoice.NOOPSYSCODE");
try{
doSomething();
}
finally{
MXServer.getBulletinBoard().remove("Invoice.NOOPSYSCODE"); }

Specified by:

remove in interface BulletinBoardServiceRemote

Parameters:

key - The message being posted. Key has to be different one another if they represent different meanings.

userInfo - The UserInfo object which contains the specific connection information. It has to be the one that the execution is performed on behalf, which has to be the same as the execution where posts and reads this message.

See Also:

post(java.lang.String)

remove

public void remove(java.lang.String key,
                   UserInfo userInfo)

Remove one posting of the message from the bulletin board. One message can be posted by more than one objects to the bulleting board, remove method will just remove one of them. The post and remove should always be called in pairs. If exception could occur after the message is posted and before a remove() can be called, try-finally blocks need to be used to make sure remove() is guaranteed to be called. If a message is posted by calling method post(String), it has to be removed by remove(String). If it is posed by method post(String, UserInfo), it has to be removed by remove(String, UserInfo).

Example:
MXServer.getBulletinBoard().post("Invoice.NOOPSYSCODE", UserInfo);
try{
doSomething();
}
finally{
MXServer.getBulletinBoard().remove("Invoice.NOOPSYSCODE", UserInfo); }

Specified by:

remove in interface BulletinBoardServiceRemote

Parameters:

key - The message being posted. Key has to be different one another if they represent different meanings.

See Also:

post(String, UserInfo)

getURL

public java.lang.String getURL()

Description copied from class: AppService

Used by ServiceCoordinator

Specified by:

getURL in interface AppServiceRemote

Specified by:

getURL in interface Service

Specified by:

getURL in interface ServiceRemote

Overrides:

getURL in class AppService

isAppService

public boolean isAppService()

Description copied from class: AppService

Used by ServiceCoordinator

Specified by:

isAppService in interface Service

Specified by:

isAppService in interface ServiceRemote

Overrides:

isAppService in class AppService

restart

public void restart()

Indicates that the Service should reload any internal cache's of information it's holding.

Specified by:

restart in interface ServiceRemote

Overrides:

restart in class AppService

configure

public void configure(java.util.Properties configData)

Configuration information is presented in a Property object.

Specified by:

configure in interface Service

Overrides:

configure in class AppService

See Also:

Service

init

public void init()

Initialization should take place. This where long duration tasks and those that throw exceptions should take place, e.g. establishing network connections.

Specified by:

init in interface Service

Overrides:

init in class AppService

See Also:

Service

destroy

public void destroy()

Release system resources. The object should release all system resources. This will be called only once and is called to prepare the object for finalization.

Specified by:

destroy in interface Service

Overrides:

destroy in class AppService

See Also:

Service

setURL

public void setURL(java.lang.String url)

Required by ServiceRemote.

Specified by:

setURL in interface Service

Overrides:

setURL in class AppService

isInitialized

public boolean isInitialized()

Check if class has been initialized.

Specified by:

isInitialized in interface BulletinBoardServiceRemote

Returns:

True if the class has been initialized.