psdi.iface.mic

Class MicUtil

java.lang.Object

psdi.iface.mic.MicUtil

public class MicUtil
extends java.lang.Object

Base class for all Integration Utilities

Version:

1.0

Author:

Boris Dozortsev

Field Summary

Fields

Modifier and Type	Field and Description
static MXLogger	INTEGRATIONLOGGER The Integration logger

Constructor Summary

Constructors

Constructor and Description
MicUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static 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.
static java.lang.String	dateToJmigString(java.util.Date in) Deprecated. please use ConversionUtil.dateToString.
static void	deleteFile(java.lang.String filepath) Delete file
static void	deleteFiles(java.util.List<java.lang.String> filesList, java.lang.String folder) Delete list of files directly residing under specified folder.
static java.lang.Object	deserialize(byte[] objData) De-serialize an object
static java.lang.String	formatMboColumn(MboRemote mbo, java.lang.String name) This will format column value to string
static java.lang.String[]	getAltKeyArray(java.lang.String indexName) Deprecated.
static java.lang.String[]	getAltKeyArray(java.lang.String indexName, java.sql.Connection con) Deprecated.
static java.lang.String[]	getAltKeyArray(java.lang.String indexName, java.lang.String entityName) Get Alternative Key for the Mbo
static java.lang.String	getAppExportDir(java.lang.String fileFormat) Get the name of the extract directory.
static java.lang.String	getBaseCurrency(java.lang.String key, UserInfo info, java.lang.String orgid) Return BaseCurrencyCode
static boolean	getBooleanProperty(java.lang.String propName, boolean dflt)
static java.lang.String	getConcatenatedValuesList(java.util.List<java.lang.String> list, char separationChar, int maxLength) Generate the string by concatenating the list elements by using supplied separating character.
static java.lang.String	getDefaultDirectory() Get default file directory for tenant
static java.lang.String	getEntityName(java.lang.String name) Return entity name for an object name
static java.lang.String	getExternalValueList(java.lang.String listName, java.lang.String maxValue) Deprecated. please use the ones which take site org id as parameters.
static java.lang.String	getExternalValueList(java.lang.String listName, java.lang.String maxValue, java.lang.String siteId, java.lang.String orgId) Get value for a MAXVALUE in value list
static java.lang.String	getExtractDir(java.lang.String extSysName, java.lang.String fileFormat) Get the name of the extract directory.
static java.lang.String	getFileName(java.util.Map msgProperties, java.lang.String fileType, boolean queueDir) Generate the file name and return it based on given message data and file type(error/retry/delete/deletedhistory) that is being requested
static java.lang.String	getFileName(java.lang.String extSystem, java.lang.String serviceName, java.lang.String messageId, java.lang.String queueName, java.lang.String fileType, boolean queueDir) Get the full path and file name based on given message data.
static java.lang.String	getFromEmail() Get From Email address for Integration
static int	getIntegerProperty(java.lang.String propName, int dflt)
static java.lang.String	getInternalValueList(java.lang.String listName, java.lang.String value) Get MAXVALUE for a value in value list
static java.lang.String	getItemType(MboRemote mbo, java.lang.String relation)
static java.lang.String[]	getKeyArray(MicSetInfo micInfo) Deprecated.
static java.lang.String[]	getKeyArray(java.lang.String name) Create array of keys from data dictionary
static java.util.Iterator<MboValueInfo>	getKeyMboValues(java.lang.String name)
static int	getMaximoType(java.lang.String objectName, java.lang.String attributeName) Get MAXIMO Type for the MAXIMO Attribute
static java.lang.String	getMaxVar(java.lang.String varname) Returns the value for the given maxvar.
static java.lang.String	getMaxVar(java.lang.String key, java.lang.String orgid, java.lang.String siteid) Return MaxVar value for the key using ORGID and SITEID
static java.lang.String	getMeaGlobalDir() Get the integration global directory.
static java.lang.String	getMeaGlobalDir(boolean getDefaultDir) Get the integration global directory.
static java.lang.String	getMEAProperty(java.lang.String propertyName) Get MEA Property.
static java.lang.String	getMeaTextDelimiter() Get the integration default Text Delimiter.
static java.lang.String	getMeaTextQualifier() Get the integration default Text Delimiter.
static java.lang.String	getProperty(java.lang.String propName) Get property value for a dynamic property [may or may not be existing] without the overhead of logging a miss
static java.sql.Connection	getRemoteConnection(java.lang.String driver, java.lang.String url, java.lang.String username, java.lang.String password) Get remote databse Connection
static java.lang.String	getToEmail() Get To Email address for Integration
static int	getType(int maxtype) Get Java Type for the MAXIMO Type
static java.lang.String	getUserNo(MboSetRemote mboSet) Returns Local value for NO.
static java.lang.String	getUserYes(MboSetRemote mboSet) Returns Local value for YES.
static java.lang.String	getYORNValue(int val, MboSetRemote mboSet) Returns Local value YES/NO.
static boolean	isResponseRequired(java.lang.String messageType) Get Response Required to return response for the all operation
static java.util.Date	jmigStringToDateTime(java.lang.String in) Deprecated. please use ConversionUtil.stringToDate.
static boolean	parseCondition(java.lang.String str, MboRemote mbo) This will validate a condition
static void	prepareEntSrvMsgTrkInfo(java.util.Map<java.lang.String,java.lang.String> properties, byte[] data) Utility method for Message Tracking - Prepares message properties hash map with necessary info
static byte[]	serializeData(java.io.Serializable obj) Serialize an object
static void	updateSendersysid(java.lang.String tableName, java.lang.String where, java.sql.Connection con) Update Sendersysid for the table
static void	validateOrgSite(StructureData struc, MboSetRemote mboSet, java.lang.String orgName, java.lang.String siteName, java.lang.String itemSetName, java.lang.String companySetName) Validate ORG and SITE for the inbound transaction.
static void	validateOrgSite(StructureObject struc, MboSetRemote mboSet, java.lang.String orgName, java.lang.String siteName, java.lang.String itemSetName, java.lang.String companySetName) Validate ORG and SITE for the inbound transaction.

Methods inherited from class java.lang.Object

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

Field Detail

INTEGRATIONLOGGER

public static final MXLogger INTEGRATIONLOGGER

The Integration logger

Constructor Detail

MicUtil

public MicUtil()

Method Detail

getItemType

public static java.lang.String getItemType(MboRemote mbo,
                           java.lang.String relation)
                                    throws MXException,
                                           java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

getProperty

public static java.lang.String getProperty(java.lang.String propName)

Get property value for a dynamic property [may or may not be existing] without the overhead of logging a miss

Parameters:

propName - the name of the Maximo property

Returns:

the property value

getBooleanProperty

public static boolean getBooleanProperty(java.lang.String propName,
                         boolean dflt)
                                  throws MXApplicationException

Throws:

MXApplicationException

getIntegerProperty

public static int getIntegerProperty(java.lang.String propName,
                     int dflt)
                              throws MXApplicationException

Throws:

MXApplicationException

getAltKeyArray

public static java.lang.String[] getAltKeyArray(java.lang.String indexName,
                                java.sql.Connection con)
                                         throws MXException,
                                                java.rmi.RemoteException

Deprecated.

Get Alternative Key for the Mbo. This method is replaced by getAltKeyArray(String indexName) in MicUtil.

Parameters:

indexName - Name of the index which have alternative key columns

con - Database connection

Returns:

Array of Keys to mbo

Throws:

MXException - MAXIMO exception

java.rmi.RemoteException - Remote exception

See Also:

getAltKeyArray(String indexName)

getAltKeyArray

public static java.lang.String[] getAltKeyArray(java.lang.String indexName)
                                         throws MXException,
                                                java.rmi.RemoteException

Deprecated.

Get Alternative Key for the Mbo. This method is replaced by getAltKeyArray(String indexName) in MicUtil.

Parameters:

indexName - Name of the index which have alternative key columns

conn - Database connection

Returns:

Array of Keys to mbo

Throws:

MXException - MAXIMO exception

java.rmi.RemoteException - Remote exception

See Also:

getAltKeyArray(String indexName)

updateSendersysid

public static void updateSendersysid(java.lang.String tableName,
                     java.lang.String where,
                     java.sql.Connection con)
                              throws MXException,
                                     java.rmi.RemoteException

Update Sendersysid for the table

Parameters:

tableName - Name of MAXIMO table

where - Where clause

con - Database connection

Throws:

MXException - MAXIMO exception

java.rmi.RemoteException - Remote exception

getFromEmail

public static java.lang.String getFromEmail()

Get From Email address for Integration

Returns:

From Email address

getToEmail

public static java.lang.String getToEmail()

Get To Email address for Integration

Returns:

To Email address

getKeyArray

public static java.lang.String[] getKeyArray(MicSetInfo micInfo)
                                      throws MXException,
                                             java.rmi.RemoteException

Deprecated.

Create array of keys from data dictionary

Parameters:

micInfo - Information of the Integration Object

Returns:

Array of Keys to Mbo

Throws:

MXException - MAXIMO exception

java.rmi.RemoteException - Remote exception

getKeyArray

public static java.lang.String[] getKeyArray(java.lang.String name)
                                      throws MXException,
                                             java.rmi.RemoteException

Create array of keys from data dictionary

Parameters:

name - Object name

Returns:

Array of Keys to Mbo

Throws:

MXException - MAXIMO exception

java.rmi.RemoteException - Remote exception

getKeyMboValues

public static java.util.Iterator<MboValueInfo> getKeyMboValues(java.lang.String name)
                                                        throws MXException

Throws:

MXException

getEntityName

public static java.lang.String getEntityName(java.lang.String name)
                                      throws MXException,
                                             java.rmi.RemoteException

Return entity name for an object name

Parameters:

name - Object name

Returns:

Entity name

Throws:

MXException - MAXIMO exception

java.rmi.RemoteException - Remote exception

validateOrgSite

public static void validateOrgSite(StructureData struc,
                   MboSetRemote mboSet,
                   java.lang.String orgName,
                   java.lang.String siteName,
                   java.lang.String itemSetName,
                   java.lang.String companySetName)
                            throws MXException,
                                   java.rmi.RemoteException

Validate ORG and SITE for the inbound transaction.

Parameters:

struc - StructureData Object

mboSet - MboSet to set org or sit id parameters

orgName - Name of field which has Organization Id

siteName - Name of field which has Site Id

itemSetName - Name of field which has Item Set Id

companySetName - Name of field which has Company Set Id

Throws:

MXException - MAXIMO exception

java.rmi.RemoteException - Remote exception

validateOrgSite

public static void validateOrgSite(StructureObject struc,
                   MboSetRemote mboSet,
                   java.lang.String orgName,
                   java.lang.String siteName,
                   java.lang.String itemSetName,
                   java.lang.String companySetName)
                            throws MXException,
                                   java.rmi.RemoteException

Validate ORG and SITE for the inbound transaction.

Parameters:

struc - StructureData Object

mboSet - MboSet to set org or sit id parameters

orgName - Name of field which has Organization Id

siteName - Name of field which has Site Id

itemSetName - Name of field which has Item Set Id

companySetName - Name of field which has Company Set Id

Throws:

MXException - MAXIMO exception

java.rmi.RemoteException - Remote exception

dateToJmigString

public static java.lang.String dateToJmigString(java.util.Date in)

Deprecated. please use ConversionUtil.dateToString.

This method will convert java.util.Date to ISO 8601 dateTime format string

Parameters:

in - Give date in java.util.Date format

