com.cleo.lexicom.external

Interface IActionController

All Superinterfaces:

java.rmi.Remote

All Known Subinterfaces:

IHostActionController

public interface IActionController
extends java.rmi.Remote

Establishes an interface for sequentially issuing action commands and streaming throughput. Refer to ILexiCom.getActionController(String[]). Also refer to ISessionScript.getMailboxController() and its variants.

Method Summary

Modifier and Type	Method and Description
LexCommand	build(java.lang.String[] options, java.lang.String command, java.lang.String source, java.lang.String destination, java.util.Properties parameters) Builds a VersaLex command from its components
void	end() Ends the action, if necessary
void	end(boolean interrupt) Ends the action, if necessary
boolean	execute(LexCommand command) Starts the action, if necessary, and executes a VersaLex command
boolean	execute(java.lang.String line) Starts the action, if necessary, and executes a VersaLex command
boolean	get(java.lang.String[] options, java.lang.String source, java.io.File destination, java.util.Properties parameters) Starts the action, if necessary, and receives one or more files
boolean	get(java.lang.String[] options, java.lang.String source, ILexiComIncoming destination, java.util.Properties parameters) Starts the action, if necessary, and receives one or more files
boolean	get(java.lang.String[] options, java.lang.String source, java.util.Properties parameters) Starts the action, if necessary, and receives one or more files to the default destination
java.lang.String	getAlias() Gets the action's alias
IActionController	getAnotherActionController() Returns another action controller for an empty, temporary action
java.lang.String[]	getBaseCommands() Gets the commands associated to the action
IDirectoryController	getDirectoryController() For FTP_CLIENT or SSHFTP_CLIENT, returns a directory controller
java.lang.String	getHostAlias() Gets the action's host alias
int	getHostProtocol() Returns the protocol for the action's host
com.cleo.connector.api.command.ConnectorCommandResult	getLastConnectorResult() Retrieves the last connector command result (only available on hosts which are a combined host\mailbox)
org.w3c.dom.Element	getLastResult() Retrieves the last command's result element
java.lang.String	getMacroValue(java.lang.String macroName) Returns the current value of a macro variable
java.lang.String	getMailboxAlias() Gets the action's mailbox alias
int	getMailboxPackaging() Returns the packaging for the mailbox
java.lang.String[]	getMessages(boolean noColor) Returns list of messages from current or last run of action
boolean	isRunning() Returns true if action is running
void	join(long millis) Waits for the action to finish.
void	overrideBaseCommands(java.lang.String[] lines) Overrides the commands associated to the action.
LexCommand	parse(java.lang.String line) Parses a command into its components
LexCommand	parse(java.lang.String line, boolean validate) Parses a command into its components
boolean	put(java.lang.String[] options, java.io.File[] source, java.lang.String destination, java.util.Properties parameters) Starts the action, if necessary, and sends one or more files
boolean	put(java.lang.String[] options, java.io.File source, java.lang.String destination, java.util.Properties parameters) Starts the action, if necessary, and sends one file
boolean	put(java.lang.String[] options, java.io.InputStream[] source, java.lang.String destination, java.util.Properties parameters) Starts the action, if necessary, and sends one or more files
boolean	put(java.lang.String[] options, java.io.InputStream source, java.lang.String destination, java.util.Properties parameters) Starts the action, if necessary, and sends one file
boolean	put(java.lang.String[] options, com.cleo.lexicom.beans.IRemoteLexiComOutgoing source, java.lang.String destination, java.util.Properties parameters) Starts the action, if necessary, and sends one or more files
boolean	put(java.lang.String[] options, LexiComOutgoing[] source, java.lang.String destination, java.util.Properties parameters) Starts the action, if necessary, and sends one or more files
boolean	put(java.lang.String[] options, LexiComOutgoing source, java.lang.String destination, java.util.Properties parameters) Starts the action, if necessary, and sends one file
void	setType(java.lang.String type) Sets the action's run type
void	xmlLogDetail(java.lang.String s, int level, boolean error, boolean warning) Logs Detail element

Method Detail

getAlias

