1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
|
/*
* JBoss, Home of Professional Open Source
* Copyright 2005, JBoss Inc., and individual contributors as indicated
* by the @authors tag. See the copyright.txt in the distribution for a
* full listing of individual contributors.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package javax.xml.rpc.handler;
import javax.xml.namespace.QName;
/** 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)
* @version $Revision: 2897 $
*/
public abstract class GenericHandler implements Handler
{
/** Default constructor. */
protected GenericHandler()
{
}
/**
* 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();
/**
* 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.
* @param config handler configuration
*/
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.
*/
public void destroy()
{
}
/**
* 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.
* @param msgContext the message msgContext
* @return true/false
*/
public boolean handleRequest(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.
* @param msgContext the message msgContext
* @return true/false
*/
public boolean handleResponse(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.
* @param msgContext the message msgContext
* @return the message msgContext
*/
public boolean handleFault(MessageContext msgContext)
{
return true;
}
}
|
