com.cleo.lexicom.external

Interface ILexiCom

All Superinterfaces:

java.rmi.Remote

public interface ILexiCom
extends java.rmi.Remote

Establishes an interface with VersaLex. Refer to LexiComFactory.getVersaLex(int,String,int) or LexiComFactory.getCurrentInstance(). VersaLex nodes are always organized as follows:

 REMOTE HOST
   |
   +--MAILBOX
   |    |
   |    +--ACTION
   |
   +--HOST_ACTION (VLTrader or Harmony only)
   |
   +--TRADING_PARTNER (LexiCom only)

 USERS HOST (VLTrader or Harmony only)
   |
   +--USER MAILBOX
   |    |
   |    +--ACTION
   |
   +--HOST_ACTION
   
 LOCAL LISTENER HOST
   |
   +--SERVICE
 

Field Summary

Fields

Modifier and Type	Field and Description
static int	ACTION Action node type
static int	ACTION_INDEX Action node path index
static int	AS2 Applicability Statement 2 packaging
static int	AS3 Applicability Statement 3 packaging
static int	AS4 AS4 packaging
static int	EBICS EBICS packaging
static int	ebMS ebXML Message Service packaging
static int	FASP_CLIENT Fasp client protocol
static int	FTP_CLIENT FTP client protocol
static int	FTP_SERVER FTP server protocol
static int	HOST Host node type
static int	HOST_ACTION Host-based action node type
static int	HOST_ACTION_INDEX Host-based action node path index
static int	HOST_INDEX Host node path index
static int	HSP HSP protocol
static int	HTTP_CLIENT HTTP client protocol
static int	HTTP_SERVER HTTP server protocol
static int	MAILBOX Mailbox node type
static int	MAILBOX_INDEX Mailbox node path index
static int	MLLP_CLIENT MLLP client protocol
static int	MQ_CLIENT IBM WebSphere MQ client protocol
static int	NONE No packaging
static int	OFTP_CLIENT Odette FTP client protocol
static int	OMNI_SERVER Omni server, http, ftp, and sftp protocols
static int	OPENPGP Open PGP packaging
static int	RNIF RosettaNet packaging
static int	SERVICE Service node type
static int	SERVICE_INDEX Service node path index
static int	SMTP_CLIENT SMTP client protocol
static int	SSHFTP_CLIENT Secure Shell FTP client protocol
static int	SSHFTP_SERVER Secure Shell FTP server protocol
static int	TRADING_PARTNER Trading partner node type
static int	TRADING_PARTNER_INDEX Trading partner node path index
static int	WS Web Service packaging
static int	XML_ENCRYPTION Open XML Encryption packaging

Method Summary

