View Javadoc

1   /*
2    * Copyright [2006] [University Corporation for Advanced Internet Development, Inc.]
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.opensaml.ws.soap.util;
18  
19  import java.util.List;
20  
21  import org.opensaml.xml.AttributeExtensibleXMLObject;
22  
23  /**
24   * Helper methods for working with SOAP.
25   */
26  public class SOAPHelper {
27  
28      /**
29       * Privatae constructor.
30       */
31      private SOAPHelper() {
32      }
33  
34      /**
35       * Adds a "mustUnderstand" attribute to the given SOAP object.
36       * 
37       * @param soapObject the SOAP object to add the attribute to
38       * @param mustUnderstand whether mustUnderstand is true or false
39       */
40      public static void addMustUnderstandAttribute(AttributeExtensibleXMLObject soapObject, boolean mustUnderstand) {
41  
42      }
43  
44      /**
45       * Adds an "actor" attribute to the given SOAP object.
46       * 
47       * @param soapObject the SOAP object to add the attribute to
48       * @param actorURI the URI of the actor
49       */
50      public static void addActorAttribute(AttributeExtensibleXMLObject soapObject, String actorURI) {
51  
52      }
53  
54      /**
55       * Adds a single encoding style to the given SOAP object. If existing encodingStyles are present, the given style
56       * will be added to the existing list.
57       * 
58       * @param soapObject the SOAP object to add the attribute to
59       * @param encodingStyle the encoding style to add
60       */
61      public static void addEncodingStyle(AttributeExtensibleXMLObject soapObject, String encodingStyle) {
62  
63      }
64  
65      /**
66       * Adds an "encodingStyle" attribute to the given SOAP object.
67       * 
68       * @param soapObject the SOAP object to add the attribute to
69       * @param encodingStyles the list of encoding styles to add
70       */
71      public static void addEncodingStyles(AttributeExtensibleXMLObject soapObject, List<String> encodingStyles) {
72  
73      }
74  }