Commande endptEnabler
La commande endptEnabler permet d'activer un ensemble de services Web dans un fichier EAR (enterprise archive). La commande endptEnabler doit être exécutée sur des fichiers EAR qui contiennent des modules EJB (JavaBeans) et qui sont activés pour les services web.
Chaque module de routeur fournit un noeud final de service Web pour un transport particulier. Par exemple, vous pouvez ajouter un module de routeur HTTP afin de permettre au service web de recevoir des demandes par transport HTTP. Vous pouvez aussi ajouter un module de routeur JMS (Java™ Message Service) afin de permettre au service web de recevoir des demandes émanant d'une file d'attente ou d'une rubrique JMS.
Dans son mode interactif, la commande endptEnabler vous guide à travers les étapes requises permettant d'activer un ou plusieurs services dans une application. La commande endptEnabler effectue une copie de sauvegarde du fichier EAR d'origine au cas où vous auriez besoin de supprimer ou d'ajouter des services ultérieurement. Si votre fichier EAR contient un fichier JAR (Java archive) de bean enterprise activé pour des services web, vous devez exécuter la commande endptEnabler avant que le fichier EAR ne soit déployé. Sinon, il n'est pas nécessaire d'exécuter la commande.

Syntaxe de endptEnabler
endptEnabler
[-verbose|-v]
[-quiet|-q]
[-help|-h|-?]
[-properties|-p properties-filename]
[-transport|-t default-transports]
[-enableHttpRouterSecurity]
[-enableClientCertSecurity]
[ear-filename]
[-classpath|-cp]
- -verbose, -v
- Ce paramètre affiche des messages de progression détaillés à mesure que l'outil endptEnabler traite le fichier EAR. Cette option de ligne de commande est mappée vers la propriété commune verbose.
- -quiet, -q
- Ce paramètre empêche l'affichage de messages de progression par module à mesure que l'outil endptEnabler traite le fichier EAR. Cette option de ligne de commande est mappée vers la propriété commune quiet.
- -help, -h, -?
- Ce paramètre affiche un bref message d'aide, expliquant les diverses options.
- -properties, -p <propriétés-nomfichier>
- Ce paramètre lit les propriétés définies dans le fichier propriétés-nomfichier et contrôle le comportement de l'outil endptEnabler.
- -transport, -t <default-transports>
- Ce paramètre indique la liste de transports
par défaut pour lesquels des modules de routeur sont créés pour chaque fichier JAR d'EJB contenu dans le fichier EAR. Cette option de ligne de commande est mappée vers la propriété commune defaultTransports. Exemples de ce paramètre :
-transport http (the default) -transport jms -t http,jms
- -enableHttpRouterSecurity
- Ce paramètre vous permet d'ajouter une stratégie de sécurité pour tous les utilisateurs authentifiés afin de protéger le module de routeur HTTP si tous les modules EJB sont sécurisés dans le fichier JAR de bean enterprise. Cette option de ligne de commande est mappée vers la propriété commune http.enableRouterSecurity.
- -enableClientCertSecurity
- Ce paramètre permet d'ajouter la section login-config suivante au fichier
web.xml pour l'authentification de certificat, à la place
de basic-auth ou de form-login. Cette option de ligne de commande
est mappée vers la propriété commune http.enableClientCertSecurity.
<login-config> <auth-method>CLIENT-CERT</auth-method> </login-config>
Pratiques recommandées: Utilisez le paramètre -enableClientCertSecurity avec le paramètre -enableHttpRouterSecurity.bprac
- <nomfichier-ear>
- Ce paramètre indique le nom du fichier EAR à traiter.
Si le paramètre nomfichier-ear n'est pas entré sur la ligne de commande, le mode interactif est utilisé. En mode interactif, le système vous invite à saisir le nom du fichier EAR, les noms de modules de routeur et d'autres valeurs importantes lors du traitement. L'exemple suivant illustre le mode interactif de l'outil endptEnabler.
Dans cette boîte de dialogue, les données saisies par l'utilisateur sont en police à largeur fixe tandis que les messages de l'outil sont en gras.
endptEnabler<enter> WSWS2004I: IBM WebSphere Application Server Release 5 WSWS2005I: Web Services Enterprise Archive Endpoint Enabler Tool. WSWS2007I: (C) COPYRIGHT International Business Machines Corp. 1997, 2003 WSWS2006I: Please enter the name of your EAR file: AddressBook.ear<enter> WSWS2003I: Backing up EAR file to: AddressBook.ear~ WSWS2016I: Loading EAR file: AddressBook.ear WSWS2017I: Found EJB Module: AddressBookEJB.jar WSWS2029I: Enter http router name for EJB Module AddressBookEJB [AddressBookEJB_HTTPRouter.war]:<enter> WSWS2030I: Enter http context root for EJB Module AddressBookEJB [/AddressBookEJB]:<enter> WSWS2024I: Adding http router for EJB Module AddressBookEJB.jar. WSWS2036I: Saving EAR file AddressBook.ear... WSWS2037I: Finished saving the EAR file. WSWS2018I: Finished processing EAR file AddressBook.ear.
Si le paramètre nomfichier-ear est entré sur la ligne de commande, le mode non interactif est utilisé. Dans ce mode, les noms de modules de routeur et d'autres valeurs importantes sont déterminées à partir des propriétés spécifiées par l'utilisateur ou des valeurs par défaut.
- -classpath, -cp
- Ce paramètre vous permet de spécifier des fichiers JAR distincts dans le chemin d'accès aux classes de la commande endptEnabler. Utilisez-le si le fichier EJB référence des types Java dans des fichiers JAR distincts qui n'existent pas dans le fichier EAR. Plusieurs valeurs peuvent être définies pour ce paramètre. Exemple :
endptEnabler -classpath C:\MyWork\Utility.jar;D:\SharedFiles\Hello.zip;HelloWorld.jar
Si vous ne définissez pas ce paramètre, un message d'erreur similaire au message suivant peut être émis.
WSWS2021I: Skipping the enterprise bean module module_name because it contains no web services.
Propriétés endptEnabler
La commande endptEnabler permet de contrôler son comportement d'exécution en spécifiant un ensemble de propriétés à l'aide de l'option de ligne de commande -properties. Ces propriétés sont organisées de façon globale ou au niveau de chaque module. Les propriétés communes affectent le comportement général de l'outil alors qu'il traite plusieurs modules JAR de bean enterprise dans le fichier EAR. Les propriétés par module affectent le traitement d'un module JAR de bean enterprise spécifique.
Nom de la propriété | Description | Valeur par défaut |
---|---|---|
verbose | Affiche des messages de progression détaillés. | False |
quiet | Affiche de bref messages de progression. | False |
http.enableRouterSecurity | Permet d'ajouter une stratégie de sécurité pour tous les utilisateurs authentifiés afin de protéger le module de routeur HTTP si tous les modules EJB sont sécurisés dans le fichier JAR de bean enterprise. | False |
http.enableClientCertSecurity | Ce paramètre permet d'ajouter la section login-config suivante au fichier
web.xml pour l'authentification de certificat, à la place
de basic-auth ou de form-login :
|
False |
http.routerModuleNameSuffix | Indique le suffixe utilisé pour construire les noms de modules de routeur HTTP par défaut. L'extension .war est ajoutée par la commande endptEnabler. | _HTTPRouter |
jms.routerModuleNameSuffix | Indique le suffixe utilisé pour construire les noms de modules de routeur JMS par défaut. L'extension .jar est ajoutée par la commande endptEnabler. | _JMSRouter |
jms.defaultDestinationType | Spécifie le type de destination par défaut à utiliser pour tous les modules de routeur JMS ajoutés au fichier EAR. Il s'agit d'une file d'attente ou d'une rubrique. | file d'attente |
defaultTransports | Indique la liste de transports par défaut pour lesquels des modules de routeur sont créés. La liste peut comporter les valeurs http et jms. Les valeurs multiples sont séparées par une virgule. Par exemple : http, jms et http,jms. | http |
Le tableau suivant décrit les propriétés par module prises en charge par la commande endptEnabler. La variable ejbJarName fait référence au nom d'un module JAR de bean enterprise dans le fichier EAR sans l'extension .jar.
Nom de la propriété | Description | Valeur par défaut |
---|---|---|
|
Dresse la liste des transports pour lesquels des modules de routeur sont créés pour un fichier JAR de bean enterprise. La liste peut comporter les valeurs http et jms. Les valeurs multiples sont séparées par une virgule. Par exemple : http, jms et http,jms. | http |
|
Spécifie l'indicateur qui omet l'ajout d'un module de routeur HTTP, même s'il est ajouté en fonction d'autres propriétés. Les valeurs autorisées sont true et false. | false |
|
Indique le nom du module de routeur HTTP pour un fichier JAR de bean enterprise spécifique. | nom du JAR EJB_HTTPRouter |
|
Indique la racine de contexte associée au module de routeur HTTP pour un fichier JAR de bean enterprise spécifique. | /nom du JAR EJB |
|
Spécifie l'indicateur qui omet l'ajout d'un module de routeur JMS, même s'il est ajouté en fonction d'autres propriétés. Les valeurs autorisées sont true et false. | false |
|
Indique le nom du module de routeur JMS pour un fichier JAR de bean enterprise spécifique. | nom du JAR EJB_JMSRouter |
|
Indique le nom JNDI (Java Naming and Directory Interface) de la spécification d'activation qui est configurée pour le bean MDB (Message Driven Bean) dans le module de routeur JMS. | NULL |
|
Indique le nom du port d'écoute à configurer pour le bean MDB dans le module de routeur JMS. Le port d'écoute est configuré uniquement si aucune propriété activationSpecJndiName n'est spécifiée. | NULL |
|
Indique le type de destination JMS associée au bean MDB dans le routeur JMS. Les valeurs admises sont queue et topic. | file d'attente |
|
Indique le modèle URL pour les ports. Si un modèle EJB avec le nom indiqué a un port portant le nom local indiqué, vous pouvez spécifier le modèle URL HTTP avec cette propriété. Cette propriété ne s'applique qu'aux modules du routeur HTTP. Cela est sans effet sur les modules du routeur JMS. | NULL |
Exemple de propriétés
StockQuoteEJB.transports=http,jms
StockQuoteEJB.http.routerModuleName=StockQuoteEJB_HTTP
StockQuoteEJB.http.contextRoot=/StockQuote
StockQuoteEJB.jms.routerModuleName=StockQuoteEJB_JMS
StockQuoteEJB.jms.destinationType=queue
Exemples endptEnabler
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