java.lang.String getAlias()
                   throws java.lang.Exception

Gets the action's alias

Returns:

the action's alias

Throws:

java.lang.Exception

getMailboxAlias

java.lang.String getMailboxAlias()
                          throws java.lang.Exception

Gets the action's mailbox alias

Returns:

the action's mailbox alias

Throws:

java.lang.Exception

getHostAlias

java.lang.String getHostAlias()
                       throws java.lang.Exception

Gets the action's host alias

Returns:

the action's host alias

Throws:

java.lang.Exception

setType

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

Sets the action's run type

Parameters:

type - the VersaLex action's run type

Throws:

java.lang.Exception

getBaseCommands

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

Gets the commands associated to the action

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 commands associated to the action. These are not permanently saved.

Parameters:

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

Throws:

java.lang.Exception

parse

LexCommand parse(java.lang.String line)
          throws java.lang.Exception

Parses a command into its components

Parameters:

line - the VersaLex command to be parsed

Returns:

LexCommand

Throws:

java.lang.Exception

parse

LexCommand parse(java.lang.String line,
                 boolean validate)
          throws java.lang.Exception

Parses a command into its components

Parameters:

line - the VersaLex command to be parsed

validate - indicates whether the parsed command should be validated

Returns:

LexCommand

Throws:

java.lang.Exception

build

LexCommand build(java.lang.String[] options,
                 java.lang.String command,
                 java.lang.String source,
                 java.lang.String destination,
                 java.util.Properties parameters)
          throws java.lang.Exception

Builds a VersaLex command from its components

Parameters:

options - the command options (-ASC, -UNI, ...)

command - the command name (e.g. PUT, GET, SET, ...)

source - the command source file path

destination - the command destination file path

parameters - any additional command parameters (e.g. Content-Type=EDIFACT)

Returns:

LexCommand

Throws:

java.lang.Exception

execute

boolean execute(java.lang.String line)
         throws java.lang.Exception

Starts the action, if necessary, and executes a VersaLex command

Parameters:

line - the VersaLex command to execute

Returns:

true if the command was successful

Throws:

java.lang.Exception

execute

boolean execute(LexCommand command)
         throws java.lang.Exception

Starts the action, if necessary, and executes a VersaLex command

Parameters:

command - the VersaLex command to execute

Returns:

true if the command was successful

Throws:

java.lang.Exception

put

boolean put(java.lang.String[] options,
            java.io.File source,
            java.lang.String destination,
            java.util.Properties parameters)
     throws java.lang.Exception

Starts the action, if necessary, and sends one file

Parameters:

options - send options

source - local source (* and ? supported in name)

destination - remote destination (can be null)

parameters - command parameters (can be null)

Returns:

true if the command was successful

Throws:

java.lang.Exception

put

boolean put(java.lang.String[] options,
            java.io.File[] source,
            java.lang.String destination,
            java.util.Properties parameters)
     throws java.lang.Exception

Starts the action, if necessary, and sends one or more files

Parameters:

options - send options

source - local source

destination - remote destination (can be null)

parameters - command parameters (can be null)

Returns:

true if the command was successful

Throws:

java.lang.Exception

put

boolean put(java.lang.String[] options,
            java.io.InputStream source,
            java.lang.String destination,
            java.util.Properties parameters)
     throws java.lang.Exception

Starts the action, if necessary, and sends one file

Parameters:

options - send options

source - local source

destination - remote destination (can be null)

parameters - command parameters (can be null)

Returns:

true if the command was successful

Throws:

java.lang.Exception

put

boolean put(java.lang.String[] options,
            java.io.InputStream[] source,
            java.lang.String destination,
            java.util.Properties parameters)
     throws java.lang.Exception

Starts the action, if necessary, and sends one or more files

Parameters:

options - send options

source - local sources

destination - remote destination (can be null)

parameters - command parameters (can be null)

Returns:

true if the command was successful

Throws:

java.lang.Exception

put

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

Starts the action, if necessary, and sends one file

Parameters:

options - send options

source - local source

destination - remote destination (can be null)

parameters - command parameters (can be null)

Returns:

