launchClient tool: WAS v5.1

launchClient tool

Syntax

This section describes the Java 2 Platform Enterprise Edition (J2EE) command line syntax for the launchClient tool for WebSphere Application Server.
The following example illustrates the command line invocation syntax for the launchClient tool
launchClient [<userapp.ear> |-help|-?] [-CCname=value] [app args]

where

userapp.ear is the path and the name of the EAR file that contains the application client
name is the name of the parameter
value is the value to which the parameter ID is set
app args are arguments that pass to the application client

To print the usage information, the first parameter must be a path and a name to an EAR file, -help, or -?. All other parameters are optional and can appear in any order. The application client run time ignores any optional parameters that do not begin with a -CC prefix, and passes them to the application client.

Parameters

Supported arguments include...

-CCsoapConnectorPort The Simple Object Access Protocol (SOAP) connector port. If you do not specify this argument, the WAS default value is used.

-CCverbose This option displays additional information messages. The default is false.

-CCclasspath A class path value. When you launch an application, the system class path is not used. If you want to access classes that are not in the EAR file or part of the resource class paths, specify the appropriate class path here. Multiple paths can be concatenated.

-CCjar The name of the client JAR file that resides within the EAR file for the application you wish to launch. Use this argument when you have multiple client JAR files in the EAR file.

-CCadminConnectorHost Specifies the host name of the server from which configuration information is retrieved. The default is the value of the -CCBootstrapHost parameter or the value of the local host if the -CCBootstrapHost parameter is not specified.

-CCadminConnectorPort Indicates the port number for the administrative client function to use. The default value is 8880 for SOAP connections and 2809 for RMI connections.

-CCadminConnectorType Specifies how the administrative client connects to the server. Specify RMI to use the RMI connection type, or specify SOAP to use the SOAP connection type. The default value is SOAP.

-CCadminConnectorUser Administrative clients use this user name when a server requires authentication. If the connection type is SOAP, and security is enabled on the server, this parameter is required. The SOAP connector does not prompt for authentication.

-CCadminConnectorPassword The password for the user name that the -CCadminConnectorUser parameter specifies.

-CCaltDD The name of an alternate deployment descriptor file. This parameter is used with the -CCjar parameter to specify the deployment descriptor to use. Use this argument when a client JAR file is configured with more than one deployment descriptor. Set the value to null to use the client JAR file standard deployment descriptor.

-CCBootstrapHost The name of the host server you want to connect to initially. The format is: your_server_of_choice.com

-CCBootstrapPort The server port number. If you do not specify this argument, the WebSphere Application Server default value is used.

-CCproviderURL Provides bootstrap server information that the initial context factory can use to obtain an initial context. WAS initial context factory can use either a Common Object Request Broker Architecture (CORBA) object URL or an Internet Inter-ORB Protocol (IIOP) URL. CORBA object URLs are more flexible than IIOP URLs and are the recommended URL format to use. This value can contain more than one bootstrap server address. This feature can be used when attempting to obtain an initial context from a server cluster. You can specify bootstrap server addresses, for all servers in the cluster, in the URL. The operation will succeed if at least one of the servers is running, eliminating a single point of failure. The address list does not process in a particular order. For naming operations, this value overrides the -CCBootstrapHost and -CCBootstrapPort parameters. A CORBA object URL specifying multiple systems is illustrated in the following example
-CCproviderURL=corbaloc:iiop:myserver.companyname.com:9810,:mybackupserver.companyname.com:2809
This value is mapped to the java.naming.provider.url system property.

-CCinitonly Use this option to initialize application client run time for ActiveX application clients without launching the client application. The default is false.

-CCtrace Use this option to obtain debug trace information. You might need this information when reporting a problem to IBM customer support. The default is false.

-CCtracefile Indicates the name of the file to which trace information is written. The default is to write output to the console.

-CCpropfile Indicates the name of a properties file that contains launchClient properties. Specify the properties without the -CC prefix in the file. For example: verbose=true.

-CCsecurityManager Enables and runs the WAS with a security manager. The default is disable.

-CCsecurityMgrClass Indicates the fully qualified name of a class that implements a security manager. Only use this argument if the -CCsecurityManager parameter is set to enable. The default is java.lang.SecurityManager.

-CCsecurityMgrPolicy Indicates the name of a security manager policy file. Only use this argument if the -CCsecurityManager parameter is set to enable. When you enable this parameter, the java.security.policy system property is set. The default is $WAS_HOME/ properties/client.policy.

-CCD Use this option to have the WAS set the specified system property during initialization. Do not use the equals (=) character after the -CCD. For example: -CCDcom.ibm.test.property=testvalue. You can specify multiple -CCD parameters. The general format of this parameter is -CCD<property key>=<property value>.

-CCexitVM Use this option to have the WAS call the System.exit() method after the client application completes. The default is false.

-CCdumpJavaNameSpace Prints out the Java portion of the Java Naming and Directory Interface (JNDI) name space for WAS. The true value uses the short format that prints out the binding name and the type of the object bound at that location. The long value uses the long format that prints out the binding name, bound object type, local object, type and string representation of the local object, for example, IORs and string values. The default value is false.

-CCtraceMode Specifies the trace format to use for tracing. If the valid value, basic, is not specified the default is advanced. Basic tracing format is a more compact form of tracing.

Usage Scenario

The following examples demonstrate correct syntax.

On the Windows operating system: launchClient c:\earfiles\appname.ear -CCBootstrapHost=myWASServer -CCverbose=true app_parm1 app_parm2

On the UNIX operating system: ./launchClient.sh /usr/earfiles/appname.ear -CCBootstrapHost=myWASServer -CCverbose=true app_parm1 app_parm2

See Also
Specifying the directory for an expanded EAR file

-CCsoapConnectorPort	The Simple Object Access Protocol (SOAP) connector port. If you do not specify this argument, the WAS default value is used.
-CCverbose	This option displays additional information messages. The default is false.
-CCclasspath	A class path value. When you launch an application, the system class path is not used. If you want to access classes that are not in the EAR file or part of the resource class paths, specify the appropriate class path here. Multiple paths can be concatenated.
-CCjar	The name of the client JAR file that resides within the EAR file for the application you wish to launch. Use this argument when you have multiple client JAR files in the EAR file.
-CCadminConnectorHost	Specifies the host name of the server from which configuration information is retrieved. The default is the value of the -CCBootstrapHost parameter or the value of the local host if the -CCBootstrapHost parameter is not specified.
-CCadminConnectorPort	Indicates the port number for the administrative client function to use. The default value is 8880 for SOAP connections and 2809 for RMI connections.
-CCadminConnectorType	Specifies how the administrative client connects to the server. Specify RMI to use the RMI connection type, or specify SOAP to use the SOAP connection type. The default value is SOAP.
-CCadminConnectorUser	Administrative clients use this user name when a server requires authentication. If the connection type is SOAP, and security is enabled on the server, this parameter is required. The SOAP connector does not prompt for authentication.
-CCadminConnectorPassword	The password for the user name that the -CCadminConnectorUser parameter specifies.
-CCaltDD	The name of an alternate deployment descriptor file. This parameter is used with the -CCjar parameter to specify the deployment descriptor to use. Use this argument when a client JAR file is configured with more than one deployment descriptor. Set the value to null to use the client JAR file standard deployment descriptor.
-CCBootstrapHost	The name of the host server you want to connect to initially. The format is: your_server_of_choice.com
-CCBootstrapPort	The server port number. If you do not specify this argument, the WebSphere Application Server default value is used.
-CCproviderURL	Provides bootstrap server information that the initial context factory can use to obtain an initial context. WAS initial context factory can use either a Common Object Request Broker Architecture (CORBA) object URL or an Internet Inter-ORB Protocol (IIOP) URL. CORBA object URLs are more flexible than IIOP URLs and are the recommended URL format to use. This value can contain more than one bootstrap server address. This feature can be used when attempting to obtain an initial context from a server cluster. You can specify bootstrap server addresses, for all servers in the cluster, in the URL. The operation will succeed if at least one of the servers is running, eliminating a single point of failure. The address list does not process in a particular order. For naming operations, this value overrides the -CCBootstrapHost and -CCBootstrapPort parameters. A CORBA object URL specifying multiple systems is illustrated in the following example -CCproviderURL=corbaloc:iiop:myserver.companyname.com:9810,:mybackupserver.companyname.com:2809 This value is mapped to the java.naming.provider.url system property.
-CCinitonly	Use this option to initialize application client run time for ActiveX application clients without launching the client application. The default is false.
-CCtrace	Use this option to obtain debug trace information. You might need this information when reporting a problem to IBM customer support. The default is false.
-CCtracefile	Indicates the name of the file to which trace information is written. The default is to write output to the console.
-CCpropfile	Indicates the name of a properties file that contains launchClient properties. Specify the properties without the -CC prefix in the file. For example: verbose=true.
-CCsecurityManager	Enables and runs the WAS with a security manager. The default is disable.
-CCsecurityMgrClass	Indicates the fully qualified name of a class that implements a security manager. Only use this argument if the -CCsecurityManager parameter is set to enable. The default is java.lang.SecurityManager.
-CCsecurityMgrPolicy	Indicates the name of a security manager policy file. Only use this argument if the -CCsecurityManager parameter is set to enable. When you enable this parameter, the java.security.policy system property is set. The default is $WAS_HOME/ properties/client.policy.
-CCD	Use this option to have the WAS set the specified system property during initialization. Do not use the equals (=) character after the -CCD. For example: -CCDcom.ibm.test.property=testvalue. You can specify multiple -CCD parameters. The general format of this parameter is -CCD<property key>=<property value>.
-CCexitVM	Use this option to have the WAS call the System.exit() method after the client application completes. The default is false.
-CCdumpJavaNameSpace	Prints out the Java portion of the Java Naming and Directory Interface (JNDI) name space for WAS. The true value uses the short format that prints out the binding name and the type of the object bound at that location. The long value uses the long format that prints out the binding name, bound object type, local object, type and string representation of the local object, for example, IORs and string values. The default value is false.
-CCtraceMode	Specifies the trace format to use for tracing. If the valid value, basic, is not specified the default is advanced. Basic tracing format is a more compact form of tracing.

On the Windows operating system:	launchClient c:\earfiles\appname.ear -CCBootstrapHost=myWASServer -CCverbose=true app_parm1 app_parm2
On the UNIX operating system:	./launchClient.sh /usr/earfiles/appname.ear -CCBootstrapHost=myWASServer -CCverbose=true app_parm1 app_parm2