com.cleo.lexicom.external

Interface IMailboxController

All Superinterfaces:

java.rmi.Remote

public interface IMailboxController
extends java.rmi.Remote

Establishes an interface for sending and receiving payload through a specific mailbox. Refer to ILexiCom.getMailboxController(String[]). Also refer to ISessionScript.getMailboxController() and its variants.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLEAR_SET_PROPERTIES Send property which when included and set to "True" indicates that any advanced properties set via parameters should be cleared after the command is run.
static java.lang.String	CLIENT_SERVER_ROLE Property which which contains the client/server role used for the file transfer.
static java.lang.String	COLLECT Receive property which when included and set to "False" indicates that the receive() method should not return files previously received.
static java.lang.String	GET_SOURCE Source filename property which can be used in receive() method parameters object.
static java.lang.String	PROTOCOL Property which which contains the protocol used for the file transfer.
static java.lang.String	PUT_DESTINATION Destination filename property which can be used in send() method parameters object.
static java.lang.String	PUT_OPTIONS PUT command options property which can be used in send() method parameters object.
static java.lang.String	RECEIVER_LAST_PAYLOAD Get an action controller
static java.lang.String	SET_PREFIX Send() and receive() parameters can contain advanced property settings, but the property name must be prefixed by "Set.".
static java.lang.String	USERNAME Property which which contains the user name associated with a file transfer.
static java.lang.String	VERSALEX_SERIAL_NUMBER_SHORT Property which which contains the VersaLex serial number associated with a file transfer.

Method Summary

Modifier and Type	Method and Description
boolean	collect(ILexiComIncoming destination) Retrieves only previously received payload files
java.lang.String[]	createTempAction() Create a new, temporary action if necessary to be used for sending and receiving
java.lang.String[]	createTempAction(java.lang.String alias) Create a new, temporary action if necessary to be used for sending and receiving.
void	end() Ends the active mailbox action, if kept alive, and removes it
void	end(boolean interrupt) Ends the active mailbox action, if kept alive, and removes it
IActionController	getActionController(java.lang.String action) Get an action controller
IActionController	getActionController(java.lang.String[] path)
java.lang.String[]	getBaseCommands() Gets the base action commands for the send and/or receive
int	getHostProtocol() Returns the protocol for the mailbox's host
com.cleo.connector.api.command.ConnectorCommandResult	getLastProtocolResult() Retrieves the last protocol command result (only available on hosts which are a combined host\mailbox)
org.w3c.dom.Element	getLastResult() Retrieves the last command's result element
int	getMailboxPackaging() Returns the packaging for the mailbox
void	overrideBaseCommands(java.lang.String[] lines) Overrides the default base action commands for the send and/or receive
boolean	receive(ILexiComIncoming destination, boolean keepAlive) Starts an action, if necessary, and receives one or more payloads
boolean	receive(ILexiComIncoming destination, java.util.Properties parameters, boolean keepAlive) Starts an action, if necessary, and receives one or more payloads
boolean	send(LexiComOutgoing[] source, boolean keepAlive) Starts an action, if necessary, and sends multipart payload
boolean	send(LexiComOutgoing[] source, java.util.Properties parameters, boolean keepAlive) Starts an action, if necessary, and sends multipart payload
boolean	send(LexiComOutgoing[] source, java.util.Properties parameters, boolean keepAlive, boolean checkMultiplePuts) Starts an action, if necessary, and sends multipart payload
boolean	send(LexiComOutgoing[] source, java.lang.String[] options, java.util.Properties parameters, boolean keepAlive) Starts an action, if necessary, and sends multipart payload
boolean	send(LexiComOutgoing source, boolean keepAlive) Starts an action, if necessary, and sends one payload
boolean	send(LexiComOutgoing source, java.util.Properties parameters, boolean keepAlive) Starts an action, if necessary, and sends one payload
boolean	send(LexiComOutgoing source, java.util.Properties parameters, boolean keepAlive, boolean checkMultiplePuts) Starts an action, if necessary, and sends one payload
void	setHttpResponseListener(IHttpResponseListener httpResponseListener) Activates a response listener for an HTTP mailbox; not available for AS2, AS4, ebMS, RNIF, and EBICS
void	setType(java.lang.String type) Sets the run type of the action started by this controller

Field Detail

PUT_DESTINATION

static final java.lang.String PUT_DESTINATION

Destination filename property which can be used in send() method parameters object. For protocols supporting directories (FTP, SSH FTP), can contain a directory path. If only a directory path (and not a filename) is being specified, the property should end in a File.separator (actually either '/' or '\' is supported). For destination paths that support URI access to a connector host, this is the resource path.

See Also:

Constant Field Values

PUT_OPTIONS

static final java.lang.String PUT_OPTIONS

PUT command options property which can be used in send() method parameters object. Value can be space-separated set of PUT options valid for the protocol

See Also:

Constant Field Values

GET_SOURCE

static final java.lang.String GET_SOURCE

Source filename property which can be used in receive() method parameters object. For protocols supporting directories (FTP, SSH FTP), can contain a directory path. If only a directory path (and not a filename) is being specified, the property should end in a File.separator (actually either '/' or '\' is supported) and VersaLex will assume all files within the directory should be retrieved. For source paths that support URI access to a connector host, this is the resource path.

See Also:

Constant Field Values

COLLECT

static final java.lang.String COLLECT

Receive property which when included and set to "False" indicates that the receive() method should not return files previously received.

See Also:

Constant Field Values

CLEAR_SET_PROPERTIES

static final java.lang.String CLEAR_SET_PROPERTIES

Send property which when included and set to "True" indicates that any advanced properties set via parameters should be cleared after the command is run.

See Also:

Constant Field Values

VERSALEX_SERIAL_NUMBER_SHORT

static final java.lang.String VERSALEX_SERIAL_NUMBER_SHORT

Property which which contains the VersaLex serial number associated with a file transfer.

See Also:

Constant Field Values

USERNAME

static final java.lang.String USERNAME

Property which which contains the user name associated with a file transfer.

See Also:

Constant Field Values

PROTOCOL

static final java.lang.String PROTOCOL

Property which which contains the protocol used for the file transfer.

See Also:

Constant Field Values

CLIENT_SERVER_ROLE

static final java.lang.String CLIENT_SERVER_ROLE

Property which which contains the client/server role used for the file transfer.

See Also:

Constant Field Values

SET_PREFIX

static final java.lang.String SET_PREFIX

Send() and receive() parameters can contain advanced property settings, but the property name must be prefixed by "Set.".

See Also:

Constant Field Values

RECEIVER_LAST_PAYLOAD

static final java.lang.String RECEIVER_LAST_PAYLOAD

Get an action controller

See Also:

Constant Field Values

Method Detail

getActionController

IActionController getActionController(java.lang.String[] path)
                               throws java.lang.Exception

Throws:

java.lang.Exception

getActionController

IActionController getActionController(java.lang.String action)
                               throws java.lang.Exception

Get an action controller

Parameters:

action - is an action under host\mailbox

Returns:

the action controller

Throws:

java.lang.Exception - if VersaLex object no longer open or if running in CLIENT mode and remote method invocation error

createTempAction

java.lang.String[] createTempAction()
                             throws java.lang.Exception

Create a new, temporary action if necessary to be used for sending and receiving

Returns:

the path of the temporary action created

Throws:

java.lang.Exception

createTempAction

java.lang.String[] createTempAction(java.lang.String alias)
                             throws java.lang.Exception

Create a new, temporary action if necessary to be used for sending and receiving. Uses the given the base action.

Parameters:

alias - base action name

Returns:

the path of the temporary action created

Throws:

java.lang.Exception

setType

void setType(java.lang.String type)
      throws java.lang.Exception

Sets the run type of the action started by this controller

Parameters:

type - the VersaLex action's run type. If using a value other than one of the constants in XMLLogElements.Thread.type, value must start with X- or setting may be ignored.

Throws:

java.lang.Exception

getBaseCommands

java.lang.String[] getBaseCommands()
                            throws java.lang.Exception

Gets the base action commands for the send and/or receive

Returns:

the VersaLex commands (SET, PUT, GET, etc.)

Throws:

java.lang.Exception

overrideBaseCommands

void overrideBaseCommands(java.lang.String[] lines)
                   throws java.lang.Exception

Overrides the default base action commands for the send and/or receive

Parameters:

lines - the VersaLex commands (SET, PUT, GET, etc.)

Throws:

java.lang.Exception

send

boolean send(LexiComOutgoing source,
             boolean keepAlive)
      throws java.lang.Exception

Starts an action, if necessary, and sends one payload

Parameters:

source - local source

keepAlive - keeps the action alive for another send/receive

Returns:

true if the send was successful

Throws:

java.lang.Exception

send

boolean send(LexiComOutgoing[] source,
             boolean keepAlive)
      throws java.lang.Exception

Starts an action, if necessary, and sends multipart payload

Parameters:

source - local sources

keepAlive - keeps the action alive for another send/receive

Returns:

true if the send was successful

Throws:

java.lang.Exception

send

boolean send(LexiComOutgoing source,
             java.util.Properties parameters,
             boolean keepAlive)
      throws java.lang.Exception

Starts an action, if necessary, and sends one payload

Parameters:

source - local source

parameters - PUT parameters

keepAlive - keeps the action alive for another send/receive

Returns:

true if the send was successful

Throws:

java.lang.Exception

send

boolean send(LexiComOutgoing[] source,
             java.util.Properties parameters,
             boolean keepAlive)
      throws java.lang.Exception

Starts an action, if necessary, and sends multipart payload

Parameters:

source - local sources

parameters - PUT parameters

keepAlive - keeps the action alive for another send/receive

Returns:

true if the send was successful

Throws:

java.lang.Exception

send

boolean send(LexiComOutgoing source,
             java.util.Properties parameters,
             boolean keepAlive,
             boolean checkMultiplePuts)
      throws java.lang.Exception

Starts an action, if necessary, and sends one payload

Parameters:

source - local source

parameters - PUT parameters

keepAlive - keeps the action alive for another send/receive

checkMultiplePuts - indicates an error should be produced of more than one PUT command is found

Returns:

true if the send was successful

Throws:

java.lang.Exception

send

boolean send(LexiComOutgoing[] source,
             java.util.Properties parameters,
             boolean keepAlive,
             boolean checkMultiplePuts)
      throws java.lang.Exception

Starts an action, if necessary, and sends multipart payload

Parameters:

source - local sources

parameters - PUT parameters

keepAlive - keeps the action alive for another send/receive

checkMultiplePuts - indicates an error should be produced of more than one PUT command is found

Returns:

true if the send was successful

Throws:

java.lang.Exception

send

boolean send(LexiComOutgoing[] source,
             java.lang.String[] options,
             java.util.Properties parameters,
             boolean keepAlive)
      throws java.lang.Exception

Starts an action, if necessary, and sends multipart payload

Parameters:

source - local sources

options - PUT options

parameters - PUT parameters

keepAlive - keeps the action alive for another send/receive

Returns:

true if the send was successful

Throws:

java.lang.Exception

receive

boolean receive(ILexiComIncoming destination,
                boolean keepAlive)
         throws java.lang.Exception

Starts an action, if necessary, and receives one or more payloads

Parameters:

destination - local destination

keepAlive - keeps the action alive for another send/receive

Returns:

true if the receive was successful

Throws:

java.lang.Exception

receive

boolean receive(ILexiComIncoming destination,
                java.util.Properties parameters,
                boolean keepAlive)
         throws java.lang.Exception

Starts an action, if necessary, and receives one or more payloads

Parameters:

destination - local destination

parameters - GET parameters

keepAlive - keeps the action alive for another send/receive

Returns:

true if the receive was successful

Throws:

java.lang.Exception

collect

boolean collect(ILexiComIncoming destination)
         throws java.lang.Exception

Retrieves only previously received payload files

Parameters:

destination - local destination

Returns:

true if any files collected (and deleted)

Throws:

java.lang.Exception

getLastResult

org.w3c.dom.Element getLastResult()
                           throws java.lang.Exception

Retrieves the last command's result element

Returns:

Element (can be null)

Throws:

java.lang.Exception

getLastProtocolResult

com.cleo.connector.api.command.ConnectorCommandResult getLastProtocolResult()
                                                                     throws java.lang.Exception

Retrieves the last protocol command result (only available on hosts which are a combined host\mailbox)

Returns:

ConnectorCommandResult (can be null)

Throws:

java.lang.Exception

end

void end()
  throws java.lang.Exception

Ends the active mailbox action, if kept alive, and removes it

Throws:

java.lang.Exception

end

void end(boolean interrupt)
  throws java.lang.Exception

Ends the active mailbox action, if kept alive, and removes it

Parameters:

interrupt - true if should interrupt action (from separate thread; call Thread.interrupt() first if not running remotely)

Throws:

java.lang.Exception

setHttpResponseListener

void setHttpResponseListener(IHttpResponseListener httpResponseListener)
                      throws java.lang.Exception

Activates a response listener for an HTTP mailbox; not available for AS2, AS4, ebMS, RNIF, and EBICS

Parameters:

httpResponseListener - response listener (can be null)

Throws:

java.lang.Exception

getHostProtocol

int getHostProtocol()
             throws java.lang.Exception

Returns the protocol for the mailbox's host

Returns:

either HTTP_CLIENT/_SERVER, FTP_CLIENT/_SERVER, OFTP_CLIENT, SSHFTP_CLIENT/_SERVER, MQ_CLIENT, SMTP_CLIENT, or MLLP_CLIENT

Throws:

java.lang.Exception

getMailboxPackaging

int getMailboxPackaging()
                 throws java.lang.Exception

Returns the packaging for the mailbox

Returns:

either NONE, AS2, AS3, AS4, ebMS, RNIF, OpenPGP, XML Encryption, or WS

Throws:

java.lang.Exception