createJAXWSHandler command

Use the createJAXWSHandler command to create a new Java API for XML-based Web Services (JAX-WS) handler configuration so that the handler can be used, as part of a handler list, with Version 7.0 WS-Notification services.

We can create a new JAX-WS handler configuration by as described in this topic, or using the administrative console as described in Create a new JAX-WS handler configuration.

This task assumes that we have already created the handler. We can do this by using IBM Rational Application Developer or a similar tool. We must also make the handler class available to the server or cluster that hosts the WS-Notification service points (for inbound invocation handling) or WS-Notification services (for outbound invocation handling) to monitor, as detailed in Loading JAX-WS handler classes.

To run the command, use the AdminTask object of the wsadmin scripting client.

The wsadmin scripting client is run from Qshell. For more information, see Configure Qshell to run WebSphere scripts .

Command-line help is provided for service integration bus commands:

• For a list of the available WS-Notification commands, plus a brief description of each command, enter the following command at the wsadmin prompt:

  print AdminTask.help('WSNotificationCommands')

• For overview help on a given command, enter the following command at the wsadmin prompt:

  print AdminTask.help('command_name')

After using the command, save the changes to the master configuration using the following command:

AdminConfig.save()

Purpose

A Java API for XML-based Web Services (JAX-WS) handler is a Java class that performs a range of handling tasks. For example: logging messages, or transforming their contents, or terminating an incoming request. This command creates a new JAX-WS handler configuration so that the handler can be used, as part of a handler list, with Version 7.0 WS-Notification services.

The configuration object associates a unique name (the name parameter) with a Java class (the className parameter) that refers to the JAX-WS handler implementation.

Target Object

A cell scope object.

Required parameters

-name

The name of the JAX-WS handler configuration object.

This name must be unique at cell scope, and it must obey the following syntax rules:

• It must not start with "." (a period).

• It must not start or end with a space.

• It must not contain any of the following characters: \ / , # $ @ : ; " * ? < > | = + & % '

-className

The name of the JAX-WS handler class that this configuration object represents. This name must be a fully qualified java class name. For example com.ibm.jaxws.handler.TestHandler.

We can configure multiple instances of a handler by creating each instance with a different handler name, and pointing to the same handler class.

Conditional parameters

None.

Optional parameters

-description

A description of the JAX-WS handler.

Example

Create the configuration for a particular JAX-WS handler class:

• Jython:

  targetCell = AdminConfig.list('Cell')
  JAXWSHandler = AdminTask.createJAXWSHandler(targetCell,  ["-name", "handler1", "-className", "handlerClass", "-description", "desc"])

• Jacl:
  $AdminTask createJAXWSHandler targetCell {-name handler1 -className handlerClass -description desc}

Related concepts

WS-Notification

Related tasks

Use WS-Notification for publish and subscribe messaging for web services

Secure WS-Notification

Loading JAX-WS handler classes

Create a new JAX-WS handler configuration

WS-Notification troubleshooting tips

Related information:

JAX-WS Handlers [Collection]

JAX-WS Handlers [Settings] Reference topic