LexiComFactory (Cleo VersaLex Java API)

java.lang.Object
- com.cleo.lexicom.external.LexiComFactory

```
public class LexiComFactory
extends java.lang.Object
```
Factory class for vending CLEO VersaLex API objects.
The followings jars need to be included in the classpath when using the API:
If running in SERVER or STANDALONE mode,

Archives	When Needed
VersaLexHome/lib/*.jar	always required
VersaLexHome/lib/api/connector/*.jar	if VLTrader or Harmony
VersaLexHome/lib/cloud/*.jar	always required
VersaLexHome/lib/connector/*.jar	always required
VersaLexHome/lib/connector/agent/*.jar	if VLTrader or Harmony
VersaLexHome/lib/connector/GCPBucket/*.jar	if Harmony
VersaLexHome/lib/connector/hdfs/*.jar	if VLTrader or Harmony
VersaLexHome/lib/connector/s3/*.jar	if VLTrader or Harmony
VersaLexHome/lib/docdb/*.jar	always required
VersaLexHome/lib/graphdb/*.jar	if VLTrader or Harmony
VersaLexHome/lib/help/*.jar	always required
VersaLexHome/lib/hibernate/*.jar	always required
VersaLexHome/lib/jersey/*.jar	always required
VersaLexHome/lib/json/*.jar	always required
VersaLexHome/lib/mfa/*.jar	always required
VersaLexHome/lib/saml/*.jar	always required
VersaLexHome/lib/scim/*.jar	always required
VersaLexHome/lib/secureshare/*.jar	always required
VersaLexHome/lib/uri/*.jar	always required
VersaLexHome/lib/vaadin/*.jar	always required
VersaLexHome/lib/validator/*.jar	always required
VersaLexHome/lib/ws/*.jar	always required
VersaLexHome/webserver/AjaxSwing/lib/*.jar	always required
VersaLexHome/webserver/AjaxSwing/lib/boot/asboot.jar	always required
VersaLexHome/webserver/AjaxSwing/lib/install/asm-all-3.1.jar	always required

If running in CLIENT mode,

Archives	When Needed
VersaLexHome/lib/{activation,aspirin,mail}.jar	always required (Java activation framework and mail)
VersaLexHome/lib/{as2bean,ftp,ftps,httpbean,httpsbean,HTTPClient,j2ssh,mailbean,webserver}.jar	always required (standard protocols)
VersaLexHome/lib/{FtpServer,sftpserver,SmtpServer}.jar	if VLTrader or Harmony
VersaLexHome/lib/bc{pg,prov}.jar	if using ILexiCom.getCertManager()
VersaLexHome/lib/{CertManager,common}.jar	always required
VersaLexHome/lib/{commons-logging,log4j-1.2-api,log4j-api}.jar	always required
VersaLexHome/lib/ebicsbean.jar	if using Electronic Banking Internet Communication Standard (EBICS) protocol
VersaLexHome/lib/ebxmlbean.jar	if using ebXML Message Service (ebMS) protocol
VersaLexHome/lib/{hsp-api,hspbean}.jar	if using JetSonic protocol
VersaLexHome/lib/iaik_{ecc,ecc_ssl,jce,ssl,cms}.jar	always required (Java cryptography extension and SSL)
VersaLexHome/lib/iaik_javax_crypto.jar	if using ILexiCom.getCertManager()
VersaLexHome/lib/{jackson-core,javax.servlet}.jar	always required
VersaLexHome/lib/jcifs.jar	always required (CIFS/SMB networking)
VersaLexHome/lib/{LexAPI_POJO,lexbean,LexiCom}.jar	always required (framework)
VersaLexHome/lib/mllpbean.jar	if using Minimal Lower Layer Protocol (MLLP) protocol
VersaLexHome/lib/mqbean.jar	if using IBM WebSphere MQ protocol
VersaLexHome/lib/oftpbean.jar	if using Odette FTP (OFTP) protocol
VersaLexHome/lib/rosettabean.jar	if using RosettaNet Implementation Framework (RNIF) protocol
VersaLexHome/lib/sfc.jar	if Windows platform
VersaLexHome/lib/{smtpbean,smtpsbean}.jar	if using Simple Mail Transfer Protocol (SMTP) protocol
VersaLexHome/lib/sshftpbean.jar	if using SSH FTP protocol
VersaLexHome/lib/{vlsnmpagent,snmp4j}.jar	if VLTrader or Harmony
VersaLexHome/lib/{vlmetrics,VLTriggers}.jar	always required
VersaLexHome/lib/VLOSGIMgr.jar	if VLTrader or Harmony
VersaLexHome/lib/wsbean.jar	if using web service (WS) protocol
VersaLexHome/lib/{xalan,xercesImpl,XMLLogger}.jar	always required
VersaLexHome/lib/cloud/Cloud{CacheClient,Common,ServerClient}.jar	always required (framework)
VersaLexHome/lib/connector/connector-api.jar	always required (framework)
VersaLexHome/lib/graphdb/GraphPOJO.jar	if VLTrader or Harmony
VersaLexHome/lib/help/lexhelp.jar	if LexiCom and using ILexiCom.show()
VersaLexHome/lib/help/vlthelp.jar	if VLTrader or Harmony and using ILexiCom.show()
VersaLexHome/lib/hibernate/*.jar	if VLTrader or Harmony
VersaLexHome/lib/jersey/guava.jar	always required
VersaLexHome/lib/json/*.jar	always required
VersaLexHome/lib/{saml/SAML.jar,ws/{opensaml,xmltooling}}.jar	always required
VersaLexHome/lib/secureshare/SecureShare_{API,POJO}.jar	if VLTrader or Harmony (API)
VersaLexHome/webserver/AjaxSwing/lib/{ajaxswing,boot/asboot}.jar	always required (web UI library)

VersaLexHome

Set the JVM parameter -Djava.ext.dirs="VersaLexHome/lib/ext" to "install" the necessary extended jars if using VLTrader or Harmony JDBC database transfer logging. As an alternative to adding all the above jars to the classpath, the JVM parameter -Djava.ext.dirs= can be used to "install" all of the VersaLex jars in addition to the extended jars. Note: It may also be necessary to include the "jre/lib/ext" path as part the -Djava.ext.dirs JVM parameter in order to handle host file password encryption and hashing.

If running in SERVER mode, set the JVM parameter -Dcom.creamtec.home="VersaLexHome\webserver\AjaxSwing". Otherwise, the web UI interface will not initiate correctly.

If running in SERVER mode, set the JVM parameter -Dorg.apache.commons.logging="com.cleo.lexicom.beans.LexLog4JLogger" if not otherwise set.

VersaLex is compatible with JRE 1.8 only. If running in SERVER mode, in addition to adding these jars to the classpath, set the JVM parameter -Xbootclasspath/p:"VersaLexHome/lib/serializer.jar;VersaLexHome/lib/xalan.jar;VersaLexHome/lib/xml-apis.jar". This is because the JRE itself includes a version of XALAN which is not compatible with VersaLex ebMS.

If you are using a JRE not distributed by Cleo, be sure to include the required "unlimited strength" jurisdiction policy jars (local_policy.jar, US_export_policy.jar) in the jre/lib/security directory.

If on Windows, set the JVM parameter -Djava.library.path="VersaLexHome". This is so that the DLLs located in the VersaLex home directory can be located for loading.

If using the FIPS edition of the product, set the JVM parameter -Xenablefips140-3

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CLIENT_ONLY` Distributed model of VersaLex - allows creation of a VersaLex client only, if VersaLex server not running, throws exception
`static int`	`CLIENT_OR_SERVER` Distributed model of VersaLex - allows creation of either VersaLex client or server
`static int`	`HARMONY` Cleo Harmony product
`static int`	`LEXICOM` Cleo LexiCom product
`static int`	`SERVER_ONLY` Distributed model of VersaLex - allows creation of a VersaLex server only, if VersaLex server already running, throws exception
`static int`	`STANDALONE` Deprecated. Now only compatible with LEXICOM; use SERVER_ONLY instead
`static int`	`STANDALONE_WAIT` Deprecated. Now only compatible with LEXICOM; use SERVER_ONLY instead
`static int`	`VLTRADER` Cleo VLTrader product

Constructor Summary

Constructors
Constructor and Description

LexiComFactory()

Constructors
Constructor and Description
`LexiComFactory()`

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static ILexiCom`	`getCurrentInstance()` Returns the current VersaLex product API object
`static ILexiCom`	`getLexiCom(java.lang.String userDir, int model)` Deprecated. Use getVersaLex() instead
`static ILexiCom`	`getLexiCom(java.lang.String userDir, int model, boolean adjustTimezone)` Deprecated. Use getVersaLex() instead
`static ILicenser`	`getLicenser(int product, java.lang.String userDir)` Gets a VersaLex Licenser object
`static ILexiCom`	`getVersaLex(int product, java.lang.String userDir, int model)` Gets a VersaLex product API object
`static ILexiCom`	`getVersaLex(int product, java.lang.String userDir, int model, boolean adjustTimezone)` Gets a VersaLex product API object
`static void`	`setClassLoader(java.lang.ClassLoader classloader)` Specify class loader to be used when vending VersaLex.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - STANDALONE
```
public static final int STANDALONE
```
    Deprecated. Now only compatible with LEXICOM; use SERVER_ONLY instead
    
    Non-distributed model of VersaLex - if VersaLex is already running, throws exception
    
    See Also:
    
    Constant Field Values
  - STANDALONE_WAIT
```
public static final int STANDALONE_WAIT
```
    Deprecated. Now only compatible with LEXICOM; use SERVER_ONLY instead
    
    Non-distributed model of VersaLex - if VersaLex is already running, waits for access
    
    See Also:
    
    Constant Field Values
  - CLIENT_OR_SERVER
```
public static final int CLIENT_OR_SERVER
```
    Distributed model of VersaLex - allows creation of either VersaLex client or server
    
    See Also:
    
    Constant Field Values
  - CLIENT_ONLY
```
public static final int CLIENT_ONLY
```
    Distributed model of VersaLex - allows creation of a VersaLex client only, if VersaLex server not running, throws exception
    
    See Also:
    
    Constant Field Values
  - SERVER_ONLY
```
public static final int SERVER_ONLY
```
    Distributed model of VersaLex - allows creation of a VersaLex server only, if VersaLex server already running, throws exception
    
    See Also:
    
    Constant Field Values
  - LEXICOM
```
public static final int LEXICOM
```
    Cleo LexiCom product
    
    See Also:
    
    Constant Field Values
  - VLTRADER
```
public static final int VLTRADER
```
    Cleo VLTrader product
    
    See Also:
    
    Constant Field Values
  - HARMONY
```
public static final int HARMONY
```
    Cleo Harmony product
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - LexiComFactory
```
public LexiComFactory()
```
- Method Detail
  - getLexiCom
```
public static ILexiCom getLexiCom(java.lang.String userDir,
                                  int model)
                           throws java.lang.Exception
```
    Deprecated. Use getVersaLex() instead
    
    Gets a LexiCom-only API object; do not use with VLTrader
    
    Parameters:
    
    userDir - the installed, home directory for LexiCom
    
    model - either STANDALONE, STANDALONE_WAIT, CLIENT_OR_SERVER, CLIENT_ONLY, or SERVER_ONLY
    
    Returns:
    
    ILexiCom
    
    Throws:
    
    java.lang.Exception - if the LexiCom installation is invalid or if request conflicted with other LexiCom objects
  - getLexiCom
```
public static ILexiCom getLexiCom(java.lang.String userDir,
                                  int model,
                                  boolean adjustTimezone)
                           throws java.lang.Exception
```
    Deprecated. Use getVersaLex() instead
    
    Gets a LexiCom-only API object; do not use with VLTrader
    
    Parameters:
    
    userDir - the installed, home directory for LexiCom
    
    model - either STANDALONE, STANDALONE_WAIT, CLIENT_OR_SERVER, CLIENT_ONLY, or SERVER_ONLY
    
    adjustTimezone - for AS/400 platform, indicates whether QUTCOFFSET system value should be applied
    
    Returns:
    
    ILexiCom
    
    Throws:
    
    java.lang.Exception - if the LexiCom installation is invalid or if request conflicted with other LexiCom objects
  - getVersaLex
```
public static ILexiCom getVersaLex(int product,
                                   java.lang.String userDir,
                                   int model)
                            throws java.lang.Exception
```
    Gets a VersaLex product API object
    
    Parameters:
    
    product - either LEXICOM or VLTRADER or HARMONY
    
    userDir - the installed, home directory for VersaLex
    
    model - either STANDALONE, STANDALONE_WAIT, CLIENT_OR_SERVER, CLIENT_ONLY, or SERVER_ONLY
    
    Returns:
    
    ILexiCom
    
    Throws:
    
    java.lang.Exception - if the VersaLex installation is invalid or if request conflicted with other VersaLex objects
  - getVersaLex
```
public static ILexiCom getVersaLex(int product,
                                   java.lang.String userDir,
                                   int model,
                                   boolean adjustTimezone)
                            throws java.lang.Exception
```
    Gets a VersaLex product API object
    
    Parameters:
    
    product - either LEXICOM or VLTRADER or HARMONY
    
    userDir - the installed, home directory for VersaLex
    
    model - either STANDALONE, STANDALONE_WAIT, CLIENT_OR_SERVER, CLIENT_ONLY, or SERVER_ONLY
    
    adjustTimezone - for AS/400 platform, indicates whether QUTCOFFSET system value should be applied
    
    Returns:
    
    ILexiCom
    
    Throws:
    
    java.lang.Exception - if the VersaLex installation is invalid or if request conflicted with other VersaLex objects
  - getLicenser
```
public static ILicenser getLicenser(int product,
                                    java.lang.String userDir)
                             throws java.lang.Exception
```
    Gets a VersaLex Licenser object
    
    Parameters:
    
    userDir - the installed, home directory for LexiCom
    
    Returns:
    
    ILicenser
    
    Throws:
    
    java.lang.Exception - if the VersaLex installation is invalid
  - getCurrentInstance
```
public static ILexiCom getCurrentInstance()
                                   throws java.lang.Exception
```
    Returns the current VersaLex product API object
    
    Returns:
    
    ILexiCom
    
    Throws:
    
    java.lang.Exception - if the remote VersaLex object was never vended or is now invalid
  - setClassLoader
```
public static void setClassLoader(java.lang.ClassLoader classloader)
```
    Specify class loader to be used when vending VersaLex.
    
    Parameters:
    
    classloader - a ClassLoader that should be used when creating VersaLex objects

Class LexiComFactory

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

STANDALONE

STANDALONE_WAIT

CLIENT_OR_SERVER

CLIENT_ONLY

SERVER_ONLY

LEXICOM

VLTRADER

HARMONY

Constructor Detail

LexiComFactory

Method Detail

getLexiCom

getLexiCom

getVersaLex

getVersaLex

getLicenser

getCurrentInstance

setClassLoader