SMAT message resend related web services
Through these web services interfaces, the outside applications can retrieve the message ID list based on the search conditions. The applications can then dump the message content and metadata that are based on the message ID to view and decide whether to change them for resend.
String[] SMAT_getIndexFileList(String siteName, String
processName)
This retrieves the index file name list from the specified process under the specified site. The outside application accesses this interface to retrieve the index file name list and decides to query the message IDs from which index file.
-
siteName
is the name of the site. processName
is the name of the process.- This returns a string array that contains the index file name list.
String[]getSMATIndexFileListExt (HashMapWrapper
paramsMap)
This retrieves the index file name list from the specified process under the specified site. The outside application accesses this interface to retrieve the index file name list and decides to query the message IDs from which index file.
-
paramsMap
is a map that contains the site name and process name. Their keys aresiteName
andprocessName.
- This returns a string array that contains the index file name list.
String[] SMAT_getCyclingIndexFileList(String siteName, String
processName)
This retrieves the cycling index file name list from the SmatHistory folder of the specified process under the specified site. The outside application accesses this interface to retrieve the cycling index file name list and decides to query the message ID from which index file.
-
siteName
is the name of the site. -
processName
is the name of the process. -
This returns a string array containing the cycling index file name.
String[] getSMATCyclingIndexFileListExt (HashMapWrapper
paramsMap)
This retrieves the cycling index file name list from the specified process under the specified site. The outside application accesses this interface to retrieve the cycling index file name list and decides to query the message ID from which index file.
-
paramsMap
is a map that contains the site name and process name, whose keys aresiteName
andprocessName.
- This returns a string array containing the cycling index file name.
int SMAT_getMessageCount(String siteName, String
indexFileName)
This returns the message count of the specified index file under the specified site.
-
siteName
is the name of the site. -
indexFileName
is the name of the index file.
int getSMATMessageCountExt (HashMapWrapper
paramsMap)
This returns the message count of the specified index file under the specified site.
paramsMap
is a map that contains
the site name and index file name, whose keys are siteName
and indexFileName
.
String[] SMAT_getMessageIds(String siteName, String
indexFileName, int offset, int length)
This searches the specified number of message IDs beginning from
offset
. It then returns the matched message ID
list in a string array.
-
siteName
is the name of the site. -
indexFileName
is the name of the index file. -
offset
is the index of the first message ID to search.offset
represents the physical location in the SMAT index file. -
length
is the number of the message ID to search. - This is a high-performance query interface. The precondition is that the outside applications know the position range of the messages in which they are interested.
String[] SMAT_getMessageIds(String siteName, String
indexFileName, SMATMsgSearchCriteria searchCriteria)
This queries the message IDs under the specified search criteria in the specified index file of the specified site.
-
siteName
is the name of the site. -
indexFileName
is the name of the index file where the message IDs are queried. -
SearchCriteria
is the SMAT message search criteria. -
SMATMsgSearchCriteria
defines the condition for the source thread name, the message ID range, the sending date range, or the message search string. - This returns a string array containing the matched message IDs.
String[] getSMATMessageIdsExt (HashMapWrapper
paramsMap)
- If
paramsMap
containsoffset
andlength
, then this searches the specified number of message IDs beginning fromoffset
. It then returns the matched message ID list in a string array. -
offset
represents the physical location in the SMAT index file. This is a high-performance query interface. The precondition is that the outside applications know the position range of the messages in which they are interested. - If
paramsMap
containssearchCriteria
, then this queries the message IDs under the specified search criteria in the specified index file of the specified site. It then returns a string array containing the matched message IDs. -
searchCriteria
isSMATMsgSearchCriteria
type. This defines the condition for the source thread name, message ID range, sending date range, or message search string. -
paramsMap
is a map that contains the site name, index file name, SMAT message search criteria/index of the first message, and number of the message. - Their keys are
siteName
,indexFileName
,searchCriteria
,offset
, andlength
.-
siteName
andindexFileName
are required. -
offset
andlength
are always paired.This pair of parameters and
searchCriteria
are optional.
-
- This returns a string array containing the matched message IDs.
String SMAT_getMessageId(String siteName, String
indexFileName, int index)
This searches the message at the specified index in the specified index file and returns the corresponding message ID. This is a high-performance query interface.
-
siteName
is the name of the site. -
indexFileName
is the name of the index file. -
index
is the physical location in the SMAT index file, beginning from 0.
String getSMATMessageIdExt (HashMapWrapper paramsMap)
This searches the message at the specified index in the specified index file and returns the corresponding message ID. This is a high-performance query interface.
paramsMap
is a map that contains
the site name, index file name, and the physical location in the SMAT index file,
beginning from 0, whose keys are siteName
, indexFileName
, and index
.
Message SMAT_getMessage(String siteName, String
indexFileName, String mid)
This matches the message according to the specified ID in the specified index file. Returns the message object that contains the content and metadata referencing the SOAP attachments. The format of the message content and metadata is exactly the same as the one used by the SMAT message resend command.
-
siteName
is the name of the site. -
indexFileName
is the name of the index file. -
mid
is the message ID.
Message SMAT_getMessage(String siteName, String
indexFileName, int index)
This searches the message at the index from the specified index file. It then returns a message object that contains the content and metadata referencing the SOAP attachments. The format of the message content and metadata is exactly the same as the one used by the SMAT message resend command.
-
siteName
is the name of the site. -
indexFileName
is the name of the index file. -
index
is the message index.
Message getSMATMessageExt(HashMapWrapper
paramsMap)
This searches a message using the specified parameters and returns a message object containing the message content and metadata input references.
- If
paramsMap
containssiteName
,indexFileName
, andmessageId
, then this matches the message according to the specified ID in the specified index file. It then returns the message object that contains the content and metadata referencing the SOAP attachments. The format of the message content and metadata is exactly the same as the one used by the SMAT message resend command. - If
paramsMap
containssiteName
,indexFileName
, andindex
, then this searches the message at the index from the specified index file. It then returns the message object that contains the content and metadata referencing the SOAP attachments. The format of the message content and metadata is exactly the same as the one used by the SMAT message resend command. -
paramsMap
is a map that containssiteName
,indexFileName
, andmessageId
or index, wheremessageId
andindex
are optional.
void SMAT_resendMessage(String siteName, String
processName, String threadName, Context context, SMATMsgType type, int
priority, DataHandler messageContent, ContentFormat contentFormat) throws
ResendFailedException
This resends the messages with the specified content to the specified thread. The format of the message content is exactly the same as the one used by the SMAT message resend command.
-
siteName
is the name of the site. -
processName
is the name of the process. -
threadName
is the name of the thread to which the message is resent. -
context
is the context. This can be Context.IB_PRE_TPS, Context.IB_POST_TPS, Context.OB_PRE_TPS, or Context.OB_POST_TPS. -
type
is the message resend type. This can be SMATMsgType.DATA or SMATMsgType.REPLY. -
priority
is the resend priority. -
messageContent
is aDataHandler
instance which references an input stream of the message content. -
contentFormat
is the message content format. This can beContentFormat.LEN10
,ContentFormat.EOF
, orContentFormat.EOL
. - Exception:
ResendFailedException
is thrown when the resend fails.
void SMAT_resendMessage(String siteName, String
processName, String threadName, Context context, SMATMsgType type, int
priority, DataHandler messageContent, ContentFormat contentFormat, DataHandler
metaData) throws ResendFailedException
This resends the messages with the specified content and metadata to the specified thread. The format of the message content and metadata is exactly the same as the one used by the SMAT message resend command.
-
siteName
is the name of the site. -
processName
is the name of the process. -
threadName
is the name of the thread name to which the message is resent. -
context
is the context. This can be Context.IB_PRE_TPS, Context.IB_POST_TPS, Context.OB_PRE_TPS, or Context.OB_POST_TPS. - type is the message resend type. This can be SMATMsgType.DATA or SMATMsgType.REPLY.
-
priority
is the resend priority. -
messageContent
is aDataHandler
instance which references an input stream of the message content. -
contentFormat
is the message content format. This can beContentFormat.LEN10
,ContentFormat.EOF
, orContentFormat.EOL
. -
metaData
is aDataHandler
instance which references an input stream of the meta data. - Exception:
ResendFailedException
is thrown when the resend fails.
void SMAT_resendMessage(String siteName, String
processName, String threadName, Context context, SMATMsgType type, int
priority, String indexFilePath, String[] msgIds) throws
ResendFailedException
This resends the messages with the specified message IDs. The resend is processed without any message content and metadata changed.
-
siteName
is the name of the site. -
processName
is the name of the process. -
threadName
is the thread name to which the message is resent. -
context
is the context. This can be Context.IB_PRE_TPS, Context.IB_POST_TPS, Context.OB_PRE_TPS, or Context.OB_POST_TPS. -
type
is the message resend type. This can be SMATMsgType.DATA or SMATMsgType.REPLY. -
priority
is the resend priority. -
indexFilePath
is the path of the index file where the messages are resent. -
msgIds
is the String array containing the IDs of the message that would be resent. - Exception:
ResendFailedException
is thrown when the resend fails.
void SMAT_resendMessage(String siteName, String
processName, String threadName, Context context, SMATMsgType type,int priority,
DataHandler messageContent,ContentFormat contentFormat,String encoding)throws
ResendFailedException
This resends the message with the specified content to the specified thread.
-
siteName
is the site name. -
processName
is the process name. -
threadName
is the thread name. -
context
is the context. This can be Context.IB_PRE_TPS, Context.IB_POST_TPS, Context.OB_PRE_TPS or Context.OB_POST_TPS. -
type
is the type. This can be SMATMsgType.DATA or SMATMsgType.REPLY. -
priority
is the priority. -
messageContent
is the message content. -
contentFormat
is the message content format. This can be ContentFormat.LEN10, ContentFormat.EOF or ContentFormat.EOL. -
encoding
is the encoding of the message data. This can be null. - Exception:
ResendFailedException
is thrown when any exception happens after 5.8.5.0.
void SMAT_resendMessage(String siteName, String
processName, String threadName, Context context, SMATMsgType type,int priority,
DataHandler messageContent,ContentFormat contentFormat,String encoding,
DataHandler metaData) throws ResendFailedException
This resends the message with the specified content and metadata to the specified thread.
-
siteName
is the site name. -
processName
is the process name. -
threadName
is the thread name. -
context
is the context, could be Context.IB_PRE_TPS, Context.IB_POST_TPS, Context.OB_PRE_TPS or Context.OB_POST_TPS. -
type
is the type, could be SMATMsgType.DATA or SMATMsgType.REPLY. -
priority
is the priority. -
messageContent
is the message content. -
contentFormat
is the message content format, could be ContentFormat.LEN10, ContentFormat.EOF or ContentFormat.EOL. -
encoding
is the encoding of the message data, can be null. -
metaData
is the meta data. - Exception:
ResendFailedException
is thrown when any exception happens after 5.8.5.0.
void resendSMATMessageExt(HashMapWrapper paramsMap) throws
ResendFailedException
This resends the message with the specified content and metadata to the specified thread.
- If
paramsMap
containsmessageContent
,contentFormat
,metadata
, andencoding
, then this resends the messages with the specified message content and metadata.- The format of
messageContent
andencoding
is exactly the same as the one used by the SMAT message resend command. -
encoding
can be empty.
- The format of
- If
paramsMap
containsmessageContent
,contentFormat
, andencoding
, then this resends the messages with the specified message content.- The format of
messageContent
andencoding
is exactly the same as the one used by the SMAT message resend command. -
encoding
can be empty.
- The format of
- If
paramsMap
contains does not containmessageContent
orcontentFormat
, then this resends the messages with the specified message IDs. The resend is processed without any message content and metadata being changed. -
paramsMap
is a map that containssiteName
,processName
,threadName
,context
,type
,priority
,messageContent
,contentFormat
,metaData
,encoding
,indexFileName
, andmessageIds
. -
indexFileName
andmessageIds
are always paired. - Exception:
ResendFailedException
is thrown when the resend fails.