Handler


1   /*
2    * The Apache Software License, Version 1.1
3    *
4    *
5    * Copyright (c) 2001-2003 The Apache Software Foundation.  All rights
6    * reserved.
7    *
8    * Redistribution and use in source and binary forms, with or without
9    * modification, are permitted provided that the following conditions
10   * are met:
11   *
12   * 1. Redistributions of source code must retain the above copyright
13   *    notice, this list of conditions and the following disclaimer. 
14   *
15   * 2. Redistributions in binary form must reproduce the above copyright
16   *    notice, this list of conditions and the following disclaimer in
17   *    the documentation and/or other materials provided with the
18   *    distribution.
19   *
20   * 3. The end-user documentation included with the redistribution,
21   *    if any, must include the following acknowledgment:  
22   *       "This product includes software developed by the
23   *        Apache Software Foundation (http://www.apache.org/)."
24   *    Alternately, this acknowledgment may appear in the software itself,
25   *    if and wherever such third-party acknowledgments normally appear.
26   *
27   * 4. The names "Axis" and "Apache Software Foundation" must
28   *    not be used to endorse or promote products derived from this
29   *    software without prior written permission. For written 
30   *    permission, please contact apache@apache.org.
31   *
32   * 5. Products derived from this software may not be called "Apache",
33   *    nor may "Apache" appear in their name, without prior written
34   *    permission of the Apache Software Foundation.
35   *
36   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
37   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
38   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
39   * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
40   * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
42   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
43   * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
44   * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
45   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
46   * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
47   * SUCH DAMAGE.
48   * ====================================================================
49   *
50   * This software consists of voluntary contributions made by many
51   * individuals on behalf of the Apache Software Foundation.  For more
52   * information on the Apache Software Foundation, please see
53   * <http://www.apache.org/>.
54   */
55  
56  package org.jboss.axis;
57  
58  import org.w3c.dom.Document  ;
59  import org.w3c.dom.Element  ;
60  
61  import javax.xml.namespace.QName  ;
62  import java.util.Hashtable  ;
63  import java.util.List  ;
64  
65  /**
66   * @author Doug Davis (dug@us.ibm.com)
67   */
68  public interface Handler
69  {
70     /**
71      * Init is called when the chain containing this Handler object
72      * is instantiated.
73      */
74     public void init();
75  
76     /**
77      * Cleanup is called when the chain containing this Handler object
78      * is done processing the chain.
79      */
80     public void cleanup();
81  
82     /**
83      * Invoke is called to do the actual work of the Handler object.
84      * If there is a fault during the processing of this method it is
85      * invoke's job to catch the exception and undo any partial work
86      * that has been completed.  Once we leave 'invoke' if a fault
87      * is thrown, this classes 'onFault' method will be called.
88      * Invoke should rethrow any exceptions it catches, wrapped in
89      * an AxisFault.
90      */
91     public void invoke(MessageContext msgContext) throws AxisFault;
92  
93     /**
94      * Called when a subsequent handler throws a fault.
95      */
96     public void onFault(MessageContext msgContext);
97  
98     /**
99      * Can this Handler process this QName?
100     */
101    public boolean canHandleBlock(QName   qname);
102 
103    /**
104     * Return a list of QNames which this Handler understands.  By returning
105     * a particular QName here, we are committing to fulfilling any contracts
106     * defined in the specification of the SOAP header with that QName.
107     */
108    public List   getUnderstoodHeaders();
109 
110    /**
111     * Add the given option (name/value) to this handler's bag of options
112     */
113    public void setOption(String   name, Object   value);
114 
115    /**
116     * Returns the option corresponding to the 'name' given
117     */
118    public Object   getOption(String   name);
119 
120    /**
121     * Set the name (i.e. registry key) of this Handler
122     */
123    public void setName(String   name);
124 
125    /**
126     * Return the name (i.e. registry key) for this Handler
127     */
128    public String   getName();
129 
130    /**
131     * Return the entire list of options
132     */
133    public Hashtable   getOptions();
134 
135    /**
136     * Sets a whole list of options
137     */
138    public void setOptions(Hashtable   opts);
139 
140    /**
141     * This will return the root element of an XML doc that describes the
142     * deployment information about this handler.  This is NOT the WSDL,
143     * this is all of the static internal data use by Axis - WSDL takes into
144     * account run-time information (like which service we're talking about)
145     * this is just the data that's stored in the registry.  Used by the
146     * 'list' Admin function.
147     */
148    public Element   getDeploymentData(Document   doc);
149 
150    /**
151     * Obtain WSDL information.  Some Handlers will implement this by
152     * merely setting properties in the MessageContext, others (providers)
153     * will take responsibility for doing the "real work" of generating
154     * WSDL for a given service.
155     */
156    public void generateWSDL(MessageContext msgContext) throws AxisFault;
157 }
158 
159 ;
160
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags