SOAPFactory


1   package org.apache.axis2.soap;
2   
3   import org.apache.axis2.om.OMFactory;
4   import org.apache.axis2.om.OMNamespace;
5   import org.apache.axis2.om.OMXMLParserWrapper;
6   import org.apache.axis2.soap.impl.llom.SOAPProcessingException;
7   
8   
9   /**
10   * Copyright 2001-2004 The Apache Software Foundation.
11   * <p/>
12   * Licensed under the Apache License, Version 2.0 (the "License"); you may not
13   * use this file except in compliance with the License. You may obtain a copy of
14   * the License at
15   * <p/>
16   * http://www.apache.org/licenses/LICENSE-2.0
17   * <p/>
18   * Unless required by applicable law or agreed to in writing, software
19   * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
20   * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
21   * License for the specific language governing permissions and limitations under
22   * the License.
23   * <p/>
24   */
25  public interface SOAPFactory extends OMFactory{
26      /**
27       * Eran Chinthaka (chinthaka@apache.org)
28       */
29  
30      /**
31       * @param builder
32       * @return
33       */
34      public SOAPEnvelope createSOAPEnvelope(OMXMLParserWrapper builder);
35  
36      /**
37       * @return
38       */
39      public SOAPEnvelope createSOAPEnvelope() throws SOAPProcessingException;
40  
41      /**
42       * @param envelope
43       * @return
44       */
45      public SOAPHeader createSOAPHeader(SOAPEnvelope envelope) throws SOAPProcessingException;
46  
47      /**
48       * @param envelope
49       * @param builder
50       * @return
51       */
52      public SOAPHeader createSOAPHeader(SOAPEnvelope envelope, OMXMLParserWrapper builder);
53  
54       /**
55       * @param localName
56       * @param ns
57       * @return
58       */
59      public SOAPHeaderBlock createSOAPHeaderBlock(String   localName, OMNamespace ns, SOAPHeader parent) throws SOAPProcessingException;
60  
61      /**
62       * @param localName
63       * @param ns
64       * @param parent
65       * @param builder
66       * @return
67       */
68      public SOAPHeaderBlock createSOAPHeaderBlock(String   localName, OMNamespace ns, SOAPHeader parent, OMXMLParserWrapper builder) throws SOAPProcessingException;
69  
70      /**
71           * @param parent
72           * @param e
73           * @return
74           */
75      public SOAPFault createSOAPFault(SOAPBody parent, Exception   e)throws SOAPProcessingException;
76      public SOAPFault createSOAPFault(SOAPBody parent)throws SOAPProcessingException;
77  
78      /**
79           * @param ns
80           * @param parent
81           * @param builder
82           * @return
83           */
84      public SOAPFault createSOAPFault(SOAPBody parent, OMXMLParserWrapper builder);
85      
86      /**
87       * @param envelope
88       * @return
89       */
90      public SOAPBody createSOAPBody(SOAPEnvelope envelope) throws SOAPProcessingException;
91  
92      /**
93       * @param envelope
94       * @param builder
95       * @return
96       */
97      public SOAPBody createSOAPBody(SOAPEnvelope envelope, OMXMLParserWrapper builder);
98  
99     /* ========================
100       =  SOAPFaultCode       =
101       ======================== */
102 
103       /**
104      * Code eii under SOAPFault (parent)
105      * @param parent
106      * @return
107      */
108     public SOAPFaultCode createSOAPFaultCode(SOAPFault parent) throws SOAPProcessingException;
109     /**
110      * Code eii under SOAPFault (parent)
111      * @param parent
112      * @param builder
113      * @return
114      */
115     public SOAPFaultCode createSOAPFaultCode(SOAPFault parent, OMXMLParserWrapper builder);
116 
117 
118     /*========================
119       =  SOAPFaultCodeValue  =
120       ======================== */
121     /**
122      * Value eii under Code (parent)
123      * @param parent
124      * @return
125      */
126     public SOAPFaultValue createSOAPFaultValue(SOAPFaultCode parent) throws SOAPProcessingException;
127     /**
128      * Value eii under Code (parent)
129      * @param parent
130      * @param builder
131      * @return
132      */
133     public SOAPFaultValue createSOAPFaultValue(SOAPFaultCode parent, OMXMLParserWrapper builder);
134 
135     /*========================
136       =  SOAPFaultSubCode    =
137       ======================== */
138 
139     /**
140      * SubCode eii under Value (parent)
141      * @param parent
142      * @return
143      */
144 
145     //added
146     public SOAPFaultValue createSOAPFaultValue(SOAPFaultSubCode parent) throws SOAPProcessingException;
147 
148     //added
149     public SOAPFaultValue createSOAPFaultValue(SOAPFaultSubCode parent, OMXMLParserWrapper builder);
150 
151     //changed
152     public SOAPFaultSubCode createSOAPFaultSubCode(SOAPFaultCode parent) throws SOAPProcessingException;
153     /**
154      * SubCode eii under Value (parent)
155      * @param parent
156      * @param builder
157      * @return
158      */
159     //changed
160     public SOAPFaultSubCode createSOAPFaultSubCode(SOAPFaultCode parent, OMXMLParserWrapper builder);
161 
162     /**
163      * SubCode eii under SubCode (parent)
164      * @param parent
165      * @return
166      */
167     public SOAPFaultSubCode createSOAPFaultSubCode(SOAPFaultSubCode parent) throws SOAPProcessingException;
168     /**
169      * SubCode eii under SubCode (parent)
170      * @param parent
171      * @param builder
172      * @return
173      */
174     public SOAPFaultSubCode createSOAPFaultSubCode(SOAPFaultSubCode parent, OMXMLParserWrapper builder);
175 
176 
177     /*========================
178       =  SOAPFaultReason     =
179       ======================== */
180 
181     /**
182      * Reason eii under SOAPFault (parent)
183      * @param parent
184      * @return
185      */
186     public SOAPFaultReason createSOAPFaultReason(SOAPFault parent) throws SOAPProcessingException;
187     /**
188      * Reason eii under SOAPFault (parent)
189      * @param parent
190      * @param builder
191      * @return
192      */
193     public SOAPFaultReason createSOAPFaultReason(SOAPFault parent, OMXMLParserWrapper builder);
194 
195     /*========================
196       =  SOAPFaultReasonText     =
197       ======================== */
198 
199     /**
200      * SubCode eii under SubCode (parent)
201      * @param parent
202      * @return
203      */
204     public SOAPFaultText createSOAPFaultText(SOAPFaultReason parent) throws SOAPProcessingException;
205     /**
206      * SubCode eii under SubCode (parent)
207      * @param parent
208      * @param builder
209      * @return
210      */
211     public SOAPFaultText createSOAPFaultText(SOAPFaultReason parent, OMXMLParserWrapper builder);
212 
213 
214     /*========================
215       =  SOAPFaultNode       =
216       ======================== */
217 
218     /**
219      * Node eii under SOAPFault (parent)
220      * @param parent
221      * @return
222      */
223     public SOAPFaultNode createSOAPFaultNode(SOAPFault parent) throws SOAPProcessingException;
224     /**
225      * Node eii under SOAPFault (parent)
226      * @param parent
227      * @param builder
228      * @return
229      */
230     public SOAPFaultNode createSOAPFaultNode(SOAPFault parent, OMXMLParserWrapper builder);
231 
232     /*========================
233       =  SOAPFaultRole       =
234       ======================== */
235 
236     /**
237      * Role eii under SOAPFault (parent)
238      * @param parent
239      * @return
240      */
241     public SOAPFaultRole createSOAPFaultRole(SOAPFault parent) throws SOAPProcessingException;
242     /**
243      * Role eii under SOAPFault (parent)
244      * @param parent
245      * @param builder
246      * @return
247      */
248     public SOAPFaultRole createSOAPFaultRole(SOAPFault parent, OMXMLParserWrapper builder);
249 
250     /*========================
251       =  SOAPFaultDetail     =
252       ======================== */
253 
254     /**
255      * Detail eii under SOAPFault (parent)
256      * @param parent
257      * @return
258      */
259     public SOAPFaultDetail createSOAPFaultDetail(SOAPFault parent) throws SOAPProcessingException;
260     /**
261      * Role eii under SOAPFault (parent)
262      * @param parent
263      * @param builder
264      * @return
265      */
266     public SOAPFaultDetail createSOAPFaultDetail(SOAPFault parent, OMXMLParserWrapper builder);
267 
268 
269 
270     /**
271      * Method getDefaultEnvelope
272      *
273      * @return
274      */
275     public SOAPEnvelope getDefaultEnvelope() throws SOAPProcessingException;
276     public SOAPEnvelope getDefaultFaultEnvelope() throws SOAPProcessingException;
277 }
278
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags