org.jboss.ws.api.handler

Class GenericHandler<C extends MessageContext>

java.lang.Object

org.jboss.ws.api.handler.GenericHandler<C>

All Implemented Interfaces:

Handler<C>

Direct Known Subclasses:

GenericLogicalHandler, GenericSOAPHandler

public abstract class GenericHandler<C extends MessageContext>
extends Object
implements Handler<C>

A generic JAX-WS handler

Since:

13-Aug-2006

Author:

Thomas Diesler, Alessio Soldano

Constructor Summary

Constructors

Constructor and Description
GenericHandler()

Method Summary

Modifier and Type	Method and Description
void	close(MessageContext messageContext) Called at the conclusion of a message exchange pattern just prior to the JAX-WS runtime disptaching a message, fault or exception.
String	getHandlerName()
boolean	handleFault(C messagecontext) The handleFault method is invoked for fault message processing.
protected boolean	handleInbound(C msgContext)
boolean	handleMessage(C msgContext) The handleMessage method is invoked for normal processing of inbound and outbound messages.
protected boolean	handleOutbound(C msgContext)
void	setHandlerName(String handlerName)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

GenericHandler

public GenericHandler()

Method Detail

getHandlerName

public String getHandlerName()

setHandlerName

public void setHandlerName(String handlerName)

handleMessage

public boolean handleMessage(C msgContext)

Description copied from interface: Handler

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.

Specified by:

handleMessage in interface Handler<C extends MessageContext>

Parameters:

msgContext - the message context.

Returns:

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

• Return true to continue processing.
• Return false to block processing.

handleOutbound

protected boolean handleOutbound(C msgContext)

handleInbound

protected boolean handleInbound(C msgContext)

handleFault

public boolean handleFault(C messagecontext)

Description copied from interface: Handler

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.

Specified by:

handleFault in interface Handler<C extends MessageContext>

Parameters:

messagecontext - the message context

Returns:

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

• Return true to continue processing.
• Return false to block processing.

close

public void close(MessageContext messageContext)

Description copied from interface: Handler

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

Specified by:

close in interface Handler<C extends MessageContext>

Parameters:

messageContext - the message context

toString

public String toString()

Overrides:

toString in class Object