View Javadoc

1   /*
2    * Copyright 2005-2010 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  /**
20   * Sub-interface of [email protected] WebServiceMessage} that can contain special Fault messages. Fault messages (such as [email protected]
21   * org.springframework.ws.soap.SoapFault} SOAP Faults) often require different processing rules.
22   *
23   * @author Arjen Poutsma
24   * @see org.springframework.ws.soap.SoapMessage
25   * @since 1.0.0
26   */
27  public interface FaultAwareWebServiceMessage extends WebServiceMessage {
28  
29      /**
30       * Does this message have a fault?
31       *
32       * @return <code>true</code> if the message has a fault.
33       * @see #getFaultReason()
34       */
35      boolean hasFault();
36  
37      /**
38       * Returns the fault reason message.
39       *
40       * @return the fault reason message, if any; returns <code>null</code> when no fault is present.
41       * @see #hasFault()
42       */
43      String getFaultReason();
44  }