View Javadoc

1   /*
2    * Copyright 2009 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.saml2.ecp;
18  
19  import javax.xml.namespace.QName;
20  
21  import org.opensaml.common.SAMLObject;
22  import org.opensaml.common.xml.SAMLConstants;
23  import org.opensaml.ws.soap.soap11.ActorBearing;
24  import org.opensaml.ws.soap.soap11.MustUnderstandBearing;
25  
26  /**
27   * SAML 2.0 ECP Response SOAP header.
28   */
29  public interface Response extends SAMLObject, MustUnderstandBearing, ActorBearing {
30      
31      /** Element local name. */
32      public static final String DEFAULT_ELEMENT_LOCAL_NAME = "Response";
33  
34      /** Default element name. */
35      public static final QName DEFAULT_ELEMENT_NAME =
36          new QName(SAMLConstants.SAML20ECP_NS, DEFAULT_ELEMENT_LOCAL_NAME, SAMLConstants.SAML20ECP_PREFIX);
37  
38      /** Local name of the XSI type. */
39      public static final String TYPE_LOCAL_NAME = "ResponseType";
40  
41      /** QName of the XSI type. */
42      public static final QName TYPE_NAME =
43          new QName(SAMLConstants.SAML20ECP_NS, TYPE_LOCAL_NAME, SAMLConstants.SAML20ECP_PREFIX);
44  
45      /** ProviderName attribute name. */
46      public static final String ASSERTION_CONSUMER_SERVICE_URL_ATTRIB_NAME = "AssertionConsumerServiceURL";
47      
48      /**
49       * Get the AssertionConsumerServiceURL attribute value.
50       * 
51       * @return the AssertionConsumerServiceURL attribute value
52       */
53      public String getAssertionConsumerServiceURL();
54  
55      /**
56       * Get the AssertionConsumerServiceURL attribute value.
57       * 
58       * @param newAssertionConsumerServiceURL the new AssertionConsumerServiceURL attribute value
59       */
60      public void setAssertionConsumerServiceURL(String newAssertionConsumerServiceURL);
61  
62  }