psdi.iface.mic

Class MicService

java.lang.Object

psdi.server.AppService

psdi.iface.mic.MicService

All Implemented Interfaces:

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

Direct Known Subclasses:

EntMicService

public class MicService
extends AppService
implements MicServiceRemote, MicConstants

Field Summary

Fields

Modifier and Type	Field and Description
ObjectStructureCache	interDD Describes Integration Data Dictinary

Fields inherited from interface psdi.iface.mic.MicConstants

ACTION, ACTION_EJB_LOCAL_REF_KEY, ACTION_EJB_REF_KEY, ACTIONADD, ACTIONADDUPDATE, ACTIONDELETE, ACTIONREPLACE, ACTIONUPDATE, ADD, APPEXPORT, AXISDIR, BYPASS, COMMA_CHAR, COMPLETE, DATATYPE, DELETED, EJB_JNDI_KEY, ENABLEPOLLING, ENTERPRISE_EJB_LOCAL_REF_KEY, ENTERPRISE_EJB_REF_KEY, ERREXTRACT, ERROR, ERRORED, ERRORMESSAGETAG, ERTAG, EXCLUDE, EXTRACT, FILEDIR, FILEEXTENSION, FILENAME, FLAT_DATA, FLAT_ROW, FLATFILESEP, FLATFILETYPE, IFACEDRIVER, IFACEEPDESC, IFACEISREMOTE, IFACEPASSWORD, IFACETABLE, IFACEURL, IFACEUSERNAME, INCLUDE, INTEGRATION_LOGGER, IRTAG, ISCONTINUOUS, JMSRECOVERYDIR, JMSRECOVERYMSGDATAELEMENT, JMSRECOVERYMSGPROPELEMENT, JMSRECOVERYTOPELEMENT, JSONFILETYPE, LOADFLAT, LOADXML, LONGDESCRIPTIONCOLNAME, MAX_AUTH_HEADER, MAX_POST_SIZE, MAXIMO_TYPE, MEA_PROCESS_FLAG, MEAAPPNAME, MESSAGE_DESTINATION, MESSAGE_INTERFACE, MESSAGE_INTERFACE_TABLE, MESSAGE_INTERFACE_TYPE, MESSAGE_OS_NAME, MESSAGE_POLL_TABLE, MESSAGE_SENDER, MOS_EJB_LOCAL_REF_KEY, MOS_EJB_REF_KEY, MSG_ERR_MSG, MSG_KEY_VAL, MSG_OP_MODE, MSG_OPERATION, MSG_STATUS, MSG_TRK_ENABLED, MSG_TRK_EXTSYS, MSG_TRK_STORE_MSG, MXJMS, NONPERSISTENT, NONRESTRICTSETTING, NULL, POLLINGFREQUENCY, PROCESS, PROCESSED, QUEUE_NAME, QUEUECONTEXT, RECEIVED, REJECTED, RESTRICTSETTING, RESTRICTSTRUCTURE, ROOT_NODE, ROUTER_JNDI_NAME, SEARCH_FIELD_VAL, SKIP, SKIPMBO, sNo, sYes, TENANTID, TEXTQUALIFIER, TOPTAGFORERR, TOTAL_GL_COMPS_ALLOWED, TRANSIDSEQ, TXNDATA, UPDATE, USER, USERCOLUMN, VIEW, XML_DATA, XMLFILETYPE, XMLTYPE

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
MicService() Construct the service
MicService(MXServer mxServer)

Method Summary

Modifier and Type	Method and Description
byte[]	bidiTransformData(java.util.Map<java.lang.String,?> metaData, byte[] data) Return data using bidi conversion
void	callIntegrityChecker(java.util.Map options)
boolean	checkStatus(StructureData irData, java.lang.String extSystem, java.lang.String sendListName, java.lang.String orgId, java.lang.String siteId, boolean sendUpdates) This method checks status and does the following.
void	configure(java.util.Properties configData) Configure the AppService.
void	deleteErrorFileAndTableRow(java.util.Map<java.lang.String,java.lang.String> propMap, boolean inbound, java.lang.String queueName, UserInfo userInfo) Delete the message entry in the error tracking tables.
int	deleteQueueData(java.lang.String queueName, java.lang.String selector, int count, UserInfo userInfo) Delete the messages in a JMS queue based on selectors and the count
void	exportData(java.lang.String ifaceName, java.lang.String sender, java.lang.String where, java.lang.String orderBy, int batchSize, UserInfo userInfo, int maxcount) This method will be called from GUI for bulk data loading from MAXIMO to external system
void	exportData(java.lang.String interfaceName, java.lang.String sender, java.lang.String where, UserInfo userInfo, int maxcount) This method will be called from GUI for bulk data loading from MAXIMO to external system
void	generateMOSServiceSchema(java.lang.String mosName, boolean forceGenerate) generates the Object Structure schema
byte[]	getBidiData(byte[] responseBody, java.lang.String bidiFormat) Return data using bidi conversion
java.lang.String	getEndPointName(java.lang.String extSysName, java.lang.String pubChannelName) Get end point name for external system and publish channel.
ObjectStructureCache	getIntegrationDD() Get reference to Integration DD.
java.lang.String	getLaunchURL(java.lang.String launchEntryName, MboRemote mainMbo) Get Object Structure name base on entity name of the interface table.
java.lang.String	getMEAProperty(java.lang.String propertyName) Utility method to get a MEA property
static boolean	getMicServiceInitDone()
MicSetInfo	getMicSetInfo(java.lang.String mosName, java.lang.String objname) Deprecated.
UserInfo	getMonitorUserInfo() Create new instance of user info for Integration User
java.lang.String	getMosNameForPubChannel(java.lang.String channelName) Get object structure name for publish channel.
UserInfo	getNewUserInfo() Create new instance of user info for Integration User
java.lang.String	getNormalizedName(java.lang.String queueName) Get normalized queue name.
MosInfo	getObjectStructureInfo(java.lang.String objectStructureName) Get MosInfo for a given Object Structure name.
java.lang.String	getOSNameForIfaceTable(java.lang.String entityName) Get Object Structure name base on entity name of the interface table.
MosDetailInfo	getPrimaryInfo(java.lang.String mosName) Get the primary MosDetailInfo
java.lang.String	getQueueToWrite() Get notification queue name.
java.util.Map<java.lang.String,java.lang.Object>	getRowStampMap() Get row stamps.
java.lang.String[]	getTargetWindow(java.lang.String launchEntryName, MboRemote mainMbo) Get Target Window.
void	init() Init method
byte[]	internalProcessData(byte[] in, UserInfo info, MXTransaction trans) Internal method for Unit Test This method will be called for every object structure service to process incoming transactions.
byte[]	internalProcessExternalData(byte[] data, java.lang.String sender, java.lang.String ifaceName, UserInfo info, MXTransaction trans) Internal method for Unit Test.
void	invokeChannel(java.lang.String channelName, MboRemote mbo) Invoke Invocation Channel.
byte[]	loadData(byte[] in, UserInfo info, MXTransaction trans, java.util.Map defaults) This method will be called to load object structure XML data.
void	loadSystemData(java.lang.String directory, java.lang.String intLevel, UserInfo userInfo) Process system data comimg in Maximo format.
java.util.List<java.lang.String>	populateQueueList(java.util.HashSet<java.lang.String> validateAgainst, java.lang.String nqDescription) Populate JMS queues entries.
byte[]	processExternalData(byte[] data, java.lang.String sender, java.lang.String serviceName, UserInfo info, MXTransaction trans) Process data comimg from external system.
byte[]	processExternalData(byte[] data, java.lang.String sender, java.lang.String serviceName, UserInfo info, MXTransaction trans, boolean fromQueue) Process data comimg from external system.
void	processJMSRecovery(java.lang.String queueName, UserInfo userInfo) JMS recovery logic
byte[]	processObjectStructureService(byte[] in, java.lang.String mosName, java.lang.String messageType, UserInfo info, MXTransaction trans) This method will be called for every object structure service to process incoming transactions.
byte[]	processObjectStructureService(org.jdom.Document doc, java.lang.String mosName, java.lang.String messageType, UserInfo info, MXTransaction trans) This method will be called for every object structure service to process incoming transactions.
long	processOSLC(byte[] in, java.lang.String mosName, java.lang.String messageType, UserInfo info, MXTransaction trans, MboRemote mbo, java.lang.String format) Deprecated.
long	processOSLCAsJSON(com.ibm.json.java.JSONArtifact jsonData, java.lang.String mosName, java.lang.String messageType, UserInfo info, MXTransaction trans, MboRemote mbo, java.lang.String format)
long	processOSLCAsJSON(com.ibm.json.java.JSONArtifact jsonData, java.lang.String mosName, java.lang.String messageType, UserInfo info, MXTransaction trans, MboRemote mbo, java.lang.String format, OslcRequest oslcRequest)
long	processOSLCJSON(byte[] in, java.lang.String mosName, java.lang.String messageType, UserInfo info, MXTransaction trans, MboRemote mbo) This method will be called for every object structure service to process incoming transactions.
byte[]	query(byte[] queryXml, java.lang.String serviceName, java.lang.String extSystem, UserInfo userInfo) Query maximo via query query services.
byte[]	query(byte[] queryXml, java.lang.String mosName, UserInfo userInfo) Query maximo via query objec structure service.
byte[]	query(org.jdom.Document data, java.lang.String serviceName, java.lang.String extSystem, UserInfo userInfo) Query maximo via query query services.
byte[]	query(org.jdom.Document queryXml, java.lang.String mosName, UserInfo userInfo) Query maximo via query objec structure service.
void	refreshIntegrationDD() Refresh ObjectStructureCache.
void	resetWorkscapelayoutCards(UserInfo info)
byte[]	routeData(byte[] data, java.lang.String endPointName, java.util.Map<java.lang.String,?> metaData) Deplyment manager API to Route Data.
void	tryObjectStructure(java.lang.String mosName, java.lang.String where, UserInfo userInfo)
void	validateFormula(java.lang.String objectName, UserInfo info, java.lang.String formula)
void	viewQueueData(java.lang.String queueName, java.lang.String selector, int count, UserInfo userInfo) Dumps all the messages in the JMS queue into a preconfigured folder.
int	viewQueueData(java.lang.String queueName, java.lang.String selector, int count, UserInfo userInfo, boolean countOnly)
int	viewQueueData(java.lang.String queueName, java.lang.String selector, int count, UserInfo userInfo, boolean countOnly, java.util.List<java.lang.String> viewFilesList)
void	writeDataToNotificationQueue(MXTransaction mxtran, java.lang.String eventForUser, java.util.Map<java.lang.String,java.lang.String> properties, UserInfo userInfo, byte[] queueData, java.lang.String textData, boolean syntheticEvent) Write notification to the queue.
void	wsinteraction(java.lang.String interactionName, MboRemote mbo) Process Web Service Interaction.

