The endptEnabler script

The endptEnabler enables a set of Web services within an enterprise archive (EAR) file. You can add one or more router modules to the EAR file that include a Web service-enabled enterprise bean JAR file.

Each router module provides a Web service endpoint for a particular transport. For example, an HTTP router module can be added so that the Web service can receive requests over the HTTP transport, and a Java Messaging Service (JMS) router module can be added so that the Web service can receive requests from a JMS queue or topic.

In its interactive mode, the endptEnabler guides you through the required steps to enable one or more services within an application. The endptEnabler tool makes a backup copy of your original EAR file in the event that you need to remove or add services at a later time. If your EAR file contains a Web service-enabled enterprise bean JAR file, run endptEnabler before the EAR file is deployed. Otherwise, you do not need to run endptEnabler.

Product

This script is available in WAS and WAS Network Deployment.

Authority

To run this script, your user profile must have *RX authority.

Syntax

The syntax of the script is:

endptEnabler [ ear-filename ] [ -properties | -p properties-filename ]
  [ -transport | -t default-transports ] [ -enableHttpRouterSecurity ]
  [ -CCtrace trace-string ] [ -CCtracefile trace-filename ]
  [ -CCtraceoutput ] [ -CChelp ] [ -verbose | -v ] [ -quiet | -q ] [ -help | -h | -? ]

Parameters

The parameters of the script are:

• ear-filename
  Optional. The value ear-filename specifies the name of the EAR file to be processed. If you do not specify the ear-filename parameter, the script runs in interactive mode. The script prompts you for the EAR file name, router module names and other required values while it runs. If the ear-filename parameter is specified, the script runs in non-interactive mode. In non-interactive mode, router module names and other important values are determined from user-specified properties or default values.

• -properties or -p
  Optional. The value properties-filename specifies the properties file that controls the behavior of the endptEnabler script.

• -transport or -t
  Optional. The value default-transports specifies the default list of transports for which router modules should be created for each enterprise bean JAR file contained in the EAR file. This command-line option is mapped to the defaultTransports global property. Valid values are http and jms. If you specify both types, separate them with a comma.

• -enableHttpRouterSecurity
  Optional. If all of the enterprise beans in the enterprise bean JAR file are secured, you can specify this parameter to add a security policy for all authenticated users to protect the HTTP router module. This command-line option is mapped to the http.enableRouterSecurity global property.

• -CCtrace
  Optional. The value trace-string specifies the trace setting for the script. For example, to log all trace data, specify com.ibm.ws.websphere.*=all=enabled.

• -CCtracefile
  Optional. The value trace-filename specifies the file to which the script writes trace data.

• -CCtraceoutput
  Optional. If you specify this parameter, trace data is logged to the standard output stream.

• -CChelp
  This optional parameter displays the help text for the trace options.

• -verbose or -v
  Optional. If you specify this parameter, the script displays detailed progress messages as it processes the EAR file. This command-line option is mapped to the verbose global property.

• -quiet or -q
  Optional. If you specify this parameter, the script does not display per-module progress messages as it processes the EAR file. This command-line option is mapped to the quiet global property.

• -help, -h, or -?
  This optional parameter displays a brief help message that explains the script parameters.

endptEnabler properties

Use the -properties parameter to specify a set of properties that control the script's run time behavior. These properties fall into two categories: global and per-module. Global properties affect the overall behavior of the tool as it processes multiple enterprise bean JAR modules within the EAR file. Per-module properties affect the processing of a particular enterprise bean JAR module.

Global properties

This table describes the global properties supported by endptEnabler:

Property name	Description	Default value
verbose	Displays detailed progress messages.	False
quiet	Displays only brief progress messages.	False
http.enableRouterSecurity	Enables you to add a security policy for all authenticated users to protect the HTTP router module if all the EJB's are secured in the enterprise bean JAR file.	False
http.routerModuleNameSuffix	Specifies the suffix used to construct default HTTP router module names. The .war extension is added by endptEnabler.	_HTTPRouter
jms.routerModuleNameSuffix	Specifies the suffix used to construct default JMS router module names. The .jar extension is added by endptEnabler.	_JMSRouter
jms.listenerInputPortNameSuffix	Specifies the suffix used to construct default Listener Input Port names.	_ListenerPort
jms.defaultDestinationType	Specifies the default destination type to use for all JMS router modules added to the EAR file. This should be either queue or topic.	queue
defaultTransports	Specifies the default list of transports for which router modules should be created. The list can contain the values http and jms. Multiple values are separated by a comma. Examples are: http, jms and http,jms.	http

Per-module properties

This table describes the per-module properties supported by the endptEnabler. ejbJarName refers to the name of an enterprise JAR module within the EAR file, without the .jar extension.

Property name	Description	Default value
ejbJarName.transports	Lists the transports for which router modules should be created for a particular enterprise bean JAR file. The list can contain the values http and jms. Multiple values are separated by a comma. Examples are: http, jms and http,jms.	http
ejbJarName.http.skip	Specifies the flag which bypasses the addition of an HTTP router module even if it would otherwise be added (based on other properties). Valid values are true and false.	false
ejbJarName.http.routerModuleName	Specifies the name of the HTTP router module for a particular enterprise bean JAR file.	ejbJarName_HTTPRouter
ejbJarName.http.contextRoot	Specifies the context root associated with the HTTP router module for a particular enterprise bean JAR file.	ejbJarName
ejbJarName.jms.skip	Specifies the Flag which bypasses the addition of an HTTP router module even if it would otherwise be added (based on other properties). Valid values are true and false.	false
ejbJarName.jms.routerModuleName	Specifies the name of the JMS router module for a particular enterprise bean JAR file.	ejbJarName_JMSRouter
ejbJarName.jms.listenerInputPortName	Specifies the name of the Listener Input Port to be associated with the JMS router module.	ejbJarName_ListenerPort
ejbJarName.ejbJarName.jms. destinationType	Specifies the JMS destination type associated with the JMS router. Valid values are queue and topic.	queue

Properties example

Suppose an EAR file contains an enterprise bean JAR file named, StockQuoteEJB.jar that contains Web services. The following set of properties might be used to control the endptEnabler runtime behavior as it processes the EAR file:

StockQuoteEJB.transports=http,jms
StockQuoteEJB.http.routerModuleName=StockQuoteEJB_HTTP
StockQuoteEJB.http.contextRoot=/StockQuote
StockQuoteEJB.jms.routerModuleName=StockQuoteEJB_JMS
StockQuoteEJB.jms.listenerInputPortName=StockQuote_LP
StockQuoteEJB.jms.destinationType=queue

Examples

The following commands are examples of how the endptEnabler can be used:

endptEnabler MyApp.ear

endptEnabler -t jms,http MyApp.ear

endptEnabler -v -properties MyApp.props MyApp.ear

endptEnabler -q -t jms MyApp.ear