Modifier and Type	Method and Description
java.lang.String	activateHost(java.lang.String preconfigAlias, java.lang.String host, boolean replace) Activate a preconfigured host
boolean	activeIO(java.lang.String path) Indicates if the file is currently being input/output by VersaLex
boolean	activeIO(java.lang.String path, boolean direction) Indicates if the file is currently being input/output by VersaLex
void	addID(int type, java.lang.String[] path, java.lang.String ID) Add an ID association to a host or mailbox
void	addLogListener(LexiComLogListener l) Add a listener for all log events
void	addLogListener(LexiComLogListener l, java.lang.String[] path) Add a listener for a specific element's log events
void	addLogListener(LexiComLogListener l, java.lang.String[] path, int type) Add a listener for a specific element's log events
java.lang.String	applyDefaultBox(int type, java.lang.String[] path, java.lang.String local, boolean inbox) If local is a relative path, apply the action's default inbox/outbox settings
java.lang.String	applyDefaultBox(int type, java.lang.String[] path, java.lang.String local, boolean inbox, boolean localUser) If local is a relative path, apply the action's default inbox/outbox settings
boolean	checkRunnable(int type, java.lang.String[] path) Indicates whether the (local) host or action is currently runnable
boolean	checkRunnable(int type, java.lang.String[] path, boolean lock) Indicates whether the (local) host or action is currently runnable
void	clearID(int type, java.lang.String ID) Clears one ID association to a host or mailbox
void	clearID(int type, java.lang.String[] path) Clears all ID associations to a host or mailbox
java.lang.String	clone(int type, java.lang.String[] path) Clone a new, unique VersaLex element
java.lang.String	clone(int type, java.lang.String[] path, boolean temporary) Clone a new, unique VersaLex element
java.lang.String	clone(int type, java.lang.String[] path, java.lang.String alias, boolean replace) Clone a new VersaLex element
java.lang.String	clone(int type, java.lang.String[] path, java.lang.String alias, boolean replace, boolean temporary) Clone a new VersaLex element
void	close() Closes the VersaLex interface
java.lang.String	create(int type, java.lang.String[] path) Create a new, unique VersaLex element
java.lang.String	create(int type, java.lang.String[] path, boolean temporary) Create a new, unique VersaLex element
java.lang.String	create(int type, java.lang.String[] path, java.lang.String alias, boolean replace) Create a new VersaLex element
java.lang.String	create(int type, java.lang.String[] path, java.lang.String alias, boolean replace, boolean temporary) Create a new VersaLex element
java.lang.String	decode(java.lang.String string) Decode a protected string
java.lang.String	decrypt(java.lang.String string) Decrypt a protected string
void	dispose() Disposes the VersaLex GUI
java.lang.String	encode(java.lang.String string) Encode a protected string
java.lang.String	encrypt(java.lang.String string) Encrypt a protected string
java.lang.String	endLogFile() End an XML log file
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.io.File	getAbsolute(java.io.File file, boolean getUnderlying) If getUnderlying is false, then this returns the same results as calling getAbsolute(path).
java.lang.String	getAbsolute(java.lang.String path) If file path is not an absolute path, then constructs one from the VersaLex user directory
java.lang.String	getAbsolute(java.lang.String path, boolean getUnderlying) If getUnderlying is false, then this returns the same results as calling getAbsolute(file).
IActionController	getActionController(java.lang.String[] path) Get an action controller
ICertManagerRunTime	getCertManager() Get a VersaLex Certificate Manager object
org.w3c.dom.Document	getDocument(java.lang.String host) Gets the XML document for the host which contains all the mailboxes, trading partners, and actions for the host and all property values
IHostActionController	getHostActionController(java.lang.String[] path) Deprecated.
int	getHostProtocol(java.lang.String alias) Returns the protocol for the host
java.lang.String[]	getID(int type, java.lang.String[] path) Get the IDs associated to a host or mailbox
ILicense	getLicense() Get the current VersaLex License
ILicenser	getLicenser() Get a VersaLex Licenser object
IListenerController	getListenerController() Get the listener controller
IMailboxController	getMailboxController(java.lang.String[] path) Get a mailbox controller
int	getMailboxPackaging(java.lang.String[] path) Returns the packaging for the mailbox
Options	getOptions() Get the system options
java.lang.String[]	getPath(int type, java.lang.String ID) Get the host or mailbox associated to the ID
java.lang.String[]	getProperty(int type, java.lang.String[] path, java.lang.String property) Get property value(s)
java.io.File	getRelative(java.io.File file)
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
ISchedule	getSchedule() Get the schedule
ISyncer	getSyncer() Get a VersaLex Synchronizer object
java.lang.String	getVersion() Get the VersaLex version
boolean	hasProperty(int type, java.lang.String[] path, java.lang.String property) Check if property exists
java.lang.String	importHost(java.lang.String filepath, java.lang.String host, boolean replace) Import and activate a host from an XML host file
boolean	isEnabled(int type, java.lang.String[] path) Indicates whether the host, mailbox, action, or trading partner is currently enabled
boolean	isLocal(java.lang.String host) Indicates whether the host is a local host
boolean	isMultipleIDsAllowed(int type, java.lang.String[] path) Indicates whether multiple IDs can be associated to the host or mailbox
boolean	isReady(int type, java.lang.String[] path) Indicates whether the host, mailbox, action, or trading partner is currently ready
boolean	isRunning(int type, java.lang.String[] path) Indicates whether the host, mailbox, or action is currently running
java.lang.String[]	list(int type, java.lang.String[] path) List VersaLex elements
HostType[]	listHostTypes() Lists the generic host types
void	noop() No operation method for testing that ILexiCom still valid
java.lang.String	remove(int type, java.lang.String[] path) Remove a VersaLex element
void	removeLogListener(LexiComLogListener l) Remove a listener for log events
void	removeLogListener(LexiComLogListener l, java.lang.String[] path) Remove a listener for log events
void	removeLogListener(LexiComLogListener l, java.lang.String[] path, int type) Remove a listener for log events
java.lang.String	rename(int type, java.lang.String[] path, java.lang.String alias) Rename a VersaLex element
void	requestStop(int type, java.lang.String[] path, boolean wait) Requests that the running host or action to stop
void	save(int type, java.lang.String[] path) Permanently save set property values
void	save(java.lang.String host) Permanently save set property values for host and all children
void	setClassLoader(java.lang.ClassLoader classloader) Specify class loader to be used.
void	setDefaultDestination(ILexiComIncoming destination) Sets the incoming stream interface
java.lang.String	setDocument(org.w3c.dom.Document document, boolean replace) Sets the XML document for the host which contains all the mailboxes, trading partners, and actions for the host and all property values
void	setMultipleIDsAllowed(int type, java.lang.String[] path, boolean multipleIDsAllowed) Allow/Not allow multiple IDs to be associated to the same host or mailbox
void	setProperty(int type, java.lang.String[] path, java.lang.String property, java.lang.String value) Set property value
void	setProperty(int type, java.lang.String[] path, java.lang.String property, java.lang.String[] value) Set property values
void	show(boolean splash, boolean modal) Displays the VersaLex GUI
java.lang.String	startLogFile(java.lang.String filepath, boolean overwrite) Start an XML log file
void	startRun(int type, java.lang.String[] path, LexiComLogListener l, boolean wait) Starts running the host or action
void	startRun(int type, java.lang.String[] path, LexiComLogListener l, boolean wait, java.lang.String stype) Starts running the host or action
void	startRun(int type, java.lang.String[] path, LexiComLogListener l, boolean wait, java.lang.String stype, java.lang.String username) Starts running the host or action
void	startService() Starts running any hosts marked as auto startup and starts the schedule
void	unlock(int type, java.lang.String[] path) Unlocks a reserved (local) host or action

Field Detail

HOST

static final int HOST

Host node type

See Also:

Constant Field Values

HOST_INDEX

static final int HOST_INDEX

Host node path index

See Also:

Constant Field Values

MAILBOX

static final int MAILBOX

Mailbox node type

See Also:

Constant Field Values

MAILBOX_INDEX

static final int MAILBOX_INDEX

Mailbox node path index

See Also:

Constant Field Values

TRADING_PARTNER

static final int TRADING_PARTNER

Trading partner node type

See Also:

Constant Field Values

TRADING_PARTNER_INDEX

static final int TRADING_PARTNER_INDEX

Trading partner node path index

See Also:

Constant Field Values

ACTION

static final int ACTION

Action node type

See Also:

Constant Field Values

ACTION_INDEX

static final int ACTION_INDEX

Action node path index

See Also:

Constant Field Values

SERVICE

static final int SERVICE

Service node type

See Also:

Constant Field Values

SERVICE_INDEX

static final int SERVICE_INDEX

Service node path index

See Also:

Constant Field Values

HOST_ACTION

static final int HOST_ACTION

Host-based action node type

See Also:

Constant Field Values

HOST_ACTION_INDEX

static final int HOST_ACTION_INDEX

Host-based action node path index

See Also:

Constant Field Values

HTTP_CLIENT

static final int HTTP_CLIENT

HTTP client protocol

See Also:

Constant Field Values

FTP_CLIENT

static final int FTP_CLIENT

FTP client protocol

See Also:

Constant Field Values

OFTP_CLIENT

static final int OFTP_CLIENT

Odette FTP client protocol

See Also:

Constant Field Values

SSHFTP_CLIENT

static final int SSHFTP_CLIENT

Secure Shell FTP client protocol

See Also:

Constant Field Values

MQ_CLIENT

static final int MQ_CLIENT

IBM WebSphere MQ client protocol

See Also:

Constant Field Values

SMTP_CLIENT

static final int SMTP_CLIENT

SMTP client protocol

See Also:

Constant Field Values

MLLP_CLIENT

static final int MLLP_CLIENT

MLLP client protocol

See Also:

Constant Field Values

HTTP_SERVER

static final int HTTP_SERVER

HTTP server protocol

See Also:

Constant Field Values

FTP_SERVER

static final int FTP_SERVER

FTP server protocol

See Also:

Constant Field Values

SSHFTP_SERVER

static final int SSHFTP_SERVER

Secure Shell FTP server protocol

See Also:

Constant Field Values

FASP_CLIENT

static final int FASP_CLIENT

Fasp client protocol

See Also:

Constant Field Values

HSP

static final int HSP

HSP protocol

See Also:

Constant Field Values

OMNI_SERVER

static final int OMNI_SERVER

Omni server, http, ftp, and sftp protocols

See Also:

Constant Field Values

NONE

static final int NONE

No packaging

See Also:

Constant Field Values

AS2

static final int AS2

Applicability Statement 2 packaging

See Also:

Constant Field Values

AS3

static final int AS3

Applicability Statement 3 packaging

See Also:

Constant Field Values

ebMS

static final int ebMS

ebXML Message Service packaging

See Also:

Constant Field Values

OPENPGP

static final int OPENPGP

Open PGP packaging

See Also:

Constant Field Values

XML_ENCRYPTION

static final int XML_ENCRYPTION

Open XML Encryption packaging

See Also:

Constant Field Values

WS

static final int WS

Web Service packaging

See Also:

Constant Field Values

RNIF

static final int RNIF

RosettaNet packaging

See Also:

Constant Field Values

EBICS

static final int EBICS

EBICS packaging

See Also:

Constant Field Values

AS4

static final int AS4

AS4 packaging

See Also:

Constant Field Values

Method Detail

setClassLoader

void setClassLoader(java.lang.ClassLoader classloader)
             throws java.lang.Exception

Specify class loader to be used.

Parameters:

classloader - a ClassLoader that should be used when creating VersaLex objects

Throws:

java.lang.Exception

addLogListener

void addLogListener(LexiComLogListener l)
             throws java.lang.Exception

Add a listener for all log events

Parameters:

l - a LexiComLogListener that will be notified when log events have occurred

Throws:

java.lang.Exception

addLogListener

void addLogListener(LexiComLogListener l,
                    java.lang.String[] path)
             throws java.lang.Exception

Add a listener for a specific element's log events

Parameters:

l - a LexiComLogListener that will be notified when log events have occurred

path - the alias path to the element to be listened

Throws:

java.lang.Exception

addLogListener

void addLogListener(LexiComLogListener l,
                    java.lang.String[] path,
                    int type)
             throws java.lang.Exception

Add a listener for a specific element's log events

Parameters:

l - a LexiComLogListener that will be notified when log events have

path - the alias path to the element type to be listened

type - either HOST, MAILBOX, TRADING_PARTNER, ACTION, SERVICE, or HOST_ACTION Note: Use this variant for type HOST_ACTION

Throws:

java.lang.Exception

removeLogListener

void removeLogListener(LexiComLogListener l)
                throws java.lang.Exception

Remove a listener for log events

Parameters:

l - the LexiComLogListener to remove

Throws:

java.lang.Exception

removeLogListener

void removeLogListener(LexiComLogListener l,
                       java.lang.String[] path)
                throws java.lang.Exception

Remove a listener for log events

Parameters:

l - the LexiComLogListener to remove

path - the alias path of the element type being listened to

Throws:

java.lang.Exception

removeLogListener

void removeLogListener(LexiComLogListener l,
                       java.lang.String[] path,
                       int type)
                throws java.lang.Exception

Remove a listener for log events

Parameters:

l - the LexiComLogListener to remove

path - the alias path of the element type being listened to

type - either HOST, MAILBOX, TRADING_PARTNER, ACTION, SERVICE, or HOST_ACTION Note: Use this variant for type HOST_ACTION

Throws:

java.lang.Exception

startLogFile

java.lang.String startLogFile(java.lang.String filepath,
                              boolean overwrite)
                       throws java.lang.Exception

Start an XML log file

Parameters:

filepath - the path of the XML log file to be created and started

overwrite - if the log file already exists, true indicates the log file should be overwritten; false indicates the log file should be appended

Returns:

the path of the previous log file

Throws:

java.lang.Exception

endLogFile

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

End an XML log file

Returns:

the path of the ended log file

Throws:

java.lang.Exception

importHost

java.lang.String importHost(java.lang.String filepath,
                            java.lang.String host,
                            boolean replace)
                     throws java.lang.Exception

Import and activate a host from an XML host file

Parameters:

filepath - the path of the XML host file to be imported and activated

host - the desired alias of the new host (null for default); can start with a host folder path separated by LexUtil.beanSeparator

replace - true if the host should be replaced if it already exists

Returns:

the alias of the new host

Throws:

java.lang.Exception

activateHost

java.lang.String activateHost(java.lang.String preconfigAlias,
                              java.lang.String host,
                              boolean replace)
                       throws java.lang.Exception

Activate a preconfigured host

Parameters:

preconfigAlias - the alias of the preconfigured host that should be activated

host - the desired alias of the new host (null for default); can start with a host folder path separated by LexUtil.beanSeparator

replace - true if the host should be replaced if it already exists

Returns:

the alias of the new host

Throws:

java.lang.Exception

create

java.lang.String create(int type,
                        java.lang.String[] path)
                 throws java.lang.Exception

Create a new, unique VersaLex element

Parameters:

type - either MAILBOX, TRADING_PARTNER, ACTION, or HOST_ACTION

path - the alias path to the parent of the element type to be created

Returns:

the alias of the new element

Throws:

java.lang.Exception

create

java.lang.String create(int type,
                        java.lang.String[] path,
                        boolean temporary)
                 throws java.lang.Exception

Create a new, unique VersaLex element

Parameters:

type - either MAILBOX, TRADING_PARTNER, ACTION, or HOST_ACTION

path - the alias path to the parent of the element type to be created

temporary - true if temporary usage element; valid for ACTION only

Returns:

the alias of the new element

Throws:

java.lang.Exception

create

java.lang.String create(int type,
                        java.lang.String[] path,
                        java.lang.String alias,
                        boolean replace)
                 throws java.lang.Exception

Create a new VersaLex element

Parameters:

type - either MAILBOX, TRADING_PARTNER, ACTION, or HOST_ACTION

path - the alias path to the parent of the element type to be created

alias - the desired alias of the new element (null for default)

replace - true if the element should be replaced if it already exists

Returns:

the alias of the new element

Throws:

java.lang.Exception

create

java.lang.String create(int type,
                        java.lang.String[] path,
                        java.lang.String alias,
                        boolean replace,
                        boolean temporary)
                 throws java.lang.Exception

Create a new VersaLex element

Parameters:

type - either MAILBOX, TRADING_PARTNER, ACTION, or HOST_ACTION

path - the alias path to the parent of the element type to be created

alias - the desired alias of the new element (null for default)

replace - true if the element should be replaced if it already exists

temporary - true if temporary usage element; valid for ACTION only and !replace

Returns:

the alias of the new element

Throws:

java.lang.Exception

clone

java.lang.String clone(int type,
                       java.lang.String[] path,
                       java.lang.String alias,
                       boolean replace)
                throws java.lang.Exception

Clone a new VersaLex element

Parameters:

type - either HOST, MAILBOX, TRADING_PARTNER, ACTION, or HOST_ACTION

path - the alias path to the element to be cloned

alias - the desired alias of the new element (null for default)

replace - true if the element should be replaced if it already exists

Returns:

the alias of the new element

Throws:

java.lang.Exception

clone

java.lang.String clone(int type,
                       java.lang.String[] path,
                       java.lang.String alias,
                       boolean replace,
                       boolean temporary)
                throws java.lang.Exception

Clone a new VersaLex element

Parameters:

type - either HOST, MAILBOX, TRADING_PARTNER, ACTION, or HOST_ACTION

path - the alias path to the element to be cloned

alias - the desired alias of the new element (null for default); if HOST, can start with a host folder path separated by LexUtil.beanSeparator

replace - true if the element should be replaced if it already exists

temporary - true if temporary usage element; valid for ACTION only and !replace

Returns:

the alias of the new element

Throws:

java.lang.Exception

clone

java.lang.String clone(int type,
                       java.lang.String[] path)
                throws java.lang.Exception

Clone a new, unique VersaLex element

Parameters:

type - either HOST, MAILBOX, TRADING_PARTNER, ACTION, or HOST_ACTION

path - the alias path to the element to be cloned

Returns:

the alias of the new element

Throws:

java.lang.Exception

clone

java.lang.String clone(int type,
                       java.lang.String[] path,
                       boolean temporary)
                throws java.lang.Exception

Clone a new, unique VersaLex element

Parameters:

type - either HOST, MAILBOX, TRADING_PARTNER, ACTION, or HOST_ACTION

path - the alias path to the element to be cloned

temporary - true if temporary usage element; valid for ACTION only

Returns:

the alias of the new element

Throws:

java.lang.Exception

remove

java.lang.String remove(int type,
                        java.lang.String[] path)
                 throws java.lang.Exception

Remove a VersaLex element

Parameters:

type - either HOST, MAILBOX, TRADING_PARTNER, ACTION, or HOST_ACTION

path - the alias path to the element to be removed

Returns:

the alias of the removed element

Throws:

java.lang.Exception

rename

java.lang.String rename(int type,
                        java.lang.String[] path,
                        java.lang.String alias)
                 throws java.lang.Exception

Rename a VersaLex element

Parameters:

type - either HOST, MAILBOX, TRADING_PARTNER, ACTION, or HOST_ACTION

path - the alias path to the element to be renamed

alias - the new alias

Returns:

the alias of the renamed element

Throws:

java.lang.Exception

list

java.lang.String[] list(int type,
                        java.lang.String[] path)
                 throws java.lang.Exception

List VersaLex elements

Parameters:

type - either HOST, MAILBOX, TRADING_PARTNER, ACTION, SERVICE, or HOST_ACTION

path - the alias path to the element type to be listed

Returns:

the aliases of the elements found

Throws:

java.lang.Exception

getDocument

org.w3c.dom.Document getDocument(java.lang.String host)
                          throws java.lang.Exception

Gets the XML document for the host which contains all the mailboxes, trading partners, and actions for the host and all property values

Parameters:

host - the alias of the host

Returns:

the XML document of the host

Throws:

java.lang.Exception

setDocument

java.lang.String setDocument(org.w3c.dom.Document document,
                             boolean replace)
                      throws java.lang.Exception

Sets the XML document for the host which contains all the mailboxes, trading partners, and actions for the host and all property values

Parameters:

document - the XML document for the host

replace - true if the host should be replaced if it already exists

Returns:

the alias of the host

Throws:

java.lang.Exception

hasProperty

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

Check if property exists

Parameters:

type - either HOST, MAILBOX, TRADING_PARTNER, ACTION, SERVICE, or HOST_ACTION

path - the alias path to the property type requested

property - the property name requested

Returns:

true if property exists

Throws:

java.lang.Exception

getProperty

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

Get property value(s)

Parameters:

type - either HOST, MAILBOX, TRADING_PARTNER, ACTION, SERVICE, or HOST_ACTION

path - the alias path to the property type requested

property - the property name requested

Throws:

java.lang.Exception

setProperty

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

Set property value

Parameters:

type - either HOST, MAILBOX, TRADING_PARTNER, ACTION, SERVICE, or HOST_ACTION

path - the alias path to the property type requested

property - the property name requested

value - the property value

Throws:

java.lang.Exception

setProperty

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

Set property values

Parameters:

type - either HOST, MAILBOX, TRADING_PARTNER, ACTION, SERVICE, or HOST_ACTION

path - the alias path to the property type requested

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

save

void save(java.lang.String host)
   throws java.lang.Exception

Permanently save set property values for host and all children

Parameters:

host - the alias of the host

Throws:

java.lang.Exception

save

void save(int type,
          java.lang.String[] path)
   throws java.lang.Exception

Permanently save set property values

Parameters:

type - either HOST, MAILBOX, TRADING_PARTNER, ACTION, or HOST_ACTION

path - the alias path

Throws:

java.lang.Exception

applyDefaultBox

java.lang.String applyDefaultBox(int type,
                                 java.lang.String[] path,
                                 java.lang.String local,
                                 boolean inbox)
                          throws java.lang.Exception

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

Parameters:

type - either MAILBOX, ACTION, or HOST_ACTION

path - the alias path to the type specified

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

applyDefaultBox

java.lang.String applyDefaultBox(int type,
                                 java.lang.String[] path,
                                 java.lang.String local,
                                 boolean inbox,
                                 boolean localUser)
                          throws java.lang.Exception

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

Parameters:

type - either MAILBOX, ACTION, or HOST_ACTION

path - the alias path to the type specified

local - a relative or absolute path

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

localUser - true if local user copy command

Returns:

potentially adjusted local path

Throws:

java.lang.Exception

isRunning

boolean isRunning(int type,
                  java.lang.String[] path)
           throws java.lang.Exception

Indicates whether the host, mailbox, or action is currently running

Parameters:

type - either HOST, MAILBOX, ACTION, or HOST_ACTION

path - the alias path to the type specified

Returns:

true if host, mailbox, or action is currently running

Throws:

java.lang.Exception

isEnabled

boolean isEnabled(int type,
                  java.lang.String[] path)
           throws java.lang.Exception

Indicates whether the host, mailbox, action, or trading partner is currently enabled

Parameters:

type - either HOST, MAILBOX, TRADING_PARTNER, ACTION, SERVICE, or HOST_ACTION

path - the alias path to the type specified

Returns:

true if host, mailbox, or action is currently enabled

Throws:

java.lang.Exception

isReady

boolean isReady(int type,
                java.lang.String[] path)
         throws java.lang.Exception

Indicates whether the host, mailbox, action, or trading partner is currently ready

Parameters:

type - either HOST, MAILBOX, TRADING_PARTNER, ACTION, SERVICE, or HOST_ACTION

path - the alias path to the type specified

Returns:

true if host, mailbox, or action is currently ready; otherwise throws an exception

Throws:

java.lang.Exception

checkRunnable

boolean checkRunnable(int type,
                      java.lang.String[] path)
               throws java.lang.Exception

Indicates whether the (local) host or action is currently runnable

Parameters:

type - either (local) HOST, ACTION, or HOST_ACTION

path - the alias path to the type specified

Returns:

true if local host/action is currently runnable; otherwise throws an exception

Throws:

java.lang.Exception

checkRunnable

boolean checkRunnable(int type,
                      java.lang.String[] path,
                      boolean lock)
               throws java.lang.Exception

Indicates whether the (local) host or action is currently runnable

Parameters:

type - either (local) HOST, ACTION, or HOST_ACTION

path - the alias path to the type specified

lock - true if action should be reserved for use until run

Returns:

true if local host/action is currently runnable; otherwise throws an exception

Throws:

java.lang.Exception

unlock

void unlock(int type,
            java.lang.String[] path)
     throws java.lang.Exception

Unlocks a reserved (local) host or action

Parameters:

type - either (local) HOST, ACTION, or HOST_ACTION

path - the alias path to the local host/action/host-based action

Throws:

java.lang.Exception

startRun

void startRun(int type,
              java.lang.String[] path,
              LexiComLogListener l,
              boolean wait)
       throws java.lang.Exception

Starts running the host or action

Parameters:

type - either HOST, ACTION, or HOST_ACTION

path - the alias path to the host/action/host-based action

l - a LexiComLogListener that will be notified when log events have occurred for this host/action (can be null). This listener relative to this path will be automatically removed when the action finishes

wait - true if should not return until host/action is done (overridden to false for local listener host)

Throws:

java.lang.Exception

startRun

void startRun(int type,
              java.lang.String[] path,
              LexiComLogListener l,
              boolean wait,
              java.lang.String stype)
       throws java.lang.Exception

Starts running the host or action

Parameters:

type - either HOST, ACTION, or HOST_ACTION

path - the alias path to the host/action/host-based action

l - a LexiComLogListener that will be notified when log events have occurred for this host/action (can be null). This listener relative to this path will be automatically removed when the action finishes

wait - true if should not return until host/action is done (overridden to false for local listener host)

stype - defaults to "API" if not provided

Throws:

java.lang.Exception

startRun

void startRun(int type,
              java.lang.String[] path,
              LexiComLogListener l,
              boolean wait,
              java.lang.String stype,
              java.lang.String username)
       throws java.lang.Exception

Starts running the host or action

Parameters:

type - either HOST, ACTION, or HOST_ACTION

path - the alias path to the host/action/host-based action

l - a LexiComLogListener that will be notified when log events have occurred for this host/action (can be null). This listener relative to this path will be automatically removed when the action finishes

wait - true if should not return until host/action is done (overridden to false for local listener host)

stype - defaults to "API" if not provided

username - is the username that initiated the run

Throws:

java.lang.Exception

requestStop

void requestStop(int type,
                 java.lang.String[] path,
                 boolean wait)
          throws java.lang.Exception

Requests that the running host or action to stop

Parameters:

type - either HOST, ACTION, or HOST_ACTION

path - the alias path to the host/action/host-based action

wait - true if should not return until the host/action is stopped

Throws:

java.lang.Exception

startService

void startService()
           throws java.lang.Exception

Starts running any hosts marked as auto startup and starts the schedule

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

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

show

void show(boolean splash,
          boolean modal)
   throws java.lang.Exception

Displays the VersaLex GUI

Parameters:

splash - true if splash screen should be displayed

modal - true for a modal VersaLex GUI, false for one that allows other windows to be active at the same time

Throws:

java.lang.Exception

dispose

void dispose()
      throws java.lang.Exception

Disposes the VersaLex GUI

Throws:

java.lang.Exception

close

void close()
    throws java.lang.Exception

Closes the VersaLex interface

Throws:

java.lang.Exception

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

activeIO

boolean activeIO(java.lang.String path,
                 boolean direction)
          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

direction - true if the check is active input, false if active output

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.rmi.RemoteException

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.rmi.RemoteException - if running in CLIENT mode and remote method invocation error

getAbsolute

java.lang.String getAbsolute(java.lang.String path)
                      throws java.rmi.RemoteException

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.rmi.RemoteException - if running in CLIENT mode and remote method invocation error

getAbsolute

java.io.File getAbsolute(java.io.File file,
                         boolean getUnderlying)
                  throws java.rmi.RemoteException

If getUnderlying is false, then this returns the same results as calling getAbsolute(path). If getUnderlying is true, then this retrieves the absolute path of the underlying file. If this is a file system file and is not an absolute path, it constructs one from the VersaLex user directory. If this is a URI path that has an underlying file system file, the absolute path of the file will be returned. If the URI path does not have an underlying file, the original URI path will be returned.

Parameters:

file - either relative or absolute file path

getUnderlying - retrieves underlying file (if possible)

Returns:

absolute file

Throws:

java.rmi.RemoteException - if running in CLIENT mode and remote method invocation error

getAbsolute

java.lang.String getAbsolute(java.lang.String path,
                             boolean getUnderlying)
                      throws java.rmi.RemoteException

If getUnderlying is false, then this returns the same results as calling getAbsolute(file). If getUnderlying is true, then this retrieves the absolute path of the underlying file. If this is a file system file and is not an absolute path, it constructs one from the VersaLex user directory. If this is a URI path that has an underlying file system file, the absolute path of the file will be returned. If the URI path does not have an underlying file, the original URI path will be returned.

Parameters:

path - either relative or absolute file path

getUnderlying - retrieves underlying file (if possible)

Returns:

absolute file path

Throws:

java.rmi.RemoteException - if running in CLIENT mode and remote method invocation error

getRelative

java.io.File getRelative(java.io.File file)
                  throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getRelative

java.lang.String getRelative(java.lang.String path)
                      throws java.rmi.RemoteException

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.rmi.RemoteException - if running in CLIENT mode and remote method invocation error

getMailboxController

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

Get a mailbox controller

Parameters:

path - the alias path to the mailbox

Returns:

the mailbox controller

Throws:

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

getActionController

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

Get an action controller

Parameters:

path - the alias path to the action or hostaction

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

getHostActionController

@Deprecated
IHostActionController getHostActionController(java.lang.String[] path)
                                                   throws java.lang.Exception

Deprecated.

Get a host action controller. This method has been deprecated. Use the more general getActionController().

Parameters:

path - the alias path to the host action

Returns:

the host action controller

Throws:

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

getListenerController

IListenerController getListenerController()
                                   throws java.lang.Exception

Get the listener controller

Returns:

the listener controller

Throws:

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

setDefaultDestination

void setDefaultDestination(ILexiComIncoming destination)
                    throws java.lang.Exception

Sets the incoming stream interface

Parameters:

destination - the default incoming destination for all actions and the local listener

Throws:

java.lang.Exception

noop

void noop()
   throws java.lang.Exception

No operation method for testing that ILexiCom still valid

Throws:

java.lang.Exception

getHostProtocol

int getHostProtocol(java.lang.String alias)
             throws java.lang.Exception

Returns the protocol for the host

Parameters:

alias - the alias of 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(java.lang.String[] path)
                 throws java.lang.Exception

Returns the packaging for the mailbox

Parameters:

path - the alias path to the host/mailbox

Returns:

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

Throws:

java.lang.Exception

addID

void addID(int type,
           java.lang.String[] path,
           java.lang.String ID)
    throws java.lang.Exception

Add an ID association to a host or mailbox

Parameters:

type - either HOST or MAILBOX

path - the alias path to the host or mailbox

ID - the ID value to associate to the host or mailbox

Throws:

java.lang.Exception

getID

java.lang.String[] getID(int type,
                         java.lang.String[] path)
                  throws java.lang.Exception

Get the IDs associated to a host or mailbox

Parameters:

type - either HOST or MAILBOX

path - the alias path to the host or mailbox

Returns:

the ID values associated to the host or mailbox or null if no IDs are associated

Throws:

java.lang.Exception

setMultipleIDsAllowed

void setMultipleIDsAllowed(int type,
                           java.lang.String[] path,
                           boolean multipleIDsAllowed)
                    throws java.lang.Exception

Allow/Not allow multiple IDs to be associated to the same host or mailbox

Parameters:

type - either HOST or MAILBOX

path - the alias path to the host or mailbox

multipleIDsAllowed - true if multiple IDs can be associated to the host or mailbox

Throws:

java.lang.Exception

isMultipleIDsAllowed

boolean isMultipleIDsAllowed(int type,
                             java.lang.String[] path)
                      throws java.lang.Exception

Indicates whether multiple IDs can be associated to the host or mailbox

Parameters:

type - either HOST or MAILBOX

path - the alias path to the host or mailbox

Returns:

true (default) is multiple IDs can be associated to the host or mailbox

Throws:

java.lang.Exception

getPath

java.lang.String[] getPath(int type,
                           java.lang.String ID)
                    throws java.lang.Exception

Get the host or mailbox associated to the ID

Parameters:

type - either HOST or MAILBOX

ID - the host or mailbox ID

Returns:

the alias path of the host or mailbox associated to the ID or null if no association exists

Throws:

java.lang.Exception

clearID

void clearID(int type,
             java.lang.String ID)
      throws java.lang.Exception

Clears one ID association to a host or mailbox

Parameters:

type - either HOST or MAILBOX

ID - the ID association to be cleared

Throws:

java.lang.Exception

clearID

void clearID(int type,
             java.lang.String[] path)
      throws java.lang.Exception

Clears all ID associations to a host or mailbox

Parameters:

type - either HOST or MAILBOX

path - the alias path to the host or mailbox

Throws:

java.lang.Exception

isLocal

boolean isLocal(java.lang.String host)
         throws java.lang.Exception

Indicates whether the host is a local host

Parameters:

host - the host alias

Returns:

true if the host is a local user or listener host

Throws:

java.lang.Exception

listHostTypes

HostType[] listHostTypes()
                  throws java.lang.Exception

Lists the generic host types

Returns:

array of available generic host types

Throws:

java.lang.Exception

getOptions

Options getOptions()
            throws java.lang.Exception

Get the system options

Returns:

the system options

Throws:

java.lang.Exception

getSchedule

ISchedule getSchedule()
               throws java.lang.Exception

Get the schedule

Returns:

the schedule

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