InfoCenter Home >
6: Administer applications >
6.6: Tools and resources quick reference >
6.6.0: About user assistance >
6.6.0.10: SoapEarEnabler tool

6.6.0.10: SoapEarEnabler tool

The SoapEarEnabler tool is a Java application that enables a set of SOAP services within an Enterprise Application Archive (EAR).

Note  Start with an existing EAR file, either one created with the Application Assembly Tool (AAT), or a previously-created, valid, J2EE-compliant EAR.

The SoapEarEnabler guides you through the required steps to enable one or more services within an application. The SoapEarEnabler tool makes a backup copy of your original EAR in the event you need to remove or add services at a later time.

Note   SoapEarEnabler will not accept a "soap-enabled" EAR file as input.

After you enable web services, you must install the EAR in WebSphere Application Server.

You will be prompted as to whether you wish to add the adminsitration client to the EAR. This is a Web-based client that will allow to list all active services for a specific context from a browser window. With this interface, you can stop and start existing services. You might choose to not add this interface for security reasons, or you might want to secure the interface before making a service available.

For more information on securing resources, see article Securing SOAP services.

Before invoking SoapEarEnabler, first create an 4.8.2.1: Apache SOAP deployment descriptor for each service to be enabled.

Invoke the SOAP EAR enabler tool from the WebSphere Application Server bin directory using the command, SoapEarEnabler on the Windows platform or SoapEarEnabler.sh on UNIX platforms.

The tool operates in two modes:

  1. interactive
  2. silent
Specify all required command line arguments to use the tool in silent mode.

Interactive mode

The SoapEarEnabler tool prompts you for all required information. The following dialog is an example of using the tool in interactive mode.

Note   In this dialog, user input is in italics, and tool output is in bold.

SoapEarEnabler (On Windows NT)
SoapEarEnabler.sh (On UNIX platforms)

Please enter the name of your ear file:
..\work\stockquote.ear
How many services would you like your application to contain (1...n)?
1

Now prompting for info for service #1:
    Please enter the file name of the deployment descriptor xml file:
    ..\work\StockQuoteDD.xml
    Is this service an EJB (y/n)?
    n
    How many jar files are required for this service (0...n)?
    1
    Classpath requirement #1: Please choose a file ([1] samples.jar, [2] stockquote.war):
    1
    Should this service be secured (y/n)?
    n

Please enter a context root for your non-secured services (e.g. /soap):
/soapsamples
Do you wish to install the administration client?
    Warning! You should not install this client in a production ear unless you intend to secure the URI to it.

Install the administration client (y= yes/n= no)?

y

Silent Mode

In silent mode, supply the arguments in the same order as for the interactive prompts.

Note  In silent mode, the SOAP Admin GUI will not install. Also, you will not be prompted for the SOAP Admin GUI.

The following example describes how to to use the tool in silent mode:

soapearenabler [args]

where the arguments must be specified in the following order:
<ear-file-name>
<number-of-services>
The following block is repeated based on the number of services specified.
<deployment-descriptor-file-name>
<service-is-an-ejb-(y/n)>
The following argument should be supplied only if service-is-an-ejb-(y/n) is y.
<ejb-jar-file-uri-(already-in-ear)>
<number-of-additional-jar-files (0, 1, 2...)>
The following argument is repeated number-of-additional-jar-files times.
<classpath-entry-uri-(already-in-ear)>
<secure-this-service-(y/n)>
This following argument is supplied only if secure-this-service-(y/n) is n for any service.
<context-root-for-non-secured-services, ex: /soap>
This following argument is supplied only if secure-this-service-(y/n) is y for any service.
<context-root-for-secured-services, ex: /soapsec>

Silent Mode examples

The following is an example of deploying one ejb as a non-secured service:

soapearenabler soap.ear 1
d:\xml-soap\java\samples\ejbadder\deploymentdescriptor.xml
y adderservice-ejb.jar 1 samples.jar n /soap

The following is an example of deploying one ejb as a non-secured service, and one java class as a secured service:
soapearenabler soap.ear 2
d:\xml-soap\java\samples\ejbadder\deploymentdescriptor.xml
y adderservice-ejb.jar 1 samples.jar n
d:\xml-soap\java\samples\stockquote\deploymentdescriptor.xml
n 1 samples.jar y /soap /soap-sec

The following is an example of deploying 2 java classes as non-secured services:
soapearenabler soap.ear 2
d:\xml-soap\java\samples\stockquote\deploymentdescriptor.xml
n 1 samples.jar n
d:\xml-soap\java\samples\addressbook\deploymentdescriptor.xml
n 1 samples.jar n /soap

The line breaks in the above examples have been modified for this documentation. Typically, commands are issued on a single line.

Go to previous article: Starting the Application Client Resource Configuration Tool and opening an EAR file Go to next article: Log Analyzer main window

 

 
Go to previous article: Starting the Application Client Resource Configuration Tool and opening an EAR file Go to next article: Log Analyzer main window