+

Search Tips   |   Advanced Search

endptEnabler command


The endptEnabler command is used to enable a set of Web services within an EAR file. The endptEnabler command must run on EAR files containing EJB modules that are enabled for Web services.

Each router module provides a Web service endpoint for a particular transport. For example, we can add a HTTP router module so that the Web service can receive requests over the HTTP transport. Or, we can add a JMS router module so that the Web service can receive requests from a JMS queue or topic.

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

 

endptEnabler usage syntax

Invoke the endptEnabler command from the WAS bin directory. The command syntax is presented in the following example:

endptEnabler          
    [-verbose|-v]          
    [-quiet|-q]          
    [-help|-h|-?]          
    [-properties|-p properties-filename]
    [-transport|-t default-transports]
    [-enableHttpRouterSecurity]
    [ear-filename]

All parameters are optional and described in the following list:

 

endptEnabler properties

With the endptEnabler command we can control its run-time behavior by specifying a set of properties with the -properties command-line option. These properties are organized in one of two ways: 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


Table 1. Global properties for the endptEnabler command

Property name Description Default value
verbose Displays detailed progress messages. False
quiet Displays only brief progress messages. False
http.enableRouter Security Enables you to add a security policy for all authenticated users to protect the HTTP router module if all the EJB modules are secured in the enterprise bean JAR file. False
http.router ModuleNameSuffix Suffix used to construct default HTTP router module names. The .war extension is added by the endptEnabler command. _HTTPRouter
jms.routerModule NameSuffix Suffix used to construct default JMS router module names. The .jar extension is added by the endptEnabler command. _JMSRouter
jms.default DestinationType Default destination type to use for all JMS router modules that are added to the EAR file.

This type is either queue or topic.

queue
defaultTransports Default list of transports for which router modules are 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

The following table describes the per-module properties supported by the endptEnabler command.

The ejbJarName variable refers to the name of an enterprise bean JAR module within the EAR file, without the .jar extension.


Table 2. Per-module properties for the endptEnabler command

Property name Description Default value

<ejbJarName> .transports
Lists the transports for which router modules are created for a particular enterprise bean JAR file. The list can contain the values http andjms. Multiple values are separated by a comma. Examples are: http, jms and http,jms. http

<ejbJarName>.http.skip
Flag which bypasses the addition of an HTTP router module, even if it otherwise is added based on other properties. Valid values are true and false. false

<ejbJarName> 
.http.routerModuleName
Name of the HTTP router module for a particular enterprise bean JAR file. ejbJarName_HTTPRouter

<ejbJarName> .http.contextRoot
Context root associated with the HTTP router module for a particular enterprise bean JAR file. /ejbJarName

<ejbJarName>.jms.skip
Flag that bypasses the addition of an JMS router module even if it otherwise is added based on other properties. Valid values are true and false. false

<ejbJarName>.jms. routerModuleName
Name of the JMS router module for a particular enterprise bean JAR file. ejbJarName_JMSRouter

<ejbJarName>.jms. activationSpecJndiName
JNDI name of the activation specification configured for the Message Driven Bean (MDB) within the JMS router module. null

<ejbJarName>.jms. listenerInputPortName
Name of the listener port to configure for the MDB within the JMS router module. The listener port is configured only if an activationSpecJndiName property is not specified. null

<ejbJarName>.jms.destinationType
JMS destination type associated with the MDB within the JMS router. Valid values are queue and topic. queue

<ejbJarName>.<port_local_name>
.http.urlPattern=
<url_pattern_name>
Specifies the URL pattern for ports. If we have EJB module with the indicated name that has a port with the indicated local name, we can specify the HTTP URL pattern with this property. This property only applies to HTTP router modules. It has no affect on JMS router modules. null

Properties example

Suppose an EAR file contains an enterprise bean JAR file named, StockQuoteEJB.jar that contains Web services.

The following set of properties can be used to control the endptEnabler command run-time 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.destinationType=queue

endptEnabler examples

The following commands are examples of how the endptEnabler command 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

endptEnabler -v -t http,jms




 

Related tasks


Enable an EAR file for EJB modules that contain Web services
Assembling Web services applications