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.soap.soap11;
18  
19  import java.util.Iterator;
20  
21  import org.springframework.ws.soap.SoapHeader;
22  import org.springframework.ws.soap.SoapHeaderElement;
23  import org.springframework.ws.soap.SoapHeaderException;
24  
25  /**
26   * Subinterface of <code>SoapHeader</code> that exposes SOAP 1.1 functionality.
27   *
28   * @author Arjen Poutsma
29   * @since 1.0.0
30   */
31  public interface Soap11Header extends SoapHeader {
32  
33      /**
34       * Returns an <code>Iterator</code> over all the {@link SoapHeaderElement header elements} that should be processed
35       * for the given actors. Headers target to the "next" actor or role will always be included.
36       *
37       * @param actors an array of actors to search for
38       * @return an iterator over all the header elements that contain the specified actors
39       * @throws SoapHeaderException if the headers cannot be returned
40       * @see SoapHeaderElement
41       */
42      Iterator<SoapHeaderElement> examineHeaderElementsToProcess(String[] actors) throws SoapHeaderException;
43  
44  
45  }