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 java.util.List;
20  
21  import javax.xml.namespace.QName;
22  
23  import org.opensaml.common.SAMLObject;
24  import org.opensaml.common.xml.SAMLConstants;
25  import org.opensaml.saml2.common.Extensions;
26  import org.opensaml.xml.AttributeExtensibleXMLObject;
27  
28  /**
29   * SAML 2.0 Metadata Organization
30   */
31  public interface Organization extends SAMLObject, AttributeExtensibleXMLObject{
32      
33      /** Local name, no namespace */
34      public final static String DEFAULT_ELEMENT_LOCAL_NAME = "Organization";
35      
36      /** Default element name */
37      public final static QName DEFAULT_ELEMENT_NAME = new QName(SAMLConstants.SAML20MD_NS, DEFAULT_ELEMENT_LOCAL_NAME, SAMLConstants.SAML20MD_PREFIX);
38      
39      /** Local name of the XSI type */
40      public final static String TYPE_LOCAL_NAME = "OrganizationType"; 
41          
42      /** QName of the XSI type */
43      public final static QName TYPE_NAME = new QName(SAMLConstants.SAML20MD_NS, TYPE_LOCAL_NAME, SAMLConstants.SAML20MD_PREFIX);
44      
45      /**
46       * Gets the Extensions child of this object.
47       * 
48       * @return the Extensions child of this object
49       */
50      public Extensions getExtensions();
51      
52      /**
53       * Sets the Extensions child of this object.
54       * 
55       * @param extensions the Extensions child of this object
56       * 
57       * @throws IllegalArgumentException thrown if the given extensions Object is already a child of another SAMLObject 
58       */
59      public void setExtensions(Extensions extensions) throws IllegalArgumentException;
60      
61      /**
62       * Gets the list of names for this organization.
63       * 
64       * @return names for this organization
65       */
66      public List<OrganizationName> getOrganizationNames();
67  
68      /**
69       * Gets a list of diaplay names for this organization.
70       * 
71       * @return list of names
72       */
73  	public List<OrganizationDisplayName> getDisplayNames();
74  
75      /**
76       * Gets a list of URLs for this organization.
77       * 
78       * @return list of URLs for this organization
79       */
80  	public List<OrganizationURL> getURLs();
81  }