true if the command was successful

Throws:

java.lang.Exception

put

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

Starts the action, if necessary, and sends one or more files

Parameters:

options - send options

source - local sources

destination - remote destination (can be null)

parameters - command parameters (can be null)

Returns:

true if the command was successful

Throws:

java.lang.Exception

put

boolean put(java.lang.String[] options,
            com.cleo.lexicom.beans.IRemoteLexiComOutgoing source,
            java.lang.String destination,
            java.util.Properties parameters)
     throws java.lang.Exception

Starts the action, if necessary, and sends one or more files

Parameters:

options - send options

source - local source remote wrapper

destination - remote destination (can be null)

parameters - command parameters (can be null)

Returns:

true if the command was successful

Throws:

java.lang.Exception

get

boolean get(java.lang.String[] options,
            java.lang.String source,
            java.io.File destination,
            java.util.Properties parameters)
     throws java.lang.Exception

Starts the action, if necessary, and receives one or more files

Parameters:

options - receive options

source - remote source (FTP only) (can be null)

destination - local destination (can be null)

parameters - command parameters (can be null)

Returns:

true if the command was successful

Throws:

java.lang.Exception

get

boolean get(java.lang.String[] options,
            java.lang.String source,
            ILexiComIncoming destination,
            java.util.Properties parameters)
     throws java.lang.Exception

Starts the action, if necessary, and receives one or more files

Parameters:

options - receive options

source - remote source (FTP only) (can be null)

destination - local destination (can be null)

parameters - command parameters (can be null)

Returns:

true if the command was successful

Throws:

java.lang.Exception

get

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

Starts the action, if necessary, and receives one or more files to the default destination

Parameters:

options - receive options

source - remote source (FTP only) (can be null)

parameters - command parameters (can be null)

Returns:

true if the command was successful

Throws:

java.lang.Exception

xmlLogDetail

void xmlLogDetail(java.lang.String s,
                  int level,
                  boolean error,
                  boolean warning)
           throws java.lang.Exception

Logs Detail element

Parameters:

s - detail messages receive options

level - message level

error - true if error condition

warning - true if warning condition

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

getLastConnectorResult

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

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

Returns:

ConnectorCommandResult (can be null)

Throws:

java.lang.Exception

getMessages

java.lang.String[] getMessages(boolean noColor)
                        throws java.lang.Exception

Returns list of messages from current or last run of action

Returns:

noColor true if color tag at end should be stripped off of end of messages

Throws:

java.lang.Exception

getMacroValue

java.lang.String getMacroValue(java.lang.String macroName)
                        throws java.lang.Exception

Returns the current value of a macro variable

Parameters:

macroName - is name of the macro to retrieve

Returns:

the current value of the macro, or the macroName if the value is not defined

Throws:

java.lang.Exception

end

void end()
  throws java.lang.Exception

Ends the action, if necessary

Throws:

java.lang.Exception

end

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

Ends the action, if necessary

Parameters:

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

Throws:

java.lang.Exception

getHostProtocol

int getHostProtocol()
             throws java.lang.Exception

Returns the protocol for the action'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, ebMS, OpenPGP, XML Encryption

Throws:

java.lang.Exception

isRunning

boolean isRunning()
           throws java.lang.Exception

Returns true if action is running

Returns:

true if action is running

Throws:

java.lang.Exception

join

void join(long millis)
   throws java.lang.Exception

Waits for the action to finish. A timeout of 0 means to wait forever. This method is not with respect to actions being run through the API

Parameters:

millis - the time to wait in milliseconds

Throws:

java.lang.Exception

getAnotherActionController

IActionController getAnotherActionController()
                                      throws java.lang.Exception

Returns another action controller for an empty, temporary action

Returns:

IActionController if VLTrader or Harmony

Throws:

java.lang.Exception

getDirectoryController

IDirectoryController getDirectoryController()
                                     throws java.lang.Exception

For FTP_CLIENT or SSHFTP_CLIENT, returns a directory controller

Returns:

IDirectoryController if FTP_CLIENT or SSHFTP_CLIENT

Throws:

java.lang.Exception