com.cleo.lexicom.scripts

Interface ISessionScript

public interface ISessionScript

Establishes an interface with VersaLex available within a script. The following built-in JavaScript shell variables and functions are also available:

Variable/Function	Description
arguments	Contains the arguments passed to the script.
environment	Returns the current environment object.
help()	Display usage and help messages.
load(["foo.js",...])	Load JavaScript source files name by string arguments.
loadClass(className)	Load a class named by a string argument. The class must be a script compiled to a class file.
print([expr ...])	Evaluate and print expressions to console.
importPackage(package)	Provides functionality similar to Java's "import" statement.
quit()	Stop execution of the current script environment.
version([number])	Get or set the JavaScript version number.
gc()	Runs the garbage collector.
spawn(arg)	Evaluate function or script name on a new thread.
sync(function [,obj])	Creates a synchronized version of the function, where the synchronization object is the obj argument or "this" if obj is undefined.
readFile(fileName [,encoding])	Returns the content of the file as a string. Encoding of the string can be optionally specified.
readUrl(url [,encoding])	Similar to readFile, reads the contents of the url.
runCommand(name ...)	Runs a specified shell command. Additional arguments are passed to the command.
seal(args ...)	Seals the supplied objects (so they may not be modified - read-only).
toint32(arg)	Converts the argument into a 32-bit integer.
serialize(obj, fileName)	Serializes an object and saves it to a file.
deserialize(fileName)	Reconstructs a serialized object.

Method Summary

Modifier and Type	Method and Description
boolean	activeIO(java.lang.String path) Indicates if the file is currently being input/output by VersaLex
java.lang.String	applyDefaultBox(java.lang.String local, boolean inbox) If local is a relative path, apply the default inbox/outbox settings
void	debug(java.lang.String debugMessage) Write a message to the system debug
java.lang.String	decode(java.lang.String string) Decode a protected string
java.lang.String	decrypt(java.lang.String string) Decrypt a protected string
java.lang.String	encode(java.lang.String string) Encode a protected string
java.lang.String	encrypt(java.lang.String string) Encrypt a protected string
boolean	executeActionCommand(java.lang.String command) Execute a command via the current running action.
java.io.File	getAbsolute(java.io.File file) If file path is not an absolute path, then constructs one from the VersaLex user directory
java.lang.String	getAbsolute(java.lang.String path) If file path is not an absolute path, then constructs one from the VersaLex user directory
IActionController	getActionController() Get this action's controller
IActionController	getActionController(java.lang.String[] path) Get an action controller for another host\\mailbox\\action.
ICertManagerRunTime	getCertManager() Get a VersaLex Certificate Manager object
com.cleo.users.ConnectedUsers.UserSession[]	getConnectedUsers() Get the connected users sessions
int	getHostProtocol() Returns the protocol for the host
IncomingFilters	getIncomingFilters() Add/list/remove incoming filters
ILicense	getLicense() Get the current VersaLex License
ILicenser	getLicenser() Get a VersaLex Licenser object
LogListeners	getLogListeners() Add/list/remove log listeners
IMailboxController	getMailboxController() Get the parent mailbox controller
IMailboxController	getMailboxController(java.lang.String[] path) Get a mailbox controller for another host\\mailbox.
int	getMailboxPackaging() Returns the packaging for the mailbox
Options	getOptions() Get the system options
java.lang.String[]	getProperty(int type, java.lang.String property) Get property value(s)
java.io.File	getRelative(java.io.File file) If file path is an absolute path from the VersaLex user directory, then changes to a relative path
java.lang.String	getRelative(java.lang.String path) If file path is an absolute path from the VersaLex user directory, then changes to a relative path
LexiComOutgoing[]	getResends() Get object(s) to be resent.
ISyncer	getSyncer() Get a VersaLex Synchronizer object
Trigger	getTrigger() Get the event trigger which initiated execution of the script.
java.lang.String	getVersion() Get the VersaLex version
boolean	hasProperty(int type, java.lang.String property) Check if property exists
boolean	isLocal() Indicates whether the host is a local host
boolean	isResending() Indicates whether this action is resend run type.
void	logDetail(java.lang.String logMessage) Write a message to the XML log relative to this script instance
void	logDetail(java.lang.String logMessage, int level, java.lang.String color) Write a message to the XML log relative to this script instance
java.lang.Object	runScriptAction(java.lang.String[] path, java.lang.String... args) Run a (Java)script action
java.lang.Object	runScriptAction(java.lang.String alias, java.lang.String... args) Run a (Java)script action
void	setProperty(int type, java.lang.String property, java.lang.String value) Set property value Warning: The set value is changed in memory and saved permanently when the action finishes.
void	setProperty(int type, java.lang.String property, java.lang.String[] value) Set property values Warning: The set value is changed in memory and saved permanently when the action finishes.

Method Detail

hasProperty

boolean hasProperty(int type,
                    java.lang.String property)
             throws java.lang.Exception

