1 /*
2 * Copyright 2007 the original author or authors.
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17 package org.springframework.ws;
18
19 import org.springframework.ws.soap.SoapFault;
20 import org.springframework.ws.soap.SoapMessage;
21
22 /**
23 * Sub-interface of {@link WebServiceMessage} that can contain special Fault messages. Fault messages (such as {@link
24 * SoapFault} SOAP Faults) often require different processing rules.
25 *
26 * @author Arjen Poutsma
27 * @see SoapMessage
28 * @since 1.0.0
29 */
30 public interface FaultAwareWebServiceMessage extends WebServiceMessage {
31
32 /**
33 * Does this message have a fault?
34 *
35 * @return <code>true</code> if the message has a fault.
36 * @see #getFaultReason()
37 */
38 boolean hasFault();
39
40 /**
41 * Returns the fault reason message.
42 *
43 * @return the fault reason message, if any; returns <code>null</code> when no fault is present.
44 * @see #hasFault()
45 */
46 String getFaultReason();
47 }