javax.xml.rpc.handler: abstract public class: GenericHandler

javax.xml.rpc.handler
abstract public class: GenericHandler [javadoc | source]

java.lang.Object
   javax.xml.rpc.handler.GenericHandler

All Implemented Interfaces:
Handler

The GenericHandler class implements the Handler interface. SOAP Message Handler developers should typically subclass GenericHandler class unless the Handler class needs another class as a superclass. The GenericHandler class is a convenience abstract class that makes writing Handlers easy. This class provides default implementations of the lifecycle methods init and destroy and also different handle methods. A Handler developer should only override methods that it needs to specialize as part of the derived Handler implementation class.

author: Scott.Stark - @jboss.org

author: Rahul - Sharma (javadoc)

Constructor:
protected GenericHandler() { } Default constructor.

Constructor:

 protected GenericHandler() {

}

Default constructor.

Method from javax.xml.rpc.handler.GenericHandler Summary:
destroy, getHeaders, handleFault, handleRequest, handleResponse, init

Methods from java.lang.Object:
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from javax.xml.rpc.handler.GenericHandler Detail:
public void destroy() { } The destroy method indicates the end of lifecycle for a Handler instance. This method should be overridden if the derived Handler class needs to specialize implementation of this method.
abstract public QName[] getHeaders() Gets the header blocks processed by this Handler instance.
public boolean handleFault(MessageContext msgContext) { return true; } The handleFault method processes the SOAP faults based on the SOAP message processing model. The default implementation of this method returns true. This indicates that the handler chain should continue processing of the SOAP fault. This method should be overridden if the derived Handler class needs to specialize implementation of this method.
public boolean handleRequest(MessageContext msgContext) { return true; } The handleRequest method processes the request SOAP message. The default implementation of this method returns true. This indicates that the handler chain should continue processing of the request SOAP message. This method should be overridden if the derived Handler class needs to specialize implementation of this method.
public boolean handleResponse(MessageContext msgContext) { return true; } The handleResponse method processes the response message. The default implementation of this method returns true. This indicates that the handler chain should continue processing of the response SOAP message. This method should be overridden if the derived Handler class needs to specialize implementation of this method.
public void init(HandlerInfo config) { } The init method to enable the Handler instance to initialize itself. This method should be overridden if the derived Handler class needs to specialize implementation of this method.

Method from javax.xml.rpc.handler.GenericHandler Detail:

 public  void destroy() {

}

The destroy method indicates the end of lifecycle for a Handler instance. This method should be overridden if the derived Handler class needs to specialize implementation of this method.

 abstract public QName[] getHeaders()Gets the header blocks processed by this Handler instance.

 public boolean handleFault(MessageContext msgContext) {
      return true;
}

The handleFault method processes the SOAP faults based on the SOAP message processing model. The default implementation of this method returns true. This indicates that the handler chain should continue processing of the SOAP fault. This method should be overridden if the derived Handler class needs to specialize implementation of this method.

 public boolean handleRequest(MessageContext msgContext) {
      return true;
}

The handleRequest method processes the request SOAP message. The default implementation of this method returns true. This indicates that the handler chain should continue processing of the request SOAP message. This method should be overridden if the derived Handler class needs to specialize implementation of this method.

 public boolean handleResponse(MessageContext msgContext) {
      return true;
}

The handleResponse method processes the response message. The default implementation of this method returns true. This indicates that the handler chain should continue processing of the response SOAP message. This method should be overridden if the derived Handler class needs to specialize implementation of this method.

 public  void init(HandlerInfo config) {

}

The init method to enable the Handler instance to initialize itself. This method should be overridden if the derived Handler class needs to specialize implementation of this method.