Methods inherited from class psdi.server.AppService

checkSecurity, 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.iface.mic.MicServiceRemote

restart

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

Field Detail

interDD

public ObjectStructureCache interDD

Describes Integration Data Dictinary

Constructor Detail

MicService

public MicService()
           throws java.rmi.RemoteException

Construct the service

Throws:

java.rmi.RemoteException

MicService

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

Parameters:

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

Throws:

java.rmi.RemoteException

Method Detail

configure

public void configure(java.util.Properties configData)

Configure the AppService.

Specified by:

configure in interface Service

Overrides:

configure in class AppService

See Also:

Service

init

public void init()

Init method

Specified by:

init in interface Service

Overrides:

init in class AppService

See Also:

Service

getPrimaryInfo

public MosDetailInfo getPrimaryInfo(java.lang.String mosName)
                             throws java.rmi.RemoteException,
                                    MXException

Get the primary MosDetailInfo

Parameters:

mosName - the name of the object structure

Returns:

the primary MosDetailInfo

Throws:

java.rmi.RemoteException

MXException

getMicSetInfo

public MicSetInfo getMicSetInfo(java.lang.String mosName,
                                java.lang.String objname)
                         throws java.rmi.RemoteException,
                                MXException

Deprecated.

Get a MicSetInfo for a given Integration object and object name

Parameters:

mosName - the name of the integration object

objname - the name of the object

Returns:

the MicSetInfo

Throws:

java.rmi.RemoteException

MXException

routeData

public byte[] routeData(byte[] data,
                        java.lang.String endPointName,
                        java.util.Map<java.lang.String,?> metaData)
                 throws MXException,
                        java.rmi.RemoteException

Deplyment manager API to Route Data.

Specified by:

routeData in interface MicServiceRemote

Parameters:

data - byte repersentataion of the data

endPointName - name of the end point

metaData - Map of parameters

Returns:

the response xml as a byte[]

Throws:

java.rmi.RemoteException

MXException

callIntegrityChecker

public void callIntegrityChecker(java.util.Map options)
                          throws MXException,
                                 java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