Returns:

dateTime String

jmigStringToDateTime

public static java.util.Date jmigStringToDateTime(java.lang.String in)
                                           throws MXException

Deprecated. please use ConversionUtil.stringToDate.

This method will convert String in format acceptable by JMIG to java.util.Date

Parameters:

in - Give date in String format

Returns:

String representation of field

Throws:

MXException

deleteFile

public static void deleteFile(java.lang.String filepath)
                       throws MXException

Delete file

Parameters:

filepath - Give path of the file.

Throws:

MXException - MAXIMO exception

getBaseCurrency

public static java.lang.String getBaseCurrency(java.lang.String key,
                               UserInfo info,
                               java.lang.String orgid)
                                        throws MXException,
                                               java.rmi.RemoteException

Return BaseCurrencyCode

Parameters:

key - BaseCurrency or BaseCurrency2

info - UserInfo Object

orgid - Organization Id

Returns:

Base Currency Code

Throws:

MXException - MAXIMO exception

java.rmi.RemoteException - Remote exception

parseCondition

public static boolean parseCondition(java.lang.String str,
                     MboRemote mbo)
                              throws MXException,
                                     java.rmi.RemoteException

This will validate a condition

Parameters:

str - Condition to evaluate

mbo - Mbo to apply condition

Returns:

true or false for the parsing being successful or not

Throws:

MXException - MAXIMO exception

java.rmi.RemoteException - Remote exception

getMaxVar

public static java.lang.String getMaxVar(java.lang.String key,
                         java.lang.String orgid,
                         java.lang.String siteid)
                                  throws MXException,
                                         java.rmi.RemoteException

Return MaxVar value for the key using ORGID and SITEID

Parameters:

key - MaxVar Name

orgid - Organization Id

siteid - Site Id

Returns:

MaxVar value

Throws:

MXException - MAXIMO exception

java.rmi.RemoteException - Remote exception

getRemoteConnection

public static java.sql.Connection getRemoteConnection(java.lang.String driver,
                                      java.lang.String url,
                                      java.lang.String username,
                                      java.lang.String password)
                                               throws MXException

Get remote databse Connection

Parameters:

driver - Database Driver Name

url - URL Name

username - User Name

password - Password

Returns:

Database Connection

Throws:

MXException - MAXIMO exception

getType

public static int getType(int maxtype)

Get Java Type for the MAXIMO Type

Parameters:

maxtype - MAXIMO Data Type

Returns:

Java Data Type

getMaximoType

public static int getMaximoType(java.lang.String objectName,
                java.lang.String attributeName)
                         throws MXException,
                                java.rmi.RemoteException

Get MAXIMO Type for the MAXIMO Attribute

Parameters:

objectName - Object Name

attributeName - Attribute Name

Throws:

MXException - MAXIMO exception

java.rmi.RemoteException - Remote exception

serializeData

public static byte[] serializeData(java.io.Serializable obj)

Serialize an object

Parameters:

obj - Serializable Object

Returns:

Data in Byte Array Format

Throws:

MXException - MAXIMO exception

java.rmi.RemoteException - Remote exception

deserialize

public static java.lang.Object deserialize(byte[] objData)

De-serialize an object

Parameters:

objData - Data in Byte Array format

Returns:

De-serialized object

Throws:

MXException - MAXIMO exception

java.rmi.RemoteException - Remote exception

getMEAProperty

public static java.lang.String getMEAProperty(java.lang.String propertyName)

Get MEA Property.

Parameters:

propertyName - Name of the property

Returns:

Value for the MEA Property

getYORNValue

public static java.lang.String getYORNValue(int val,
                            MboSetRemote mboSet)
                                     throws MXException,
                                            java.rmi.RemoteException

Returns Local value YES/NO.

Parameters:

val - Yes or No value

mboSet - MboSet reference

Returns:

the Local value for YES/NO

Throws:

MXException - - MAXIMO exception

