- java.lang.Object
-
- javax.xml.rpc.handler.GenericHandler
-
- All Implemented Interfaces:
- Handler
public abstract class GenericHandler extends Object implements Handler
Thejavax.xml.rpc.handler.GenericHandler
class implements theHandler
interface. SOAP Message Handler developers should typically subclassGenericHandler
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 methodsinit
anddestroy
and also different handle methods. A Handler developer should only override methods that it needs to specialize as part of the derivedHandler
implementation class.- Version:
- 1.0
- Author:
- Rahul Sharma
-
-
Constructor Summary
Constructors Modifier Constructor and Description protected
GenericHandler()
Default constructor
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method and Description void
destroy()
Thedestroy
method indicates the end of lifecycle for a Handler instance.abstract QName[]
getHeaders()
Gets the header blocks processed by this Handler instance.boolean
handleFault(MessageContext context)
ThehandleFault
method processes the SOAP faults based on the SOAP message processing model.boolean
handleRequest(MessageContext context)
ThehandleRequest
method processes the request SOAP message.boolean
handleResponse(MessageContext context)
ThehandleResponse
method processes the response message.void
init(HandlerInfo config)
Theinit
method to enable the Handler instance to initialize itself.
-
-
-
Method Detail
-
handleRequest
public boolean handleRequest(MessageContext context)
ThehandleRequest
method processes the request SOAP message. The default implementation of this method returnstrue
. 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.- Specified by:
handleRequest
in interfaceHandler
- Parameters:
context
-MessageContext
parameter provides access to the request message.- Returns:
- boolean Indicates the processing mode
- Return
true
to indicate continued processing of the request handler chain. TheHandlerChain
takes the responsibility of invoking the next entity. The next entity may be the next handler in theHandlerChain
or if this handler is the last handler in the chain, the next entity is the service endpoint object. - Return
false
to indicate blocking of the request handler chain. In this case, further processing of the request handler chain is blocked and the target service endpoint is not dispatched. The JAX-RPC runtime system takes the responsibility of invoking the response handler chain next with the SOAPMessageContext. The Handler implementation class has the the responsibility of setting the appropriate response SOAP message in either handleRequest and/or handleResponse method. In the default processing model, the response handler chain starts processing from the same Handler instance (that returned false) and goes backward in the execution sequence.
- Return
- See Also:
Handler.handleRequest(javax.xml.rpc.handler.MessageContext)
-
handleResponse
public boolean handleResponse(MessageContext context)
ThehandleResponse
method processes the response message. The default implementation of this method returnstrue
. 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.- Specified by:
handleResponse
in interfaceHandler
- Parameters:
context
- MessageContext parameter provides access to the response SOAP message- Returns:
- boolean Indicates the processing mode
- Return
true
to indicate continued processing ofthe response handler chain. The HandlerChain invokes thehandleResponse
method on the nextHandler
in the handler chain. - Return
false
to indicate blocking of the response handler chain. In this case, no other response handlers in the handler chain are invoked.
- Return
- See Also:
Handler.handleResponse(javax.xml.rpc.handler.MessageContext)
-
handleFault
public boolean handleFault(MessageContext context)
ThehandleFault
method processes the SOAP faults based on the SOAP message processing model. The default implementation of this method returnstrue
. 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.- Specified by:
handleFault
in interfaceHandler
- Parameters:
context
- MessageContext parameter provides access to the SOAP message- Returns:
- boolean Indicates the processing mode
- Return
true
to indicate continued processing of SOAP Fault. The HandlerChain invokes thehandleFault
method on the nextHandler
in the handler chain. - Return
false
to indicate end of the SOAP fault processing. In this case, no other handlers in the handler chain are invoked.
- Return
- See Also:
Handler.handleFault(javax.xml.rpc.handler.MessageContext)
-
init
public void init(HandlerInfo config)
Theinit
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.- Specified by:
init
in interfaceHandler
- Parameters:
config
- Configuration for the initialization of this handler- See Also:
Handler.init(javax.xml.rpc.handler.HandlerInfo)
-
destroy
public void destroy()
Thedestroy
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.- Specified by:
destroy
in interfaceHandler
- See Also:
Handler.destroy()
-
getHeaders
public abstract QName[] getHeaders()
Gets the header blocks processed by this Handler instance.- Specified by:
getHeaders
in interfaceHandler
- Returns:
- Array of QNames of header blocks processed by this
handler instance.
QName
is the qualified name of the outermost element of the Header block.
-
-
Traduction non disponible
Les API Java ne sont pas encore traduites en français sur l'infobrol. Seule la version anglaise est disponible pour l'instant.
Version en cache
21/08/2025 20:49:21 Cette version de la page est en cache (à la date du 21/08/2025 20:49:21) afin d'accélérer le traitement.Vous pouvez activer le mode utilisateur dans le menu en haut pour afficher la version plus récente de la page.
Document créé le 18/04/2008, dernière modification le 18/08/2025
Source du document imprimé : https://www.gaudry.be/java-api-javaee-rf-javax/xml/rpc/handler/generichandler.html
L'infobrol est un site personnel dont le contenu n'engage que moi. Le texte est mis à disposition sous licence CreativeCommons(BY-NC-SA). Plus d'info sur les conditions d'utilisation et sur l'auteur.
Références
Ces références et liens indiquent des documents consultés lors de la rédaction de cette page, ou qui peuvent apporter un complément d'information, mais les auteurs de ces sources ne peuvent être tenus responsables du contenu de cette page.
L'auteur de ce site est seul responsable de la manière dont sont présentés ici les différents concepts, et des libertés qui sont prises avec les ouvrages de référence. N'oubliez pas que vous devez croiser les informations de sources multiples afin de diminuer les risques d'erreurs.