Top Description Methods
javax.xml.ws.handler

public Interface Handler<C extends javax.xml.ws.handler.MessageContext>

Known Direct Subinterfaces
javax.xml.ws.handler.LogicalHandler, javax.xml.ws.handler.soap.SOAPHandler
Type Parameters
<C>
message context
Imports
javax.xml.ws.ProtocolException
The Handler interface is the base interface for JAX-WS handlers.
Since
1.6, JAX-WS 2.0

Method Summary

Modifier and TypeMethod and Description
public void
close(MessageContext
the message context
context)

Called at the conclusion of a message exchange pattern just prior to the JAX-WS runtime dispatching a message, fault or exception.

public boolean

Returns:

An indication of whether handler fault processing should continue for the current message
  • Return true to continue processing.
  • Return false to block processing.
handleFault(C
the message context
context)

The handleFault method is invoked for fault message processing.

public boolean

Returns:

An indication of whether handler processing should continue for the current message
  • Return true to continue processing.
  • Return false to block processing.
handleMessage(C
the message context.
context)

The handleMessage method is invoked for normal processing of inbound and outbound messages.

Method Detail

closeback to summary
public void close(MessageContext context)

Called at the conclusion of a message exchange pattern just prior to the JAX-WS runtime dispatching a message, fault or exception. Refer to the description of the handler framework in the JAX-WS specification for full details.

Parameters
context:MessageContext

the message context

handleFaultback to summary
public boolean handleFault(C context)

The handleFault method is invoked for fault message processing. Refer to the description of the handler framework in the JAX-WS specification for full details.

Parameters
context:C

the message context

Returns:boolean

An indication of whether handler fault processing should continue for the current message

  • Return true to continue processing.
  • Return false to block processing.
Exceptions
RuntimeException:
Causes the JAX-WS runtime to cease handler fault processing and dispatch the fault.
ProtocolException:
Causes the JAX-WS runtime to cease handler fault processing and dispatch the fault.
handleMessageback to summary
public boolean handleMessage(C context)

The handleMessage method is invoked for normal processing of inbound and outbound messages. Refer to the description of the handler framework in the JAX-WS specification for full details.

Parameters
context:C

the message context.

Returns:boolean

An indication of whether handler processing should continue for the current message

  • Return true to continue processing.
  • Return false to block processing.
Exceptions
RuntimeException:
Causes the JAX-WS runtime to cease handler processing and generate a fault.
ProtocolException:
Causes the JAX-WS runtime to switch to fault message processing.