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.core;
18  
19  import javax.xml.namespace.QName;
20  
21  import org.opensaml.common.SAMLObject;
22  import org.opensaml.common.xml.SAMLConstants;
23  
24  /**
25   * SAML 2.0 Core IDPEntry.
26   */
27  public interface IDPEntry extends SAMLObject {
28  
29      /** Element local name. */
30      public static final String DEFAULT_ELEMENT_LOCAL_NAME = "IDPEntry";
31  
32      /** Default element name. */
33      public static final QName DEFAULT_ELEMENT_NAME = new QName(SAMLConstants.SAML20P_NS, DEFAULT_ELEMENT_LOCAL_NAME,
34              SAMLConstants.SAML20P_PREFIX);
35  
36      /** Local name of the XSI type. */
37      public static final String TYPE_LOCAL_NAME = "IDPEntryType";
38  
39      /** QName of the XSI type. */
40      public static final QName TYPE_NAME = new QName(SAMLConstants.SAML20P_NS, TYPE_LOCAL_NAME,
41              SAMLConstants.SAML20P_PREFIX);
42  
43      /** ProviderID attribute name. */
44      public static final String PROVIDER_ID_ATTRIB_NAME = "ProviderID";
45  
46      /** Name attribute name. */
47      public static final String NAME_ATTRIB_NAME = "Name";
48  
49      /** Loc attribute name. */
50      public static final String LOC_ATTRIB_NAME = "Loc";
51  
52      /**
53       * Gets ProviderID URI.
54       * 
55       * @return the ProviderID URI
56       */
57      public String getProviderID();
58  
59      /**
60       * Sets the ProviderID URI.
61       * 
62       * @param newProviderID the new ProviderID URI
63       */
64      public void setProviderID(String newProviderID);
65  
66      /**
67       * Gets the Name value.
68       * 
69       * @return the Name value
70       */
71      public String getName();
72  
73      /**
74       * Sets the Name value.
75       * 
76       * @param newName the Name value
77       */
78      public void setName(String newName);
79  
80      /**
81       * Gets the Loc value.
82       * 
83       * @return the Loc value
84       */
85      public String getLoc();
86  
87      /**
88       * Sets the Loc value.
89       * 
90       * @param newLoc the new Loc value
91       */
92      public void setLoc(String newLoc);
93  
94  }