Error message resend related web services

The outside applications can query error message IDs that are based on the search condition. These applications can then dump the corresponding message content and metadata to view. They then resend the error message by accessing the error message resend web services.

String[] DB_getMessageIds(String siteName,
			 DBMsgSearchCriteria searchCriteria)

This queries the messages in the error database under the specified site to meet the search criteria defined in searchCriteria. It then returns a string array containing the matched message IDs.

  • siteName is the name of the site.
  • searchCriteria is the message query search criteria.
  • DBMsgSearchCriteria defines the condition for the source/destination thread name, owner name, error state, message type, message ID range, or created time range.
String[]getDBMessageIdsExt (HashMapWrapper
			 paramsMap)

This queries the messages in the error database under the specified site to meet the search criteria defined in searchCriteria. It then returns a string array containing the matched message IDs.

  • searchCriteria is DBMsgSearchCriteria type. This defines the condition for the source/destination thread name, owner name, error state, message type, message ID range, or created time range.
  • paramsMap is a map that contains parameters, whose keys are siteName and searchCriteria.
DataHandler DB_getMessageContent (String siteName,
			 DBMsgSearchCriteria searchCriteria, ContentFormat contentFormat)

This queries the error database to match the search criteria under the specified site and returns the message content with the specified format.

  • siteName is the site name under which the error database is queried.
  • searchCritieria is the database error message search criteria.
  • contentFormat is the format of the returned message content. This can be one of ContentFormat.LEN10, ContentFormat.EOF, or ContentFormat.EOL.
DataHandler getDBMessageContentExt(HashMapWrapper
			 paramsMap)

This queries the error database to match the search criteria under the specified site. It then returns the message content with the specified format.

  • paramsMap is a map that contains the site name, search criteria, and format of the returned message content, whose keys are siteName, searchCriteria, and format.
  • format is one of ContentFormat.LEN10, ContentFormat.EOF, or ContentFormat.EOL.
DataHandler DB_getMetaData (String siteName,
			 DBMsgSearchCriteria searchCriteria, ContentFormat contentFormat)

This searches the error database to match the search criteria and returns the matched metadata.

  • siteName is the site name under which the error database is queried.
  • searchCritieria is the database search criteria.
  • This returns a DataHandler instance referencing the input stream of the matched metadata.
DataHandler getDBMetaDataExt(HashMapWrapper
			 paramsMap)

This searches the Error Database to match the search criteria and returns the matched metadata.

  • paramsMap is a map that contains site name and search criteria. The keys are siteName and searchCriteria.
  • This returns the DataHandler instance referencing the input stream of the matched metadata.
Message DB_getMessage (String siteName, DBMsgSearchCriteria
			 searchCriteria, ContentFormat contentFormat)

This searches the error database under the search criteria and returns the matched message content and metadata. The format of the message content and metadata is the same as the one used in the error message dump command.

  • siteName is the site name under which the error database is queried.
  • searchCritieria is the database search criteria.
  • contentFormat is the format of the returned message content. This can be one of ContentFormat.LEN10, ContentFormat.EOF, or ContentFormat.EOL.
Message getDBMessageExt(HashMapWrapper
			 paramsMap)

This searches the error database under the search criteria and returns the matched message content and metadata. The format of message content and metadata is the same as the one used in the error message dump command.

  • paramsMap is a map that contains the site name, search criteria, and format of the returned message content, whose keys are siteName, searchCriteria, and format.
  • format is one of ContentFormat.LEN10, ContentFormat.EOF, or ContentFormat.EOL.
void DB_resendMessage(String siteName, String processName,
			 MID messageId) throws ResendFailedException

This resends the message with the specified message ID.

  • The resend command is:
    hcicmd -p process_name -c ". resend_errordb
    			mid"
  • siteName is the name of the site.
  • processName is the name of the process.
  • messageId is the message ID.
  • Exception: ResendFailedException is thrown when the resend fails.
void DB_resendMessage(String siteName, String processName,
			 DataHandler metaData) throws ResendFailedException

This resends the message from the error database with the modified metadata from the SOAP attachment.

  • The command is:
    hcicmd -p process_name -c ". resend_errordb -m
    			metadata"
  • The format of the message content and metadata is the same as the one used in the error message resend command.
  • siteName is the name of the site.
  • processName is the process to which the message is sent.
  • metaData is a DataHandler instance which references an input stream of the message metadata.
  • Exception: ResendFailedException is thrown when the resend fails.
void DB_resendMessage(String siteName, String processName,
			 MID messageId, DataHandler messageContent, ContentFormat contentFormat) throws
			 ResendFailedException

This resends the message content with the specified format. It also resends the metadata of the message that is identified by the specified ID to the specified process.

  • The resend command is:
     hcicmd -p process_name -c ".resend_errordb <mid>
    				msgContent len10|nl|eof"
  • siteName is the name of the site.
  • processName is the name of the process.
  • messageId is the message ID.
  • messageContent is the message content.
  • contentFormat is the content format. This can be one of ContentFormat.LEN10, ContentFormat.EOF, or ContentFormat.EOL.
  • Exception: ResendFailedException is thrown when the resend fails.
void DB_resendMessage(String siteName, String processName,
			 DataHandler metadata, DataHandler messageContent, ContentFormat contentFormat)
			 throws ResendFailedException

This resends the message with the specified message content and metadata.

  • The command is:
    hcicmd -p process_name -c ". resend_errordb -m metadata
    				msgcontent len10|nl|eof"
  • siteName is the name of the site.
  • processName is the name of the process.
  • metaData is the metadata.
  • messageContent is the message content.
  • contentFormat is the content format.
  • Exception: ResendFailedException is thrown when the resend fails.
void DB_resendMessage(String siteName, String processName,
			 MID messageId, DataHandler messageContent, ContentFormat contentFormat, String
			 encoding) throws ResendFailedException 
		  

This resends the message content in the specified format into the specified process.

  • The resend command is:
     hcicmd -p <process_name> -c ". resend_errordb mid
    		msgContent len10|nl|eof [-e msg_encoding]" 
  • siteName is the site name.
  • processName is the process name.
  • messageId is the message ID.
  • messageContent is the message content.
  • contentFormat is the 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 DB_resendMessage(String siteName, String processName,
			 DataHandler metaData, DataHandler messageContent, ContentFormat contentFormat,
			 String encoding) throws ResendFailedException

This resends the message with the specified message content and metadata.

  • The resend command is:
    hcicmd -p process_name -c ". resend_errordb -m
    				metadata msgcontent len10|nl|eof [-e
    				msg_encoding]"
  • siteName is the site name.
  • processName is the process name.
  • metaData is the metadata.
  • messageContent is the message content.
  • contentFormat is the content format.
  • encoding is the encoding of the message data.
  • Exception: ResendFailedException is thrown when the resend fails.
void resendDbMessageExt(HashMapWrapper paramsMap) throws
			 ResendFailedException

This resends the message from the error database.

  • If messageContent is not null, then resend specified message content.
  • If messageId is not null, then this resends the message content by the specified ID into the specified process.
  • If contentFormat is not null, then this resends the message content in the specified format into the specified process.
  • If metaData is not null, then this resends the message with the specified message content and metadata.
  • paramsMap is a map that contains the site name, process name, message ID metadata, message content, encoding, and content format. The keys are siteName, processName, messageId, metaData, messageContent, encoding, and contentFormat.
  • Exception: ResendFailedException is thrown when the resend fails.