This topic describes the Java 2 Platform Enterprise Edition
(J2EE) command line syntax for the launchClient tool for WebSphere
Application Server.
You can
use the launchClient command from a node within a Network
Deployment environment. However, do not attempt to use the launchClient command
from the Deployment Manager.
The following
example illustrates the command line invocation syntax for the launchClient
tool:
launchClient [-profileName pName | -JVMOptions options | -help | -?] <userapp> [-CC<name>=<value>] [app args]
where
The first parameter must be -help, -? or
contain no parameter at all. The -profileName pName and -JVMOptions options
are optional parameters. If used, they must appear before the <userapp> parameter.
All other parameters are optional and can appear in any order after
the <userapp> parameter. The J2EE Application client run
time ignores any optional parameters that do not begin with a -CC prefix
and passes those parameters to the application client.
Client container parameters
Supported arguments
include:
- -CCadminConnectorHost
- Specifies the host name of the server from which configuration
information is retrieved.
- -CCadminConnectorPort
- Indicates the port number for the administrative client function
to use. The default value is 8880 for SOAP connections and 2809 for
Remote Method Invocation (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
The default is the value of the -CCBootstrapHost parameter
or the value, localhost, if the -CCBootstrapHost parameter
is not specified.
- -CCBootstrapPort
- The server port number. If you do not specify this argument, the
WebSphere Application Server default value is used.
- -CCclassLoaderMode
- Specifies the class loader mode. If PARENT_LAST is specified,
the class loader loads classes from the local class path before delegating
the class loading to its parent. The classes loaded for the following
are affected:
- Classes defined for the J2EE application client
- Resources defined in the J2EE application
- Classes specified on the manifest of the J2EE client JAR file
- Classes specified using the -CCclasspath option
If PARENT_LAST is not specified, then the default mode, PARENT_FIRST,
causes the class loader to delegate the loading of classes to its
parent class loader before attempting to load the class from its local
class path.
- -CCclasspath
- A class path value. When you launch an application, the system
class path is used. If you want to access classes that are not in
the EAR file or part of the system class paths, specify the appropriate
class path here. Multiple paths can be concatenated.
- -CCD
- Use this option to have the WebSphere Application Server 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>.
- -CCdumpJavaNameSpace
- Prints out the Java portion of the Java Naming and Directory Interface
(JNDI) name space for WebSphere Application Server. 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.
- -CCexitVM
- Use this option to have the WebSphere Application Server call
the System.exit() method after the client application completes.
The default is false.
- -CCinitonly
- Use this option to initialize application client run time for
ActiveX application clients without launching the client application.
The default is false.
- -CCjar
- The name of the client Java Archive (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.
- -CCpropfile
- Indicates the name of a properties file that contains launchClient
properties. Specify the properties without the -CC prefix
in the file, with the exception of the securityManager, securityMgrClass
and securityMgrPolicy properties. See the following example: verbose=true.
- -CCproviderURL
- Provides bootstrap server information that the initial context
factory can use to obtain an initial context. WebSphere Application
Server 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.mycompany.com:9810,:mybackupserver.mycompany.com:2809
This
value is mapped to the java.naming.provider.url system property.
- -CCsecurityManager
- Enables and runs the WebSphere Application Server 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 <app_server_root>/
properties/client.policy.
- -CCsoapConnectorPort
- The Simple Object Access Protocol (SOAP) connector port. If you
do not specify this argument, the WebSphere Application Server default
value is used.
- -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. For more information, read the topics
on tracing and logging configuration and enabling trace
on client and stand-alone applications.
- -CCtracefile
- Indicates the name of the file to which trace information is written.
The default is to write output to the console.
- -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.
For
more information on basic and advanced trace formatting, see Interpreting trace output.
- -CCverbose
- This option displays additional information messages. The default
is false.
If you are using an EJB client application with security
enabled, edit the sas.client.props file, which is located
in the profile_root/properties directory. Within the
file, change the com.ibm.CORBA.loginSource value to none.
For
more information on the sas.client.props utility, see PropFilePasswordEncoder command reference.
- RMI connection with security. Used with the EJB and administrative
client application.
- Using Jacl:
wsadmin -conntype RMI -port rmiportnumber -user userid
-password password
Using Jython:
wsadmin -lang jython -conntype RMI -port rmiportnumber -user userid
-password password
rmiportnumber for your
connection displays in the administrative console as BOOTSTRAP_ADDRESS.
Attention: On the AIX, HP-UX, Linux, i5/OS, Solaris, and z/OS
operating systems, the use of -password option may result in security
exposure as the password information becomes visible to the system
status program, such as ps command, which can be invoked by other
users to display all of the running processes. Do not use this option
if security exposure is a concern. Instead, specify user and password
information in the soap.client.props file for SOAP connector
or sas.client.props file for RMI connector. The soap.client.props and sas.client.props files
are located in the properties directory of your WebSphere Application
Server profile.
Example
The following examples demonstrate correct syntax.
launchClient c:\earfiles\myapp.ear -CCBootstrapHost=myWASServer -CCverbose=true app_parm1 app_parm2
./launchClient.sh /usr/earfiles/myapp.ear -CCBootstrapHost=myWASServer
-CCverbose=true app_parm1 app_parm2