psdi.iface.mos

Class MosProcessImpl

java.lang.Object

psdi.iface.mos.MosProcess

psdi.iface.mos.MosProcessImpl

All Implemented Interfaces:

MicConstants, MosConstants

Direct Known Subclasses:

MicSetIn

public class MosProcessImpl
extends MosProcess
implements MicConstants

Base class for all inbound transactions to maximo

Version:

1.0

Author:

Boris Dozortsev

Field Summary

Fields inherited from class psdi.iface.mos.MosProcess

INTEGRATIONLOGGER

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.iface.mos.MosConstants

ACTION, ACTIONADD, ACTIONADDUPDATE, ACTIONDELETE, ACTIONREPLACE, ACTIONUPDATE, ADAPTER_INSTALL, ADD, ADDATEND, BASELANGUAGE, BYPASS, COMPANYSETID_NAME, COMPLETE, CONFIGFILENAME, CREATIONDATETIME, DELETEFORINSERT, DEPLOYMENT_MANAGER, ENTERPRISE_SERVICE, ERRORTAG, ESCAPECHAR, EVENT, FILTERMBOKEY, INVOKE_CHANNEL, ITEMSETID_NAME, MAXIMO_NS_PREFIX, MAXIMOVERSION, MESSAGEID, MESSAGETYPE_CREATE, MESSAGETYPE_DELETE, MESSAGETYPE_INITIATE, MESSAGETYPE_INVOKE, MESSAGETYPE_MERGE, MESSAGETYPE_PATCH, MESSAGETYPE_PROCESS, MESSAGETYPE_PUBLISH, MESSAGETYPE_QUERY, MESSAGETYPE_RESPONSE, MESSAGETYPE_SYNC, MESSAGETYPE_UPDATE, MESSAGETYPE_WAKEUP, OBJECT_STRUCTURE_SERVICE, ORGID_NAME, OVERRIDEALWAYS, OVERRIDENULLONLY, PROCESS, SITEID_NAME, SKIP, SKIPMBO, SKIPMBOKEY, STANDARD_SERVICE, TRANSLANGUAGE, UPDATE, XSI_NS, XSI_NS_PREFIX

Constructor Summary

Constructors

Constructor and Description
MosProcessImpl() Construct the set

Method Summary

Modifier and Type	Method and Description
MboRemote	addMbo(MboSetRemote mboSet) Default method to call back and add Mbo's in MboSet
void	afterProcess() Called after processing while XML (can be called to change status in the hierarchy)
void	afterReplace(MboRemote child) Called for action Replace or null scenario after processing while XML to delete data which did not come in XML
void	checkAdditionalRules() Default method to call at the end of processing can be used to set data for the whole object.
int	checkBusinessRules() Default method to call back and find out can we process data.
int	checkBusinessRules(MboSetRemote mboSet, java.lang.String tableName) Default method to call back and find out can we process data.
void	checkDocumnetMaxSize(byte[] document) Checks size of the attachment against system property "mxe.int.doclink.maxfilesize"
boolean	checkForUpdate() Default method to call and change for status update.
void	checkValidateErrors() Default method to check all validation errors
void	cleanup() Default method to call at the end of processing to cleanup all private variable create during the process of the noun.
boolean	compareMboKeyValues(MboSetRemote mboSet, MicSetInfo micInfo, java.lang.String[] keys) Deprecated. please use method with MosDetailInfo
boolean	compareMboKeyValues(MboSetRemote mboSet, MosDetailInfo mdi, java.lang.String[] keys) Default method to try to find in memory MBO with the keys matched with XML data for the current level
void	copyParentKey(java.lang.String attributeName, java.lang.String value) Copy parent key to a child if value does not exists in the child
MboSetRemote	createMboSet(boolean isPrimaryMbo, MboRemote parentMbo, MicSetInfo micInfo, java.lang.String processTable) Deprecated. please use method with MosDetailInfo
MboSetRemote	createMboSet(boolean isPrimaryMbo, MboRemote parentMbo, MosDetailInfo mdi, java.lang.String processTable) Create Mbo set sets for all levels in XML for incoming transactions
void	delete(MboRemote mbo, MosDetailInfo mdi) Update row in MAXIMO table for the main table
void	deleteAll(MboRemote owner, MboSetRemote mboSet) Default method to call back delete all Mbo's in MboSet
MboRemote	findTargetMbo(MosDetailInfo mdi) Find target Mbo in MboSet for Invacation Channel.
long	getAccessModifier() Return Access modifier.
java.lang.String	getAttachmentFileName(java.lang.String directory, java.lang.String fileName) Create unique file name for attachment.
java.lang.String	getCompanySet() Default method to get name of the field which has value for company set.
java.lang.String	getItemSet() Default method to get name of the field which has value for item set.
java.lang.String	getLanguage() This method will return Language of the transaction
java.lang.String	getOrg() Default method to get name of the field which has value for organization
java.lang.String	getSite() Default method to get name of the field which has value for site
boolean	isBranchFilterOn()
boolean	isEsigVerified()
int	presetMboRules() Default method to call back and find out do we need to set data.
byte[]	processExternalData(StructureData data, java.lang.String mosName, UserInfo info, MXTransaction trans) Process data coming from external systems using Enterprise Service definition.
MboSetRemote	processMboSet(boolean isPrimaryMbo, MboRemote parentMbo, MosDetailInfo mdi, java.lang.String processTable) Create Mbo set sets for all levels in XML for incoming transactions If MboSet already exit (Invocation Channel) use it.
byte[]	processObjectStructureService(StructureData data, java.lang.String mosName, java.lang.String msgType, UserInfo info, MXTransaction trans) Process Object Structure Service XML.
MboSetRemote	resetMboSet(MboSetRemote childMboSet) Default method to be overridden by the individual modules to reset MboSet to be processed.
void	save() Default method to call back and save transaction
void	setAccessModifier(long amd) Sets Access modifier.
void	setAdditionalData(MboSetRemote MboSet, java.lang.String tableName) Default method to set all addition data from XML to MBO which was not set thru Integration DD
void	setAttachments() Set fields for attachment processing.
void	setAutokeyFlag(MboSetRemote set, MosDetailInfo info) Default method to be overridden by the individual modules to set autokey flag.
void	setEsigVerified()
void	setSkipSetFields(java.lang.String field) Sets Access modifier.
void	setValidOrgSite(boolean v) Method to set a swith after org and site is validated.
void	verifyEsig()
void	writeAttachments() Called after processing to write all attachments to the file

