UIInfo

+
+    /*
+     * Copyright 2010 University Corporation for Advanced Internet Development, Inc.
+     *
+     * Licensed under the Apache License, Version 2.0 (the "License");
+     * you may not use this file except in compliance with the License.
+     * You may obtain a copy of the License at
+     *
+     * http://www.apache.org/licenses/LICENSE-2.0
+     *
+     * Unless required by applicable law or agreed to in writing, software
+     * distributed under the License is distributed on an "AS IS" BASIS,
+     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+     * See the License for the specific language governing permissions and
+     * limitations under the License.
+     */
+
+    package edu.internet2.middleware.shibboleth.wayf.idpdisco;
+
+    import java.util.List;
+
+    import javax.xml.namespace.QName;
+
+    import org.opensaml.common.SAMLObject;
+
+    /**
+     * See IdP Discovery and Login UI Metadata Extension Profile.
+     *
+     * @author Rod Widdowson August 2010
+     *
+     * Reflects the UINFO in the IdP Discovery and Login UI Metadata Extension Profile,
+     *
+     */
+    public interface UIInfo extends SAMLObject {
+        /** Namespace for Discovery Service metadata extensions. */
+        public static final String MDUI_NS = "urn:oasis:names:tc:SAML:metadata:ui";
+
+        /** Default namespace prefix used by this library. */
+        public static final String  MDUI_PREFIX = "mdui";
+
+        /** Name of the element inside the Extensions. */
+        public static final String DEFAULT_ELEMENT_LOCAL_NAME = "UIInfo";
+
+        /** Default element name. */
+        public static final QName DEFAULT_ELEMENT_NAME = new QName(MDUI_NS, DEFAULT_ELEMENT_LOCAL_NAME,
+                MDUI_PREFIX);
+
+        /** Language attribute name. */
+        public static final String LANG_ATTRIB_NAME = "lang";
+
+        /**
+         * Get the Display Names
+         *
+         * The <DisplayName> element specifies a set of localized names fit for
+         * display to users.  Such names are meant to allow a user to distinguish
+         * and identify the entity acting in a particular role.
+         * @return the names
+         */
+        public List <DisplayName> getDisplayNames();
+
+        /**
+         * Return the descriptions.
+         *
+         * The <Description> element specifies a set of brief, localized descriptions
+         * fit for display to users. In the case of service providers this SHOULD be a
+         * description of the service being offered.  In the case of an identity provider
+         * this SHOULD be a description of the community serviced.  In all cases this text
+         * SHOULD be standalone, meaning it is not meant to be filled in to some template
+         * text (e.g. 'This service offers $description').
+         * @return descriptions
+         */
+        public List <Description> getDescriptions();
+
+        /**
+         * Get the logos.
+         *
+         * The <Logo> element specifies a set of localized logos fit for display to users.
+         *
+         * @return a list of logos
+         */
+        public List <Logo> getLogos();
+
+        /**
+         * Get the URLs.
+         *
+         * The <InformationURL> specifies URLs to localized information, about the entity
+         * acting in a given role, meant to be viewed by users.  The contents found at
+         * these URLs SHOULD give a more complete set of information about than what is
+         * provided by the <Description> element
+         *
+         * @return the URLs
+         */
+        public List <InformationURL> getInformationURLs();
+
+        /**
+         * Get the Privacy Statement URLs.
+         *
+         * The <PrivacyStatementURL> specifies URLs to localized privacy statements.
+         * Such statements are meant to provide a user with information about how
+         * information will be used and managed by the entity
+         *
+         * @return the URLs
+         */
+        public List <PrivacyStatementURL> getPrivacyStatementURLs();
+
+    }
+