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  
24  /**
25   * SAML 2.0 Metadata AffiliateMember
26   */
27  public interface AffiliateMember extends SAMLObject {
28      
29      /** Element name, no namespace */
30      public final static String DEFAULT_ELEMENT_LOCAL_NAME = "AffiliateMember";
31      
32      /** Default element name */
33      public final static QName DEFAULT_ELEMENT_NAME = new QName(SAMLConstants.SAML20MD_NS, DEFAULT_ELEMENT_LOCAL_NAME, SAMLConstants.SAML20MD_PREFIX);
34      
35      /** Local name of the XSI type */
36      public final static String TYPE_LOCAL_NAME = "entityIDType"; 
37          
38      /** QName of the XSI type */
39      public final static QName TYPE_NAME = new QName(SAMLConstants.SAML20MD_NS, TYPE_LOCAL_NAME, SAMLConstants.SAML20MD_PREFIX);
40      
41      /**
42       * Gets the member's entity ID.
43       * 
44       * @return the member's ID
45       */
46      public String getID();
47      
48      /**
49       * Sets the member's entity ID.
50       * 
51       * @param memberID the member's ID
52       * 
53       * @throws IllegalArgumentException thrown if the ID is over 1024 characters long
54       */
55      public void setID(String memberID) throws IllegalArgumentException;
56  }