Check if property exists

Parameters:

type - either HOST, MAILBOX, ACTION, or HOST_ACTION

property - the property name requested

Returns:

true if property exists

Throws:

java.lang.Exception

getProperty

java.lang.String[] getProperty(int type,
                               java.lang.String property)
                        throws java.lang.Exception

Get property value(s)

Parameters:

type - either HOST, MAILBOX, ACTION, or HOST_ACTION

property - the property name requested

Returns:

the property value (if the property is not an array, a single entry array is returned)

Throws:

java.lang.Exception

setProperty

void setProperty(int type,
                 java.lang.String property,
                 java.lang.String value)
          throws java.lang.Exception

Set property value

Warning: The set value is changed in memory and saved permanently when the action finishes. This means that setProperty() can reliably be used only if - actions are not allowed to run concurrently OR - for a mailbox property there is only one action in the mailbox OR - for a host property there is only one action in the host.

Parameters:

type - either HOST, MAILBOX, ACTION, or HOST_ACTION

property - the property name requested

value - the property value

Throws:

java.lang.Exception

setProperty

void setProperty(int type,
                 java.lang.String property,
                 java.lang.String[] value)
          throws java.lang.Exception

Set property values

Warning: The set value is changed in memory and saved permanently when the action finishes. This means that setProperty() can reliably be used only if - actions are not allowed to run concurrently OR - for a mailbox property there is only one action in the mailbox OR - for a host property there is only one action in the host.

Parameters:

type - either HOST, MAILBOX, ACTION, or HOST_ACTION

property - the property name requested

value - the property values

Throws:

java.lang.Exception

encode

java.lang.String encode(java.lang.String string)
                 throws java.lang.Exception

Encode a protected string

Parameters:

string - to encode

Returns:

encoded string

Throws:

java.lang.Exception

decode

java.lang.String decode(java.lang.String string)
                 throws java.lang.Exception

Decode a protected string

Parameters:

string - to decode

Returns:

decoded string

Throws:

java.lang.Exception

encrypt

java.lang.String encrypt(java.lang.String string)
                  throws java.lang.Exception

Encrypt a protected string

Parameters:

string - to encrypt

Returns:

encrypted string

Throws:

java.lang.Exception

decrypt

java.lang.String decrypt(java.lang.String string)
                  throws java.lang.Exception

Decrypt a protected string

Parameters:

string - to decrypt

Returns:

decrypted string

Throws:

java.lang.Exception

getCertManager

ICertManagerRunTime getCertManager()
                            throws java.lang.Exception

Get a VersaLex Certificate Manager object

Returns:

ICertManagerRunTime

Throws:

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

getLicense

ILicense getLicense()
             throws java.lang.Exception

Get the current VersaLex License

Returns:

ILicense

Throws:

java.lang.Exception

getLicenser

ILicenser getLicenser()
               throws java.lang.Exception

Get a VersaLex Licenser object

Returns:

ILicenser

Throws:

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

getSyncer

ISyncer getSyncer()
           throws java.lang.Exception

Get a VersaLex Synchronizer object

Returns:

Syncer

Throws:

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

activeIO

boolean activeIO(java.lang.String path)
          throws java.lang.Exception

Indicates if the file is currently being input/output by VersaLex

Parameters:

path - the file path to be checked for active I/O

Returns:

true if the file is currently being input/output

Throws:

java.lang.Exception

getAbsolute

java.io.File getAbsolute(java.io.File file)
                  throws java.lang.Exception

If file path is not an absolute path, then constructs one from the VersaLex user directory

Parameters:

file - either relative or absolute file path

Returns:

absolute file

Throws:

java.lang.Exception

getAbsolute

java.lang.String getAbsolute(java.lang.String path)
                      throws java.lang.Exception

If file path is not an absolute path, then constructs one from the VersaLex user directory

Parameters:

path - either relative or absolute file path

Returns:

absolute file path

Throws:

java.lang.Exception

getRelative

java.io.File getRelative(java.io.File file)
                  throws java.lang.Exception

If file path is an absolute path from the VersaLex user directory, then changes to a relative path

Parameters:

file - either relative or absolute file path

Returns:

relative file

Throws:

java.lang.Exception

getRelative

java.lang.String getRelative(java.lang.String path)
                      throws java.lang.Exception

If file path is an absolute path from the VersaLex user directory, then changes to a relative path

Parameters:

path - either relative or absolute file path

Returns:

relative file path

Throws:

java.lang.Exception

applyDefaultBox

java.lang.String applyDefaultBox(java.lang.String local,
                                 boolean inbox)
                          throws java.lang.Exception

If local is a relative path, apply the default inbox/outbox settings

Parameters:

local - a relative or absolute path

inbox - true if local is inbound path; false if local is outbound path

Returns:

potentially adjusted local path

Throws:

java.lang.Exception

getMailboxController

IMailboxController getMailboxController()
                                 throws java.lang.Exception