java.rmi.RemoteException - - Remote exception

getUserYes

public static java.lang.String getUserYes(MboSetRemote mboSet)
                                   throws MXException,
                                          java.rmi.RemoteException

Returns Local value for YES.

Parameters:

mboSet - MboSet reference

Returns:

the Local value for YES

Throws:

MXException - - MAXIMO exception

java.rmi.RemoteException - - Remote exception

getUserNo

public static java.lang.String getUserNo(MboSetRemote mboSet)
                                  throws MXException,
                                         java.rmi.RemoteException

Returns Local value for NO.

Parameters:

mboSet - MboSet reference

Returns:

the Local value for NO

Throws:

MXException - - MAXIMO exception

java.rmi.RemoteException - - Remote exception

getMaxVar

public static java.lang.String getMaxVar(java.lang.String varname)
                                  throws MXException,
                                         java.rmi.RemoteException

Returns the value for the given maxvar.

Parameters:

varname - the maxvar name

Returns:

the maxvar value

Throws:

MXException - - MAXIMO exception

java.rmi.RemoteException - - Remote exception

getMeaGlobalDir

public static java.lang.String getMeaGlobalDir()
                                        throws MXException

Get the integration global directory. if property mxe.int.globaldir is null, returns user dir if property mxe.int.globaldir is not an existing directory, returns user dir Otherwise returns property mxe.int.globaldir value.

Returns:

integration global directory

Throws:

MXException

getMeaGlobalDir

public static java.lang.String getMeaGlobalDir(boolean getDefaultDir)
                                        throws MXException

Get the integration global directory. if property mxe.int.globaldir is null, returns user dir if property mxe.int.globaldir is not an existing directory, returns user dir Otherwise returns property mxe.int.globaldir value.

Returns:

integration global directory

Throws:

MXException

getExternalValueList

public static java.lang.String getExternalValueList(java.lang.String listName,
                                    java.lang.String maxValue)
                                             throws MXException,
                                                    java.rmi.RemoteException

Deprecated. please use the ones which take site org id as parameters.

Get value for a MAXVALUE in value list

Parameters:

maxValue - - value to search for

Returns:

String value found

Throws:

MXException - - MAXIMO exception

java.rmi.RemoteException - - Remote exception

getExternalValueList

public static java.lang.String getExternalValueList(java.lang.String listName,
                                    java.lang.String maxValue,
                                    java.lang.String siteId,
                                    java.lang.String orgId)
                                             throws MXException,
                                                    java.rmi.RemoteException

Get value for a MAXVALUE in value list

Parameters:

listName - - list to search

maxValue - - value to search for

Returns:

String value found

Throws:

MXException - - MAXIMO exception

java.rmi.RemoteException - - Remote exception

getInternalValueList

public static java.lang.String getInternalValueList(java.lang.String listName,
                                    java.lang.String value)
                                             throws MXException,
                                                    java.rmi.RemoteException

Get MAXVALUE for a value in value list

Parameters:

listName - - list to search

value - - value to search for

Returns:

String value found

Throws:

MXException - - MAXIMO exception

java.rmi.RemoteException - - Remote exception

formatMboColumn

public static java.lang.String formatMboColumn(MboRemote mbo,
                               java.lang.String name)
                                        throws MXException,
                                               java.rmi.RemoteException

This will format column value to string

Parameters:

mbo - Mbo reference

name - Column name

Throws:

MXException - MAXIMO exception

java.rmi.RemoteException - Remote exception

getFileName

public static java.lang.String getFileName(java.util.Map msgProperties,
                           java.lang.String fileType,
                           boolean queueDir)

Generate the file name and return it based on given message data and file type(error/retry/delete/deletedhistory) that is being requested

Parameters:

msgProperties - Message properties having information about the message

fileType - Full path including fileType (example - error/retry/delete/deletedhistory))

queueDir - Returned filename will be under queuename/sender sub folder if this parameter is true

Returns:

Full path and file name of message file.

getFileName

public static java.lang.String getFileName(java.lang.String extSystem,
                           java.lang.String serviceName,
                           java.lang.String messageId,
                           java.lang.String queueName,
                           java.lang.String fileType,
                           boolean queueDir)

Get the full path and file name based on given message data.

Parameters:

extSystem - External System

serviceName - Service Name

messageId - Message ID

queueName - Queue Name

fileType - Full path including fileType (example - error/retry/delete/deletedhistory))

queueDir - true to include queueName/extSystem in path

Returns:

Full path and file name of message file.

getConcatenatedValuesList

public static java.lang.String getConcatenatedValuesList(java.util.List<java.lang.String> list,
                                         char separationChar,
                                         int maxLength)

Generate the string by concatenating the list elements by using supplied separating character. e.g. comma separated list that is needed in Transaction Tracking App. file type(error/retry/delete/deletedhistory) that is being requested. Returned concatenated string will be trimmed to the length parameter.

Parameters:

list - List of elements to be concatenated together

separationChar - Separator to used while doing concatenation

maxLength - Concatenation is limited to this length

prepareEntSrvMsgTrkInfo

public static void prepareEntSrvMsgTrkInfo(java.util.Map<java.lang.String,java.lang.String> properties,
                           byte[] data)
                                    throws MXException

Utility method for Message Tracking - Prepares message properties hash map with necessary info

Parameters:

properties - Properties (Hash map) to be updated with new message tracking related properties

data - Data in byte array form

Throws:

MXException

checkStatus

public static 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

getMeaTextDelimiter

public static java.lang.String getMeaTextDelimiter()

Get the integration default Text Delimiter. if property mxe.int.flatfiledelimiter is null, returns comma ','.

Returns:

integration default Text Delimiter

getMeaTextQualifier

public static java.lang.String getMeaTextQualifier()

Get the integration default Text Delimiter. if property mxe.int.textqualifier is null, returns double quote This property is mainly added for flat file processing and currently used by File Extract functionality

Returns:

integration default Text Delimiter

getExtractDir

public static java.lang.String getExtractDir(java.lang.String extSysName,
                             java.lang.String fileFormat)
                                      throws MXException

Get the name of the extract directory. If the directory does not exist the this method will try to create the directory.

Parameters:

extSysName - External System Name

fileFormat - File format.

Returns:

Extract Directory

Throws:

MXException

getAppExportDir

public static java.lang.String getAppExportDir(java.lang.String fileFormat)
                                        throws MXException

Get the name of the extract directory. If the directory does not exist the this method will try to create the directory.

Parameters:

fileFormat - File format.

Returns:

Extract Directory

Throws:

MXException

deleteFiles

public static void deleteFiles(java.util.List<java.lang.String> filesList,
               java.lang.String folder)

Delete list of files directly residing under specified folder. Currently, this method is called from File Extract functionality

Parameters:

filesList - List of files to be deleted which reside directly under specified folder

folder - Folder name under which the files to be deleted exist

getAltKeyArray

public static java.lang.String[] getAltKeyArray(java.lang.String indexName,
                                java.lang.String entityName)
                                         throws MXException,
                                                java.rmi.RemoteException

Get Alternative Key for the Mbo

Parameters:

indexName - Name of the index which have alternateive key columns

Returns:

Array of Keys to mbo

Throws:

MXException - MAXIMO exception

java.rmi.RemoteException - Remote exception

isResponseRequired

public static boolean isResponseRequired(java.lang.String messageType)
                                  throws MXException,
                                         java.rmi.RemoteException

Get Response Required to return response for the all operation

Parameters:

messageType - get operation

Throws:

MXException

java.rmi.RemoteException

getDefaultDirectory

public static java.lang.String getDefaultDirectory()
                                            throws MXException

Get default file directory for tenant

Returns:

default directory

Throws:

java.rmi.RemoteException - Remote exception

MXException