validateFormula

public void validateFormula(java.lang.String objectName,
                            UserInfo info,
                            java.lang.String formula)
                     throws MXException,
                            java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

tryObjectStructure

public void tryObjectStructure(java.lang.String mosName,
                               java.lang.String where,
                               UserInfo userInfo)
                        throws MXException,
                               java.rmi.RemoteException

Specified by:

tryObjectStructure in interface MicServiceRemote

Throws:

MXException

java.rmi.RemoteException

getNewUserInfo

public UserInfo getNewUserInfo()
                        throws MXException,
                               java.rmi.RemoteException

Create new instance of user info for Integration User

Returns:

- UserInfo object

Throws:

MXException - MAXIMO exception

java.rmi.RemoteException - Remote exception

getMonitorUserInfo

public UserInfo getMonitorUserInfo()
                            throws MXException,
                                   java.rmi.RemoteException

Create new instance of user info for Integration User

Returns:

- UserInfo object

Throws:

MXException - MAXIMO exception

java.rmi.RemoteException - Remote exception

getIntegrationDD

public ObjectStructureCache getIntegrationDD()

Get reference to Integration DD.

Returns:

Reference to ObjectStructureCache object

processObjectStructureService

public byte[] processObjectStructureService(byte[] in,
                                            java.lang.String mosName,
                                            java.lang.String messageType,
                                            UserInfo info,
                                            MXTransaction trans)
                                     throws MXException,
                                            java.rmi.RemoteException

This method will be called for every object structure service to process incoming transactions.

Specified by:

processObjectStructureService in interface MicServiceRemote

Parameters:

in - Give byteArray

mosName - Give name of object structure.

messageType - Give name of operation.

info - Give reference to UserInfo object.

trans - Give MXTransaction object.

Throws:

MXException - MAXIMO exception

java.rmi.RemoteException - Remote exception

processOSLCJSON

public long processOSLCJSON(byte[] in,
                            java.lang.String mosName,
                            java.lang.String messageType,
                            UserInfo info,
                            MXTransaction trans,
                            MboRemote mbo)
                     throws MXException,
                            java.rmi.RemoteException

This method will be called for every object structure service to process incoming transactions.

Parameters:

in - Give byteArray

mosName - Give name of object structure.

messageType - Give name of operation.

info - Give reference to UserInfo object.

trans - Give MXTransaction object.

Throws:

MXException - MAXIMO exception

java.rmi.RemoteException - Remote exception

processOSLC

@Deprecated
public long processOSLC(byte[] in,
                                     java.lang.String mosName,
                                     java.lang.String messageType,
                                     UserInfo info,
                                     MXTransaction trans,
                                     MboRemote mbo,
                                     java.lang.String format)
                              throws MXException,
                                     java.rmi.RemoteException

Deprecated.

This method will be called for every object structure service to process incoming transactions.

Parameters:

in - Give byteArray

mosName - Give name of object structure.

messageType - Give name of operation.

info - Give reference to UserInfo object.

trans - Give MXTransaction object.

Throws:

MXException - MAXIMO exception

java.rmi.RemoteException - Remote exception

processOSLCAsJSON

public long processOSLCAsJSON(com.ibm.json.java.JSONArtifact jsonData,
                              java.lang.String mosName,
                              java.lang.String messageType,
                              UserInfo info,
                              MXTransaction trans,
                              MboRemote mbo,
                              java.lang.String format,
                              OslcRequest oslcRequest)
                       throws MXException,
                              java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

processOSLCAsJSON

public long processOSLCAsJSON(com.ibm.json.java.JSONArtifact jsonData,
                              java.lang.String mosName,
                              java.lang.String messageType,
                              UserInfo info,
                              MXTransaction trans,
                              MboRemote mbo,
                              java.lang.String format)
                       throws MXException,
                              java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

processObjectStructureService

public byte[] processObjectStructureService(org.jdom.Document doc,
                                            java.lang.String mosName,
                                            java.lang.String messageType,
                                            UserInfo info,
                                            MXTransaction trans)
                                     throws MXException,
                                            java.rmi.RemoteException

This method will be called for every object structure service to process incoming transactions.

Parameters:

doc - Give byteArray

mosName - Give name of object structure.

messageType - Give name of operation.

info - Give reference to UserInfo object.

trans - Give MXTransaction object.

Throws:

MXException - MAXIMO exception

java.rmi.RemoteException - Remote exception

loadData

public byte[] loadData(byte[] in,
                       UserInfo info,
                       MXTransaction trans,
                       java.util.Map defaults)
                throws MXException,
                       java.rmi.RemoteException

This method will be called to load object structure XML data.

Specified by:

loadData in interface MicServiceRemote

Parameters:

in - Give byteArray

info - Give reference to UserInfo object.

trans - Give MXTransaction object.

defaults - Map of defult values to skip setting data to Mbo from XML.

Throws:

MXException - MAXIMO exception

java.rmi.RemoteException - Remote exception

internalProcessData

public byte[] internalProcessData(byte[] in,
                                  UserInfo info,
                                  MXTransaction trans)
                           throws MXException,
                                  java.rmi.RemoteException

Internal method for Unit Test This method will be called for every object structure service to process incoming transactions.

Parameters:

in - Give byteArray

info - Give reference to UserInfo object.

trans - Give MXTransaction object.

Throws:

MXException - MAXIMO exception

java.rmi.RemoteException - Remote exception

refreshIntegrationDD

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

Refresh ObjectStructureCache.

Throws:

MXException

java.rmi.RemoteException

getMicServiceInitDone

public static boolean getMicServiceInitDone()

getMEAProperty

public java.lang.String getMEAProperty(java.lang.String propertyName)
                                throws java.rmi.RemoteException

Utility method to get a MEA property

Parameters:

propertyName - the property name

Returns:

the property value

Throws:

java.rmi.RemoteException - Remote exception

generateMOSServiceSchema

public void generateMOSServiceSchema(java.lang.String mosName,
                                     boolean forceGenerate)
                              throws java.rmi.RemoteException,
                                     MXException

generates the Object Structure schema

Specified by:

generateMOSServiceSchema in interface MicServiceRemote

Parameters:

mosName - the Object Structure name

Throws:

java.rmi.RemoteException

MXException

getObjectStructureInfo

public MosInfo getObjectStructureInfo(java.lang.String objectStructureName)
                               throws java.rmi.RemoteException

Get MosInfo for a given Object Structure name.

Specified by:

getObjectStructureInfo in interface MicServiceRemote

Returns:

MosInfo object

Throws:

java.rmi.RemoteException

resetWorkscapelayoutCards

public void resetWorkscapelayoutCards(UserInfo info)
                               throws MXException,
                                      java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

viewQueueData

public int viewQueueData(java.lang.String queueName,
                         java.lang.String selector,
                         int count,
                         UserInfo userInfo,
                         boolean countOnly,
                         java.util.List<java.lang.String> viewFilesList)
                  throws java.rmi.RemoteException,
                         MXException

Specified by:

viewQueueData in interface MicServiceRemote

Parameters:

queueName - the name of the queue

selector - the selector clause

count - the max number of rows to be viewed

userInfo - the authenticated userInfo

countOnly - true implies the viewd messages would not be written to a folder and false otherwise. Note in either case all the messages would be viewed from the queue - so in case the number of viewed messages is large it will effect the performance in either case.

viewFilesList - List of file names [absolute location] of messages that were viewed.

Returns:

number of records viewed

Throws:

java.rmi.RemoteException

MXException

viewQueueData

public int viewQueueData(java.lang.String queueName,
                         java.lang.String selector,
                         int count,
                         UserInfo userInfo,
                         boolean countOnly)
                  throws java.rmi.RemoteException,
                         MXException

Specified by:

viewQueueData in interface MicServiceRemote

Parameters:

queueName - the name of the queue

selector - the selector clause

count - the max number of rows to be viewed

userInfo - the authenticated userInfo

countOnly - true implies the viewd messages would not be written to a folder and false otherwise. Note in either case all the messages would be viewed from the queue - so in case the number of viewed messages is large it will effect the performance in either case.

Returns:

number of records viewed

Throws:

java.rmi.RemoteException

MXException

deleteQueueData

public int deleteQueueData(java.lang.String queueName,
                           java.lang.String selector,
                           int count,
                           UserInfo userInfo)
                    throws java.rmi.RemoteException,
                           MXException

Delete the messages in a JMS queue based on selectors and the count

Specified by:

deleteQueueData in interface MicServiceRemote

Parameters:

queueName - the JNDI name of the queue

selector - the messages selector [where clause].

count - the count of messages to be deleted. A value of -1 indicates delete all messages.

userInfo - the user details for security validation

Throws:

java.rmi.RemoteException - Remote exception

MXException - MAXIMO exception

viewQueueData

public void viewQueueData(java.lang.String queueName,
                          java.lang.String selector,
                          int count,
                          UserInfo userInfo)
                   throws java.rmi.RemoteException,
                          MXException

Dumps all the messages in the JMS queue into a preconfigured folder. Viewing messages from the Queue does not delete messages from the queue.

Specified by:

viewQueueData in interface MicServiceRemote

Parameters:

queueName - the JNDI name of the queue

selector - the messages selector [where clause].

count - the count of messages to be viewed. A value of -1 indicates delete all messages.

userInfo - the user details for security validation

Throws:

java.rmi.RemoteException - Remote exception

MXException - MAXIMO exception

loadSystemData

public void loadSystemData(java.lang.String directory,
                           java.lang.String intLevel,
                           UserInfo userInfo)
                    throws MXException,
                           java.rmi.RemoteException

Process system data comimg in Maximo format. THis method can be used for installation of adapter or patches

Specified by:

loadSystemData in interface MicServiceRemote

Parameters:

directory - Give directory where load files are

intLevel - Lervel of processing.

userInfo - the user details for security validation

Throws:

MXException - MAXIMO exception

java.rmi.RemoteException - Remote exception

processExternalData

public byte[] processExternalData(byte[] data,
                                  java.lang.String sender,
                                  java.lang.String serviceName,
                                  UserInfo info,
                                  MXTransaction trans)
                           throws MXException,
                                  java.rmi.RemoteException

Process data comimg from external system. This is remote method for transaction going without queue.

Specified by:

processExternalData in interface MicServiceRemote

Parameters:

data - Give data as byte array

sender - Give sender name.

ifaceName - Give name of interface.

info - Give reference to UserInfo object.

trans - Give MXTransaction object.

Throws:

MXException - MAXIMO exception

java.rmi.RemoteException - Remote exception

processExternalData

public byte[] processExternalData(byte[] data,
                                  java.lang.String sender,
                                  java.lang.String serviceName,
                                  UserInfo info,
                                  MXTransaction trans,
                                  boolean fromQueue)
                           throws MXException,
                                  java.rmi.RemoteException

Process data comimg from external system. This is overriden method and will create CompasiteMessage and call overriden method.

Parameters:

data - Give data as byte array

sender - Give sender name.

ifaceName - Give name of service.

userInfo - Give reference to UserInfo object.

trans - Give MXTransaction object.

fromQueue - Give indicator for data coming from queue.

Throws:

MXException - MAXIMO exception

java.rmi.RemoteException - Remote exception

deleteErrorFileAndTableRow

public void deleteErrorFileAndTableRow(java.util.Map<java.lang.String,java.lang.String> propMap,
                                       boolean inbound,
                                       java.lang.String queueName,
                                       UserInfo userInfo)
                                throws MXException,
                                       java.rmi.RemoteException

Delete the message entry in the error tracking tables.

Parameters:

propMap - the message properties

inbound - true for inbound and false for outbound queues

queueName - the jndi name of the queue

userInfo - the authenticated user

Throws:

MXException

java.rmi.RemoteException

internalProcessExternalData

public byte[] internalProcessExternalData(byte[] data,
                                          java.lang.String sender,
                                          java.lang.String ifaceName,
                                          UserInfo info,
                                          MXTransaction trans)
                                   throws MXException,
                                          java.rmi.RemoteException

Internal method for Unit Test. This is remote method for transaction going without queue.

Parameters:

data - Give data as byte array

sender - Give sender name.

ifaceName - Give name of interface.

info - Give reference to UserInfo object.

trans - Give MXTransaction object.

Throws:

MXException - MAXIMO exception

java.rmi.RemoteException - Remote exception

exportData

public void exportData(java.lang.String interfaceName,
                       java.lang.String sender,
                       java.lang.String where,
                       UserInfo userInfo,
                       int maxcount)
                throws MXException,
                       java.rmi.RemoteException

This method will be called from GUI for bulk data loading from MAXIMO to external system

Specified by:

exportData in interface MicServiceRemote

Parameters:

ifaceName - Give name of channel.

sender - Give external system name.

where - Give where clause.

userInfo - Give reference to UserInfo object.

Throws:

