View Javadoc

1   /*
2    * Copyright [2005] [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.metadata;
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.xml.AttributeExtensibleXMLObject;
24  import org.opensaml.xml.ElementExtensibleXMLObject;
25  
26  /**
27   * SAML 2.0 Metadata Endpoint data type interface
28   */
29  public interface Endpoint extends SAMLObject, ElementExtensibleXMLObject, AttributeExtensibleXMLObject{
30      
31      /** Element local name */
32      public final static String DEFAULT_ELEMENT_LOCAL_NAME = "Endpoint";
33      
34      /** Default element name */
35      public final static QName DEFAULT_ELEMENT_NAME = new QName(SAMLConstants.SAML20MD_NS, DEFAULT_ELEMENT_LOCAL_NAME, SAMLConstants.SAML20MD_PREFIX);
36      
37      /** Local name of the XSI type */
38      public final static String TYPE_LOCAL_NAME = "EndpointType"; 
39          
40      /** QName of the XSI type */
41      public final static QName TYPE_NAME = new QName(SAMLConstants.SAML20MD_NS, TYPE_LOCAL_NAME, SAMLConstants.SAML20MD_PREFIX);
42      
43      /** "Binding" attribute name */
44      public final static String BINDING_ATTRIB_NAME = "Binding";
45      
46      /** "Location" attribute name */
47      public final static String LOCATION_ATTRIB_NAME = "Location";
48      
49      /** "ResponseLocation" attribute name */
50      public final static String RESPONSE_LOCATION_ATTRIB_NAME = "ResponseLocation";
51      
52      /**
53       * Gets the URI identifier for the binding supported by this Endpoint.
54       * 
55       * @return the URI identifier for the binding supported by this Endpoint
56       */
57  	public String getBinding();
58      
59      /**
60       * Sets the URI identifier for the binding supported by this Endpoint.
61       * 
62       * @param binding the URI identifier for the binding supported by this Endpoint
63       */
64      public void setBinding(String binding);
65  
66      /**
67       * Gets the URI, usually a URL, for the location of this Endpoint.
68       * 
69       * @return the location of this Endpoint
70       */
71  	public String getLocation();
72      
73      /**
74       * Sets the URI, usually a URL, for the location of this Endpoint.
75       * 
76       * @param location the location of this Endpoint
77       */
78      public void setLocation(String location);
79  
80      /**
81       * Gets the URI, usually a URL, responses should be sent to this for this Endpoint.
82       * 
83       * @return the URI responses should be sent to this for this Endpoint
84       */
85  	public String getResponseLocation();
86      
87      /**
88       * Sets the URI, usually a URL, responses should be sent to this for this Endpoint.
89       * 
90       * @param location the URI responses should be sent to this for this Endpoint
91       */
92      public void setResponseLocation(String location);
93  }