com.cleo.lexicom.external

Interface ILexiComIncoming

All Known Implementing Classes:

RemoteLexiComIncoming

public interface ILexiComIncoming

Establishes an interface for streaming solicited or unsolicited incoming payload. Refer to IActionController.get(String[],String,ILexiComIncoming,java.util.Properties) or IMailboxController.receive(ILexiComIncoming,boolean) or IListenerController.setDestination(ILexiComIncoming).

Implementation can be configured to run directly within the VersaLex service/daemon by setting "Custom ILexiComIncoming Class" in Configure>Options>Other and copying an archive containing the implementation into VersaLex's lib/api/ folder. If configured this way, VersaLex will instantiate and register the implementation at service/daemon startup.

Method Summary

Modifier and Type	Method and Description
ILexiComMultipartIncoming	multipart(java.lang.String[] source, java.lang.String[] mailbox, java.lang.String messageID, int numParts) Incoming multipart payload (multiple files)
java.io.OutputStream	open(java.lang.String[] source, java.lang.String[] mailbox, java.io.File file, java.lang.String messageID, java.util.Properties parameters) Incoming payload file
void	receipt(java.lang.String[] source, java.lang.String[] mailbox, java.lang.String messageID) (Pre)process payload prior to return receipt generation

Method Detail

open

java.io.OutputStream open(java.lang.String[] source,
                          java.lang.String[] mailbox,
                          java.io.File file,
                          java.lang.String messageID,
                          java.util.Properties parameters)
                   throws java.lang.Exception

Incoming payload file

Parameters:

source - alias path of action or local listener that is receiving

mailbox - alias path of mailbox corresponding to incoming payload

file - default file which would have been used

messageID - message id (can be null)

parameters - (e.g. for AS2 - AS2-From, AS2-To, Subject, Content-Type, Content-Disposition, etc.) (can be null)

Returns:

java.io.OutputStream return null if default destination file to be used

Throws:

java.lang.Exception

multipart

ILexiComMultipartIncoming multipart(java.lang.String[] source,
                                    java.lang.String[] mailbox,
                                    java.lang.String messageID,
                                    int numParts)
                             throws java.lang.Exception

Incoming multipart payload (multiple files)

Parameters:

source - alias path of action or local listener that is receiving

mailbox - alias path of mailbox corresponding to incoming payload

messageID - message id

numParts - number of payload files (-1 if unknown)

Returns:

ILexiComMultipartIncoming return null if default destination file to be used

Throws:

java.lang.Exception

receipt

void receipt(java.lang.String[] source,
             java.lang.String[] mailbox,
             java.lang.String messageID)
      throws java.lang.Exception

(Pre)process payload prior to return receipt generation

Parameters:

source - alias path of action or local listener that received

mailbox - alias path of mailbox corresponding to received payload

messageID - incoming message id just completed

Throws:

java.lang.Exception - if payload is not accepted