javax.xml.rpc.handler.GenericHandler Maven / Gradle / Ivy
Show all versions of jakarta.xml.rpc-api Show documentation
/*
* Copyright (c) 2003, 2018 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the
* Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
* version 2 with the GNU Classpath Exception, which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
package javax.xml.rpc.handler;
import javax.xml.rpc.JAXRPCException;
import javax.xml.namespace.QName;
/** The javax.xml.rpc.handler.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.
*
* @version 1.0
* @author Rahul Sharma
**/
public abstract class GenericHandler implements Handler {
/** Default constructor
**/
protected GenericHandler() {}
/** 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.
*
* @see javax.xml.rpc.handler.Handler#handleRequest
**/
public boolean handleRequest(MessageContext context) {
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.
*
* @see javax.xml.rpc.handler.Handler#handleResponse
**/
public boolean handleResponse(MessageContext context) {
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.
*
* @see javax.xml.rpc.handler.Handler#handleFault
**/
public boolean handleFault(MessageContext context) {
return true;
}
/** 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.
*
* @see javax.xml.rpc.handler.Handler#init
**/
public void init(HandlerInfo config) {
}
/** 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.
*
* @see javax.xml.rpc.handler.Handler#destroy
**/
public void destroy() {
}
/** Gets the header blocks processed by this Handler instance.
*
* @return Array of QNames of header blocks processed by this
* handler instance. QName is the qualified
* name of the outermost element of the Header block.
**/
public abstract QName[] getHeaders();
}