Methods inherited from class psdi.iface.mos.MosProcess

getDBName, getInterDD, getJsonRequest, getKeyArray, getKeyArray, getMosName, getPrimaryMbo, getTransaction, getTransactionAction, getUserInfo, hasInvokedScript, hasScript, isMaxVarEQ, isValueEQ, setJsonRequest, setMosName, setOSName, setOSPrimaryMbo, setUserInfo

Methods inherited from class java.lang.Object

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

Constructor Detail

MosProcessImpl

public MosProcessImpl()
               throws MXException,
                      java.rmi.RemoteException

Construct the set

Throws:

MXException - MAXIMO exception

java.rmi.RemoteException - Remote exception

Method Detail

processObjectStructureService

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

Process Object Structure Service XML.

Parameters:

data - Give reference to StructureData class with data from external system.

mosName - Give object structure name.

msgType - Give operation.

info - Give User Info reference.

trans - Give reference to MAXIMO Transaction object.

Throws:

MXException - MAXIMO exception

java.rmi.RemoteException - Remote exception

processExternalData

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

Process data coming from external systems using Enterprise Service definition.

Parameters:

data - Give reference to StructureData class with data from external system.

mosName - Give object structure name.

info - Give User Info reference.

trans - Give reference to MAXIMO Transaction object.

Throws:

MXException - MAXIMO exception

java.rmi.RemoteException - Remote exception

processMboSet

public MboSetRemote processMboSet(boolean isPrimaryMbo,
                                  MboRemote parentMbo,
                                  MosDetailInfo mdi,
                                  java.lang.String processTable)
                           throws MXException,
                                  java.rmi.RemoteException

Create Mbo set sets for all levels in XML for incoming transactions If MboSet already exit (Invocation Channel) use it.

Parameters:

isPrimaryMbo - Give indicator for Main vs. additional tables

parentMbo - Give reference to parent Mbo.

mdi - Give MosDetailInfo for the current level.

processTable - Give name of table to process

Throws:

MXException - MAXIMO exception

java.rmi.RemoteException - Remote exception

createMboSet

public MboSetRemote createMboSet(boolean isPrimaryMbo,
                                 MboRemote parentMbo,
                                 MicSetInfo micInfo,
                                 java.lang.String processTable)
                          throws MXException,
                                 java.rmi.RemoteException

Deprecated. please use method with MosDetailInfo

Create mbo set sets for all levels in XML for incomig transactions

Parameters:

isPrimaryMbo - Give boolean to specify is it primary table or additional table

parentMbo - Give reference to parent Mbo.

micInfo - Give MicSetInfo for the current level.

processTable - Give name of table to process

Throws:

MXException - MAXIMO exception

java.rmi.RemoteException - Remote exception

copyParentKey

public void copyParentKey(java.lang.String attributeName,
                          java.lang.String value)
                   throws MXException,
                          java.rmi.RemoteException

Copy parent key to a child if value does not exists in the child

Parameters:

attributeName - attribute name in child

val - value from parent mbo to set

Throws:

MXException - MAXIMO exception

java.rmi.RemoteException - Remote exception

