com.ibm.tivoli.maximo.optimization.service

Class OptimizationService

java.lang.Object

psdi.server.AppService

com.ibm.tivoli.maximo.optimization.service.OptimizationService

All Implemented Interfaces:

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

public class OptimizationService
extends AppService
implements OptimizationServiceRemote

Field Summary

Fields inherited from interface com.ibm.tivoli.maximo.optimization.service.OptimizationServiceRemote

ABORTED, ABORTING, FAILED, PROCESSED, PROCESSING

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
OptimizationService(MXServer mxServer) OptimizationService constructor.

Method Summary

Modifier and Type	Method and Description
void	cancelOptimizationJob(java.lang.String jobId, UserInfo userInfo)
void	deployOptimizationApp(java.lang.String odmApplicationName, ODMAppDeployInfo appDeployInfo, UserInfo userInfo) Takes the application package from the Java EE EAR (i.e from build) and then applies the deployment configuration to it and then deploys the application.
void	finishSKDODMERUN(long skdProjectId, java.lang.String status) Delete "optimization running" for the passed in scenario
void	finishSKDODMERUN(long skdProjectId, java.lang.String status, long skdOdmeRunId) Delete "optimization running" for the passed in scenario
java.lang.String	getOptimizationMosAPIBaseURL(UserInfo userInfo)
java.lang.String	getOptimizationMosAPIKey(UserInfo userInfo)
boolean	getUseCPS(UserInfo userInfo) Returns true if the CPS system property is set to true
void	init() Initializes the Optimization package.
void	listenToODMERun(MboRemote listenerMbo, boolean listen, long skdProjectId) Register another listener for ODME scenario run
void	ODMEaddRunMsg(long skdProjectId, UserInfo userInfo, java.lang.String message, boolean key) Allow sender to add a message to our map.
void	ODMEclearCompleted() Allow sender to clear completed tasks of our map.
void	ODMEclearRunMsg(long skdProjectId) Allow sender to clear messages of our map.
boolean	ODMEIsRunning(long skdProjectId) Return true if ODME is in progress for the scenario
boolean	runOptimization(UserInfo userInfo, java.lang.String odmApplicationName, OptimizationInputProcessParameters inputProcessParameters, OptimizationOutputProcessParameters outputProcessParameters)
void	setJobIDSKDODMERUN(long skdOdmeRunId, java.lang.String mosJobId) Updates the SKDODMERUN run record with the job id from the MOS.
long	startSKDODMERUN(long skdProjectId, java.lang.String user, java.lang.String status) Add "optimization running" for the passed in scenario
long	startSKDODMERUN(long skdProjectId, java.lang.String user, java.lang.String status, long skdOdmeRunIdIn) Add "optimization running" for the passed in scenario

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, 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

Constructor Detail

OptimizationService

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

OptimizationService constructor.

Parameters:

mxServer -

Throws:

java.rmi.RemoteException

Method Detail

init

public void init()

Initializes the Optimization package.

Specified by:

init in interface Service

Overrides:

init in class AppService

See Also:

Service

deployOptimizationApp

public void deployOptimizationApp(java.lang.String odmApplicationName,
                                  ODMAppDeployInfo appDeployInfo,
                                  UserInfo userInfo)
                           throws java.rmi.RemoteException,
                                  MXException

Description copied from interface: OptimizationServiceRemote

Takes the application package from the Java EE EAR (i.e from build) and then applies the deployment configuration to it and then deploys the application. After deployment, updates the database with the deployed application package.

Specified by:

deployOptimizationApp in interface OptimizationServiceRemote

Throws:

java.rmi.RemoteException

MXException

runOptimization

public boolean runOptimization(UserInfo userInfo,
                               java.lang.String odmApplicationName,
                               OptimizationInputProcessParameters inputProcessParameters,
                               OptimizationOutputProcessParameters outputProcessParameters)
                        throws java.rmi.RemoteException,
                               MXException

Specified by:

runOptimization in interface OptimizationServiceRemote

Throws:

java.rmi.RemoteException

MXException

listenToODMERun

public void listenToODMERun(MboRemote listenerMbo,
                            boolean listen,
                            long skdProjectId)
                     throws MXException,
                            java.rmi.RemoteException

Register another listener for ODME scenario run

Specified by:

listenToODMERun in interface OptimizationServiceRemote

Parameters:

listenerMbo - ProcessMonitor mbo.

listen - True to start listening, False to stop listening

skdProjectId - skdproject unique id

Throws:

MXException

java.rmi.RemoteException

ODMEIsRunning