Get the parent mailbox controller

Returns:

the mailbox controller

Throws:

java.lang.Exception

getMailboxController

IMailboxController getMailboxController(java.lang.String[] path)
                                 throws java.lang.Exception

Get a mailbox controller for another host\\mailbox. Only available in standalone actions

Parameters:

path - the alias path to the host and/or mailbox. The host and/or mailbox must be in the same host tree branch (or below) as the standalone action.

Returns:

the mailbox controller

Throws:

java.lang.Exception

getActionController

IActionController getActionController()
                               throws java.lang.Exception

Get this action's controller

Returns:

the action controller

Throws:

java.lang.Exception

getActionController

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

Get an action controller for another host\\mailbox\\action. Only available in standalone actions

Parameters:

path - the alias path to the action. The action must be in the same host tree branch (or below) as the standalone action.

Returns:

the action controller

Throws:

java.lang.Exception

getHostProtocol

int getHostProtocol()
             throws java.lang.Exception

Returns the protocol for the 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

isLocal

boolean isLocal()
         throws java.lang.Exception

Indicates whether the host is a local host

Returns:

true if the host is a local user or listener host

Throws:

java.lang.Exception

getOptions

Options getOptions()
            throws java.lang.Exception

Get the system options

Returns:

the system options

Throws:

java.lang.Exception

getVersion

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

Get the VersaLex version

Returns:

the VersaLex version

Throws:

java.lang.Exception

debug

void debug(java.lang.String debugMessage)
    throws java.lang.Exception

Write a message to the system debug

Parameters:

debugMessage - the message to write

Throws:

java.lang.Exception

logDetail

void logDetail(java.lang.String logMessage)
        throws java.lang.Exception

Write a message to the XML log relative to this script instance

Parameters:

logMessage - the message to write

Throws:

java.lang.Exception - if this method is used in the thread which did not execute the script an exception will be thrown.

logDetail

void logDetail(java.lang.String logMessage,
               int level,
               java.lang.String color)
        throws java.lang.Exception

Write a message to the XML log relative to this script instance

Parameters:

logMessage - the message to write

level - the message log level

color - the message color (e.g. black, red, or orange)

Throws:

java.lang.Exception - if this method is used in the thread which did not execute the script an exception will be thrown.

executeActionCommand

boolean executeActionCommand(java.lang.String command)
                      throws java.lang.Exception

Execute a command via the current running action.

Parameters:

command - command to execute

Returns:

True if successful

Throws:

java.lang.Exception

getTrigger

Trigger getTrigger()
            throws java.lang.Exception

Get the event trigger which initiated execution of the script.

Returns:

the event trigger; null if the script was not initiated from a trigger

Throws:

java.lang.Exception

isResending

boolean isResending()
             throws LexiComException

Indicates whether this action is resend run type.

Returns:

true if action is a resend; false otherwise

Throws:

LexiComException - is thrown if this is not invoked from within an action.

getResends

LexiComOutgoing[] getResends()
                      throws LexiComException

Get object(s) to be resent. Note: Multiple resends can only occur when the original transfers were part of a multiple file payload transfer. Example usage: if (ISessionScript.isResending()) { // resend, possibly multiple payload actionController.put(["-MUL"], ISessionScript.getResends(), null, null); } else { // basic send ... }

Returns:

LexiComOutgoing object(s) associated with file(s) to be resent.

Throws:

LexiComException - is thrown if this is not invoked from within an action or if the action is not a resend run type.

getLogListeners

LogListeners getLogListeners()
                      throws LexiComException

Add/list/remove log listeners

Returns:

log listeners management interface

Throws:

LexiComException

getIncomingFilters

IncomingFilters getIncomingFilters()
                            throws LexiComException

Add/list/remove incoming filters

Returns:

incoming filters management interface

Throws:

LexiComException

runScriptAction

java.lang.Object runScriptAction(java.lang.String alias,
                                 java.lang.String... args)
                          throws java.lang.Exception

Run a (Java)script action

Parameters:

alias - the relative alias of the script action; can be a standalone, host, or mailbox action (if accessible)

args - the optional set of arguments to pass to the action

Returns:

the exit code of the scripted action; null if not defined

Throws:

LexiComException

java.lang.Exception

runScriptAction

java.lang.Object runScriptAction(java.lang.String[] path,
                                 java.lang.String... args)
                          throws java.lang.Exception

Run a (Java)script action

Parameters:

path - the absolute alias path to the script action; can be a standalone, host, or mailbox action (if accessible)

args - the optional set of arguments to pass to the action

Returns:

the exit code of the scripted action; null if not defined

Throws:

LexiComException

java.lang.Exception

getConnectedUsers

com.cleo.users.ConnectedUsers.UserSession[] getConnectedUsers()
                                                       throws java.lang.Exception

Get the connected users sessions

Returns:

A list of the connected UserSessions

Throws:

java.lang.Exception