MXException - MAXIMO exception

java.rmi.RemoteException - Remote exception

exportData

public void exportData(java.lang.String ifaceName,
                       java.lang.String sender,
                       java.lang.String where,
                       java.lang.String orderBy,
                       int batchSize,
                       UserInfo userInfo,
                       int maxcount)
                throws MXException,
                       java.rmi.RemoteException

This method will be called from GUI for bulk data loading from MAXIMO to external system

Parameters:

ifaceName - Give name of channel.

sender - Give external system name.

where - Give where clause.

userInfo - Give reference to UserInfo object.

Throws:

MXException - MAXIMO exception

java.rmi.RemoteException - Remote exception

query

public byte[] query(byte[] queryXml,
                    java.lang.String serviceName,
                    java.lang.String extSystem,
                    UserInfo userInfo)
             throws MXException,
                    java.rmi.RemoteException

Query maximo via query query services. Returns response in XML format.

Specified by:

query in interface MicServiceRemote

Parameters:

data - the query xml in byte[] format

serviceName - name of the service

extSystem - name of the external system

userInfo - the UserInfo for user details

Returns:

the response xml as a byte[]

Throws:

java.rmi.RemoteException

MXException

query

public byte[] query(org.jdom.Document data,
                    java.lang.String serviceName,
                    java.lang.String extSystem,
                    UserInfo userInfo)
             throws MXException,
                    java.rmi.RemoteException

Query maximo via query query services. Returns response in XML format.

Parameters:

data - the query xml in byte[] format

serviceName - name of the service

extSystem - name of the external system

userInfo - the UserInfo for user details

Returns:

the response xml as a byte[]

Throws:

java.rmi.RemoteException

MXException

query

public byte[] query(byte[] queryXml,
                    java.lang.String mosName,
                    UserInfo userInfo)
             throws MXException,
                    java.rmi.RemoteException

Query maximo via query objec structure service. Returns response in XML format.

Specified by:

query in interface MicServiceRemote

Parameters:

queryXml - the query xml

mosName - the object structure name

userInfo - the UserInfo for user details

Returns:

the response xml as a byte[]

Throws:

java.rmi.RemoteException

MXException

query

public byte[] query(org.jdom.Document queryXml,
                    java.lang.String mosName,
                    UserInfo userInfo)
             throws MXException,
                    java.rmi.RemoteException

Query maximo via query objec structure service. Returns response in XML format.

Parameters:

queryXml - the query xml

mosName - the object structure name

userInfo - the UserInfo for user details

Returns:

the response xml as a byte[]

Throws:

java.rmi.RemoteException

MXException

processJMSRecovery

public void processJMSRecovery(java.lang.String queueName,
                               UserInfo userInfo)
                        throws java.rmi.RemoteException,
                               MXException

JMS recovery logic

Specified by:

processJMSRecovery in interface MicServiceRemote

Parameters:

queueName - the JNDI name of the queue

userInfo - the user details for security validation

Throws:

java.rmi.RemoteException

MXException

getOSNameForIfaceTable

public java.lang.String getOSNameForIfaceTable(java.lang.String entityName)
                                        throws java.rmi.RemoteException,
                                               MXException

Get Object Structure name base on entity name of the interface table.

Parameters:

entityName - entity name

Returns:

Object Structure Name

Throws:

java.rmi.RemoteException

MXException

populateQueueList

public java.util.List<java.lang.String> populateQueueList(java.util.HashSet<java.lang.String> validateAgainst,
                                                          java.lang.String nqDescription)
                                                   throws java.rmi.RemoteException

Populate JMS queues entries.

Parameters:

validateAgainst - set of values

nqDescription - queue description

Returns:

Object Structure Name

Throws:

java.rmi.RemoteException

getTargetWindow

public java.lang.String[] getTargetWindow(java.lang.String launchEntryName,
                                          MboRemote mainMbo)
                                   throws java.rmi.RemoteException,
                                          MXApplicationException,
                                          MXException

Get Target Window.

Parameters:

launchEntryName - launch entry name

mainMbo - main mbo reference

Returns:

Target Window URL

Throws:

MXException

java.rmi.RemoteException

MXApplicationException

invokeChannel

public void invokeChannel(java.lang.String channelName,
                          MboRemote mbo)
                   throws MXException,
                          java.rmi.RemoteException

Invoke Invocation Channel.

Parameters:

channelName - invoke channel name

mbo - mbo reference

Throws:

MXException

java.rmi.RemoteException

wsinteraction

public void wsinteraction(java.lang.String interactionName,
                          MboRemote mbo)
                   throws java.rmi.RemoteException,
                          MXException

Process Web Service Interaction.

Parameters:

interactionName - interaction name

mbo - mbo reference

Throws:

MXException

java.rmi.RemoteException

bidiTransformData

public byte[] bidiTransformData(java.util.Map<java.lang.String,?> metaData,
                                byte[] data)
                         throws MXException

Return data using bidi conversion

Returns:

the Bidi transformed data to be collected and used by the descendant classes

Throws:

MXException

getBidiData

public byte[] getBidiData(byte[] responseBody,
                          java.lang.String bidiFormat)
                   throws MXException

Return data using bidi conversion

Returns:

the Bidi transformed data to be collected and used by the descendant classes

Throws:

MXException

getEndPointName

public java.lang.String getEndPointName(java.lang.String extSysName,
                                        java.lang.String pubChannelName)
                                 throws java.rmi.RemoteException,
                                        MXException

Get end point name for external system and publish channel.

Parameters:

extSysName - external system name

pubChannelName - publish channel name

Returns:

end point Name

Throws:

MXException

java.rmi.RemoteException

getQueueToWrite

public java.lang.String getQueueToWrite()
                                 throws MXException

Get notification queue name.

Returns:

queue Name

Throws:

MXException

writeDataToNotificationQueue

public void writeDataToNotificationQueue(MXTransaction mxtran,
                                         java.lang.String eventForUser,
                                         java.util.Map<java.lang.String,java.lang.String> properties,
                                         UserInfo userInfo,
                                         byte[] queueData,
                                         java.lang.String textData,
                                         boolean syntheticEvent)
                                  throws MXException

Write notification to the queue.

Parameters:

mxtran - Maximo transaction

eventForUser - user name

properties - map of queue properties

userInfo - user info

queueData - queue data

textData - text data

syntheticEvent - synthetic event

Throws:

MXException

getNormalizedName

public java.lang.String getNormalizedName(java.lang.String queueName)
                                   throws MXException

Get normalized queue name.

Parameters:

queueName - queue name

Returns:

normalized queue Name

Throws:

MXException

getMosNameForPubChannel

public java.lang.String getMosNameForPubChannel(java.lang.String channelName)
                                         throws MXException

Get object structure name for publish channel.

Parameters:

channelName - publish channel name

Returns:

object structure Name

Throws:

MXException

getLaunchURL

public java.lang.String getLaunchURL(java.lang.String launchEntryName,
                                     MboRemote mainMbo)
                              throws java.rmi.RemoteException,
                                     MXException

Get Object Structure name base on entity name of the interface table.

Parameters:

entityName - entity name

Returns:

Object Structure Name

Throws:

MXException

java.rmi.RemoteException

checkStatus

public boolean checkStatus(StructureData irData,
                           java.lang.String extSystem,
                           java.lang.String sendListName,
                           java.lang.String orgId,
                           java.lang.String siteId,
                           boolean sendUpdates)
                    throws MXException,
                           java.rmi.RemoteException

This method checks status and does the following. If the status changed to one of the status in XXSEND then send the transaction with children. WORKORDER is handled differently than other transactions also note that there is no STATUSIFACE tag for WORKORDER. For WORKORDER if the transaction is once sent then always sent all updates and status changes. All of the following apply to all other transactions(except WORKORDER): Don't send updates (which is not a status change). If the status changed to one of the status which is not in XXSEND and the transaction is not yet sent to any system, then skip the transaction. If the status changed to one of the status which is not in XXSEND and the transaction is sent to at least one external system, then send only the header record. Whenever the complete transaction is sent the STATUSIFACE flag is 0, irrespective of a status change.

Parameters:

irData - StructureData for IR.

extSystem - Name of the External System.

sendListName - Name of the XXSEND list.

orgId - orgId for the list control

siteId - siteId for the list control

sendUpdates - indicator to send updates

Returns:

Is Integration Object not skipped.

Throws:

MXException

java.rmi.RemoteException

getRowStampMap

public java.util.Map<java.lang.String,java.lang.Object> getRowStampMap()
                                                                throws java.rmi.RemoteException

Get row stamps.

Returns:

map

Throws:

java.rmi.RemoteException