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 edu.internet2.middleware.shibboleth.wayf.idpdisco;
18  
19  import javax.xml.namespace.QName;
20  
21  import org.opensaml.common.SAMLObject;
22  
23  /**
24   * IPHint.
25   *
26   * See IdP Discovery and Login UI Metadata Extension Profile.
27   *
28   * @author Rod Widdowson August 2010
29   * 
30   * The <DomainHint> element specifies a set of DNS domains associated with, 
31   * or serviced by, the entity. 
32   */
33  public interface DomainHint extends SAMLObject {
34  
35      /** Element local name. */
36      public static final String DEFAULT_ELEMENT_LOCAL_NAME = "DomainHint";
37      
38      /** Default element name. */
39      public static final QName DEFAULT_ELEMENT_NAME = new QName(DiscoHints.MDUI_NS, 
40              DEFAULT_ELEMENT_LOCAL_NAME, DiscoHints.MDUI_PREFIX);
41      
42      /**
43       * Gets the Hint.
44       * 
45       * @return the Hint
46       */
47      public String getHint();
48      
49      /**
50       * Sets the hint.
51       * 
52       * @param newHint hint
53       */
54      public void setHint(String newHint);
55  }