public boolean ODMEIsRunning(long skdProjectId)
                      throws MXException,
                             java.rmi.RemoteException

Return true if ODME is in progress for the scenario

Specified by:

ODMEIsRunning in interface OptimizationServiceRemote

Parameters:

skdProjectId - skdproject unique id

Throws:

java.sql.SQLException

MXException

java.rmi.RemoteException

startSKDODMERUN

public long startSKDODMERUN(long skdProjectId,
                            java.lang.String user,
                            java.lang.String status)
                     throws MXException,
                            java.rmi.RemoteException

Add "optimization running" for the passed in scenario

Specified by:

startSKDODMERUN in interface OptimizationServiceRemote

Parameters:

skdProjectId - skdproject unique id

Throws:

MXException

java.rmi.RemoteException

startSKDODMERUN

public long startSKDODMERUN(long skdProjectId,
                            java.lang.String user,
                            java.lang.String status,
                            long skdOdmeRunIdIn)
                     throws MXException,
                            java.rmi.RemoteException

Add "optimization running" for the passed in scenario

Throws:

MXException

java.rmi.RemoteException

finishSKDODMERUN

public void finishSKDODMERUN(long skdProjectId,
                             java.lang.String status)
                      throws MXException,
                             java.rmi.RemoteException

Delete "optimization running" for the passed in scenario

Specified by:

finishSKDODMERUN in interface OptimizationServiceRemote

Parameters:

skdProjectId - skdproject unique id

Throws:

MXException

java.rmi.RemoteException

finishSKDODMERUN

public void finishSKDODMERUN(long skdProjectId,
                             java.lang.String status,
                             long skdOdmeRunId)
                      throws MXException,
                             java.rmi.RemoteException

Delete "optimization running" for the passed in scenario

Specified by:

finishSKDODMERUN in interface OptimizationServiceRemote

Parameters:

skdProjectId - skdproject unique id

Throws:

MXException

java.rmi.RemoteException

setJobIDSKDODMERUN

public void setJobIDSKDODMERUN(long skdOdmeRunId,
                               java.lang.String mosJobId)
                        throws MXException,
                               java.rmi.RemoteException

Updates the SKDODMERUN run record with the job id from the MOS.

Specified by:

setJobIDSKDODMERUN in interface OptimizationServiceRemote

Parameters:

skdProjectId - skdproject unique id

Throws:

MXException

java.rmi.RemoteException

ODMEaddRunMsg

public void ODMEaddRunMsg(long skdProjectId,
                          UserInfo userInfo,
                          java.lang.String message,
                          boolean key)
                   throws MXException,
                          java.rmi.RemoteException

Description copied from interface: OptimizationServiceRemote

Allow sender to add a message to our map.

Specified by:

ODMEaddRunMsg in interface OptimizationServiceRemote

Parameters:

skdProjectId - skdproject unique id

Throws:

MXException

java.rmi.RemoteException

ODMEclearRunMsg

public void ODMEclearRunMsg(long skdProjectId)
                     throws MXException,
                            java.rmi.RemoteException

Allow sender to clear messages of our map.

Specified by:

ODMEclearRunMsg in interface OptimizationServiceRemote

Parameters:

skdProjectId - skdproject unique id

Throws:

MXException

java.rmi.RemoteException

ODMEclearCompleted

public void ODMEclearCompleted()
                        throws MXException,
                               java.rmi.RemoteException

Allow sender to clear completed tasks of our map.

Specified by:

ODMEclearCompleted in interface OptimizationServiceRemote

Throws:

MXException

java.rmi.RemoteException

getUseCPS

public boolean getUseCPS(UserInfo userInfo)
                  throws java.rmi.RemoteException

Description copied from interface: OptimizationServiceRemote

Returns true if the CPS system property is set to true

Specified by:

getUseCPS in interface OptimizationServiceRemote

Throws:

java.rmi.RemoteException

getOptimizationMosAPIBaseURL

public java.lang.String getOptimizationMosAPIBaseURL(UserInfo userInfo)
                                              throws java.rmi.RemoteException

Specified by:

getOptimizationMosAPIBaseURL in interface OptimizationServiceRemote

Throws:

java.rmi.RemoteException

getOptimizationMosAPIKey

public java.lang.String getOptimizationMosAPIKey(UserInfo userInfo)
                                          throws java.rmi.RemoteException

Specified by:

getOptimizationMosAPIKey in interface OptimizationServiceRemote

Throws:

java.rmi.RemoteException

cancelOptimizationJob

public void cancelOptimizationJob(java.lang.String jobId,
                                  UserInfo userInfo)
                           throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException