Invoking APIs from the client environment

In order to call standard APIs from the client, ensure that the client environment is set up correctly. The client environment must have appropriate CLASSPATH settings and JAR files as described in this section for a basic configuration. SSL, JNDI, or other security requirements may affect your configuration.

Note: It is recommended that you do not invoke a local API in the application JVM before the server initialization. Also, if you are making a local API call, you must add the following code after the local API invocation in the block that has YIFClientFactoryImpl.getLocalApi and api.invoke:
YFCRemoteManager.setIsLocalInvocation(false);

The INSTALL_DIR/resources/ directory must contain the yifclient.properties file.

If you are calling in local mode, the client CLASSPATH must contain all JAR files referred to in the INSTALL_DIR/properties/dynamicclasspath.cfg file.

When invoking APIs through EJB or HTTP, the client CLASSPATH must contain the following files in WAS_HOME/AppClient/properties directory:
  • xapi.jar
  • log4j-1.2.15.jar
  • platform_afc.jar
  • xercesImpl.jar
  • xml-apis.jar
  • ejbstubs.jar (or equivalent .jar file containing EJB stubs).

The client CLASSPATH must also contain the following files from INSTALL_DIR/jar/:

  • install_foundation.jar
  • smcfs/9.1/smcfsshared.jar

Application server-specific files

In addition to the files listed above, the following files are required:

Application Server Required Files
IBM® WebSphere®

For WebSphere, use *ejb.jar available in the EAR file to retrieve the ejbstubs.jar.

  • j2ee.jar
  • com.ibm.ws.ejb.thinclient_version.jar
  • com.ibm.ws.orb_version.jar
  • com.ibm.ws.sib.client.thin.jms_version.jar
  • com.ibm.ws.wcom.jar
Oracle WebLogic 12.2.1.3 and JDK 1.8
  • wlclient.jar
  • Consult your application server documentation for other CLASSPATH requirements.