01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one
03: * or more contributor license agreements. See the NOTICE file
04: * distributed with this work for additional information
05: * regarding copyright ownership. The ASF licenses this file
06: * to you under the Apache License, Version 2.0 (the
07: * "License"); you may not use this file except in compliance
08: * with the License. You may obtain a copy of the License at
09: *
10: * http://www.apache.org/licenses/LICENSE-2.0
11: *
12: * Unless required by applicable law or agreed to in writing,
13: * software distributed under the License is distributed on an
14: * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15: * KIND, either express or implied. See the License for the
16: * specific language governing permissions and limitations
17: * under the License.
18: */
19:
20: package org.apache.axis2.jaxws.description;
21:
22: /**
23: * A FaultDescription corresponds to a fault that can be thrown from an operation. NOTE this it not
24: * implemented yet!
25: *
26: * FaultDescriptons contain information that is only relevent for and SEI-based service, i.e. one that is invoked via specific
27: * methods. This class does not exist for Provider-based services (i.e. those that specify WebServiceProvider)
28: *
29: * <pre>
30: * <b>OperationDescription details</b>
31: *
32: * CORRESPONDS TO: An exception thrown by an operation on an SEI (on both Client and Server)
33: *
34: * AXIS2 DELEGATE: None
35: *
36: * CHILDREN: None
37: *
38: * ANNOTATIONS:
39: * WebFault [224]
40: *
41: * WSDL ELEMENTS:
42: * fault message
43: *
44: * </pre>
45: */
46:
47: /** @author scheu */
48: public interface FaultDescription {
49: public OperationDescription getOperationDescription();
50:
51: /** @return the name of the exception class */
52: public String getExceptionClassName();
53:
54: /**
55: * @return the class that is provided via the getFaultInfo method. "" is returned if the
56: * exception class does not provide a getFaultInfo method (such exceptions are
57: * considered non-compliant by JAX-WS).
58: */
59: public String getFaultInfo();
60:
61: /**
62: * @return the name of the JAXB class defined in the schema for this exception. Note that this
63: * is usually a bean, but it could also be a java primitive. If not defined, the
64: * getFaultInfo type is returned.
65: * <p/>
66: * NOTE For non-compliant exceptions, the getFaultInfo information is not availabled.
67: * In these cases, a "" is returned. The runtime (JAXWS) may use other information to
68: * locate and/or build the faultbean
69: */
70: public String getFaultBean();
71:
72: /**
73: * @return the element localname (for the JAXB class) corresponding to this exception. "" if not
74: * defined.
75: */
76: public String getName();
77:
78: /**
79: * @return the element targetNamespace (for the JAXB class) corresponding to this exception. ""
80: * if not defined.
81: */
82: public String getTargetNamespace();
83:
84: }
|