createMboSet

public MboSetRemote createMboSet(boolean isPrimaryMbo,
                                 MboRemote parentMbo,
                                 MosDetailInfo mdi,
                                 java.lang.String processTable)
                          throws MXException,
                                 java.rmi.RemoteException

Create Mbo set sets for all levels in XML for incoming transactions

Parameters:

isPrimaryMbo - Give boolean to specify is it primary table or additional table

parentMbo - Give reference to parent Mbo.

mdi - Give MicSetInfo for the current level.

processTable - Give name of table to process

Throws:

MXException - MAXIMO exception

java.rmi.RemoteException - Remote exception

delete

public void delete(MboRemote mbo,
                   MosDetailInfo mdi)
            throws MXException,
                   java.rmi.RemoteException

Update row in MAXIMO table for the main table

Parameters:

mbo - Give Mbo for the current level.

mdi - Give MosDetailInfo for the current level.

Throws:

MXException - MAXIMO exception

java.rmi.RemoteException - Remote exception

checkValidateErrors

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

Default method to check all validation errors

Throws:

MXException - MAXIMO exception

java.rmi.RemoteException - Remote exception

isEsigVerified

public boolean isEsigVerified()

setEsigVerified

public void setEsigVerified()

verifyEsig

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

Throws:

java.rmi.RemoteException

MXException

compareMboKeyValues

public boolean compareMboKeyValues(MboSetRemote mboSet,
                                   MicSetInfo micInfo,
                                   java.lang.String[] keys)
                            throws MXException,
                                   java.rmi.RemoteException

Deprecated. please use method with MosDetailInfo

Default method to try to find in memory MBO with the keys matched with XML data for the current level

Parameters:

mboSet - Give reverence to current MboSet

micInfo - The integration object info

keys - Keys of the object

Returns:

Boolean indicating that compare was successful or not

Throws:

MXException - MAXIMO exception

java.rmi.RemoteException - Remote exception

compareMboKeyValues

public boolean compareMboKeyValues(MboSetRemote mboSet,
                                   MosDetailInfo mdi,
                                   java.lang.String[] keys)
                            throws MXException,
                                   java.rmi.RemoteException

Default method to try to find in memory MBO with the keys matched with XML data for the current level

Parameters:

mboSet - Give reverence to current MboSet

mdi - Give MosDetailInfo for the current level.

keys - Keys of the object

Returns:

Boolean indicating that compare was successful or not

Throws:

MXException - MAXIMO exception

java.rmi.RemoteException - Remote exception

deleteAll

public void deleteAll(MboRemote owner,
                      MboSetRemote mboSet)
               throws MXException,
                      java.rmi.RemoteException

Default method to call back delete all Mbo's in MboSet

Parameters:

owner - Give reference to parent Mbo.

mboSet - Give MboSet for the current level.

Throws:

MXException - MAXIMO exception

java.rmi.RemoteException - Remote exception

addMbo

public MboRemote addMbo(MboSetRemote mboSet)
                 throws MXException,
                        java.rmi.RemoteException

Default method to call back and add Mbo's in MboSet

Parameters:

mboSet - Give MboSet for the current level.

Throws:

MXException - MAXIMO exception

java.rmi.RemoteException - Remote exception

save

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

Default method to call back and save transaction

Throws:

MXException - MAXIMO exception

java.rmi.RemoteException - Remote exception

checkAdditionalRules

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

Default method to call at the end of processing can be used to set data for the whole object.

Throws:

MXException - MAXIMO exception

java.rmi.RemoteException - Remote exception

cleanup

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

Default method to call at the end of processing to cleanup all private variable create during the process of the noun.

Throws:

MXException - MAXIMO exception

java.rmi.RemoteException - Remote exception

checkForUpdate

public boolean checkForUpdate()
                       throws MXException,
                              java.rmi.RemoteException

Default method to call and change for status update.

Returns:

false

Throws:

MXException - MAXIMO exception

java.rmi.RemoteException - Remote exception

resetMboSet

public MboSetRemote resetMboSet(MboSetRemote childMboSet)
                         throws MXException,
                                java.rmi.RemoteException

Default method to be overridden by the individual modules to reset MboSet to be processed. By default will return MboSet which was passed in.

Parameters:

childMboSet - Give reverence to current MboSet

Returns:

MboSet created by individual modules

Throws:

MXException - MAXIMO exception

java.rmi.RemoteException - Remote exception

getLanguage

public java.lang.String getLanguage()
                             throws MXException

This method will return Language of the transaction

Returns:

Language code

Throws:

MXException

checkBusinessRules

public int checkBusinessRules()
                       throws MXException,
                              java.rmi.RemoteException

Default method to call back and find out can we process data. This method will return always PROCESS and can be overridden in MicSet

Returns:

PROCESS (means continue to process)

Throws:

MXException - MAXIMO exception

java.rmi.RemoteException - Remote exception

presetMboRules

public int presetMboRules()
                   throws MXException,
                          java.rmi.RemoteException

Default method to call back and find out do we need to set data. This method will return always PROCESS and can be overridden in MicSet

Returns:

PROCESS (means continue to process)

Throws:

MXException - MAXIMO exception

java.rmi.RemoteException - Remote exception

checkBusinessRules

public int checkBusinessRules(MboSetRemote mboSet,
                              java.lang.String tableName)
                       throws MXException,
                              java.rmi.RemoteException

Default method to call back and find out can we process data.

Parameters:

mboSet - Give MboSet for the current level.

tableName - Give of the table to process.

Returns:

PROCESS (means continue to process)

Throws:

MXException - MAXIMO exception

java.rmi.RemoteException - Remote exception

setAdditionalData

public void setAdditionalData(MboSetRemote MboSet,
                              java.lang.String tableName)
                       throws MXException,
                              java.rmi.RemoteException

Default method to set all addition data from XML to MBO which was not set thru Integration DD

Parameters:

MboSet - Give MboSet for the current level.

tableName - Give name of process MAXIMO table

Throws:

MXException - MAXIMO exception

java.rmi.RemoteException - Remote exception

setAttachments

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

Set fields for attachment processing. Save DOCUMRENTDATA in the Map to be written to the file at the end of the processing

Throws:

MXException - Maximo Exception

java.rmi.RemoteException - Remote Exception

checkDocumnetMaxSize

public void checkDocumnetMaxSize(byte[] document)
                          throws MXException,
                                 java.rmi.RemoteException

Checks size of the attachment against system property "mxe.int.doclink.maxfilesize"

Parameters:

document - Attachment byte array.

Throws:

MXException - MAXIMO exception

java.rmi.RemoteException - Remote exception

getAttachmentFileName

public java.lang.String getAttachmentFileName(java.lang.String directory,
                                              java.lang.String fileName)
                                       throws MXException,
                                              java.rmi.RemoteException

Create unique file name for attachment. Use original file name and add unuque identifier

Parameters:

directory - Give attachment directory name.

fileName - Give original file name

Throws:

MXException - MAXIMO exception

java.rmi.RemoteException - Remote exception

setAutokeyFlag

public void setAutokeyFlag(MboSetRemote set,
                           MosDetailInfo info)
                    throws MXException,
                           java.rmi.RemoteException

Default method to be overridden by the individual modules to set autokey flag. This method will determine if one of the keys have autokey associated with it and if value is provided for this field in XML it will set autokey flag to false. In this case autokey will not be generated for this record

Throws:

MXException - MAXIMO exception

java.rmi.RemoteException - Remote exception

getOrg

public java.lang.String getOrg()

Default method to get name of the field which has value for organization

Returns:

Column name with value for the Organization

getSite

public java.lang.String getSite()

Default method to get name of the field which has value for site

Returns:

Column name with value for the Site

getItemSet

public java.lang.String getItemSet()

Default method to get name of the field which has value for item set.

Returns:

Column name with value for the Item Set

getCompanySet

public java.lang.String getCompanySet()

Default method to get name of the field which has value for company set.

Returns:

Column name with value for the Organization

getAccessModifier

public long getAccessModifier()

Return Access modifier.

Returns:

Access modifier

setAccessModifier

public void setAccessModifier(long amd)

Sets Access modifier.

Parameters:

amd - Give Access modifier.

setSkipSetFields

public void setSkipSetFields(java.lang.String field)

Sets Access modifier.

Parameters:

amd - Give Access modifier.

setValidOrgSite

public void setValidOrgSite(boolean v)

Method to set a swith after org and site is validated.

Parameters:

v - Give validate org and site swith.

findTargetMbo

public MboRemote findTargetMbo(MosDetailInfo mdi)
                        throws MXException,
                               java.rmi.RemoteException

Find target Mbo in MboSet for Invacation Channel.

Parameters:

mdi - Give MosDetailInfo reference

Returns:

Mbo

Throws:

MXException

java.rmi.RemoteException

afterProcess

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

Called after processing while XML (can be called to change status in the hierarchy)

Throws:

MXException - MAXIMO exception

java.rmi.RemoteException - Remote exception

writeAttachments

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

Called after processing to write all attachments to the file

Throws:

MXException - MAXIMO exception

java.rmi.RemoteException - Remote exception

afterReplace

public void afterReplace(MboRemote child)
                  throws MXException,
                         java.rmi.RemoteException

Called for action Replace or null scenario after processing while XML to delete data which did not come in XML

Parameters:

child - Give Mbo for the current level.

Throws:

MXException - MAXIMO exception

java.rmi.RemoteException - Remote exception

isBranchFilterOn

public boolean isBranchFilterOn()