Client application Java Network Launcher Protocol deployment descriptor file

 

The deployment descriptor file is the main Java Network Launcher Protocol (JNLP) descriptor file for the client application.

 

Location

The client application has an Application Clients run-time dependency that provides the following:

• Java 2 Runtime Environment from IBM

• Application Clients run-time properties

• SSL KeyStore and TrustStore file

• Application Clients run-time library JAR files (optional for Thin Application client applications)

If the Application Clients run-time dependency is not met, it is downloaded and installed in Java Web Start (JWS), as described by the Application Clients run-time installer JNLP descriptor file.

<j2se version="WASclient6.1.0" href="/WebSphereClientRuntimeWeb/Runtime/WebSphereJre/AppClientRT.jsp"/>

 

Usage notes

The client application must also include the WebSphereClientLauncher.jar file, which contains the launcher class, com.ibm.websphere.client.launcher.ClientLauncher, that completes one of the following actions:

• If it is a J2EE Application client application (that is the resources for the application contain an EAR file with a client application), then the launcher class starts a second Java Virtual Machine (JVM) using the JRE provided by the Application Clients run-time dependency and launches the J2EE Application client application that is packaged in the EAR file.

  The EAR file must be specified as a JAR resource so that it can be downloaded to JWS and specified in the system property, com.ibm.websphere.client.launcher.ear. See JNLP descriptor file for a J2EE Application client application for an example.

• If it is a Thin Application client application, then the launcher class uses the current JVM from the Application Clients run-time dependency and invokes the Thin Application client application main method.

  The Thin Application client application JAR file must be specified as a JAR resource so that it can be downloaded to JWS and the name of the class containing main method entry point is specified in the system property, com.ibm.websphere.launcher.main. See JNLP descriptor file for a Thin Application client application for an example. Unlike the J2EE Application client application, the Thin Application client application is not loading the Application Clients run-time library JAR files from the Application Clients run-time dependency. It is downloaded from the server directly as it is for the Thin Application client application JAR file. An Application Clients run-time library component JNLP descriptor is used for specifying the Application Clients run-time library JAR files resources, as shown in the following example:

  <extension name="WAS Thin EJB Client Library" 
                     href="/WebSphereClientRuntimeWeb/Runtime/WebSphereJars/AppClientLib.jnlp"/>
  
  

  The JNLP specification requires all the resource (JAR or EAR) files used in a JNLP file to be signed. You can specify the –CC arguments defined in the launchClient tool for a J2EE Application client application in application arguments section of the JNLP descriptor files. However, only –CCD is supported for a Thin Application client application to define system properties and the JNLP <property> tag can also be used to define system properties. See the following example for details:

  <property name="java.naming.provider.url" value="corbaloc:iiop:myserver.com:9089"/>
  

  For a J2EE Application client application, specify the following application arguments as defined in the JNLP.

  1. Specify your target server provider URL, as shown in the following example:

     <argument> >-CCDjava.naming.provider.url =corbaloc:iiop:myserver.mydomain.com:9080 </argument>
     

  2. Specify the SSL Key File and SSL Trust File location. These files are expected to be available in the client machine. To use the ones in the Application Clients run-time dependency installed in JWS cache, specify these application arguments:

     <argument> -CCDcom.ibm.ssl.keyStore=${WAS_ROOT}/etc/key.p12 </argument>
     <argument>-CCDcom.ibm.ssl.trustStore=${WAS_ROOT}/etc/trust.p12 </argument>
     

  3. Specify the initial naming context factor, as shown in the following example:

     <argument>-CCDjava.naming.factory.initial=com.ibm.websphere.naming.WsnInitialContextFactory </argument>
     

     For a Thin Application client application, you also need to specify the actual location of the sas.client.props and ssl.client.props files located in the Application Clients run-time dependency that is installed in the JWS cache.

     <argument>-CCDcom.ibm.CORBA.ConfigURL=file:${WAS_ROOT}/properties/sas.client.props </argument>
     <argument>-CCDcom.ibm.SSL.ConfigURL=file:${WAS_ROOT}/properties/ssl.client.props </argument>
     

     If any of the default settings in the sas.client.props and ssl.client.props file need modifying, use the –CCD to change the settings through the system properties, as shown in the following example:

     <argument>-CCDjavacom.ibm.CORBA.securityEnabled=false </argument>
     

     The ${WAS_ROOT} token used in the JNLP file is replaced by the launcher class, com.ibm.websphere.client.launcher.ClientLauncher, to the actual location of the Application Clients run-time dependency installation in the JWS cache. If you are using JSP to dynamically create this JNLP description file, escape this token because it has a different meaning in JSP 2.0. See the following example for details:

     <argument>-CCDcom.ibm.ssl.keyStore=\${WAS_ROOT}/etc/key.p12 </argument>
     <argument>-CCDcom.ibm.ssl.trustStore=\${WAS_ROOT}/etc/trust.p12 </argument>
     

---

Sub-topics

JNLP descriptor file for a J2EE Application client application

JNLP descriptor file for a Thin Application client application

ClientLauncher class

Launcher tool

 

Related tasks

Preparing the Application Client run-time dependency component for Java Web Start
Preparing Application Clients run-time library component for Java Web Start
Use Java Web Start

 

Related Reference

launchClient tool

 

Reference topic