View Javadoc

1   /*
2    * Copyright 2010 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  import org.opensaml.saml2.metadata.LocalizedString;
23  import org.opensaml.xml.LangBearing;
24  
25  /**
26   * Localized logo type.
27   * 
28   * 
29   * @author RDW 27/Aug/2010
30   * 
31   * See IdP Discovery and Login UI Metadata Extension Profile.
32   *  
33   */
34  public interface Logo extends LangBearing, SAMLObject {
35  
36      /** Element local name. */
37      public static final String DEFAULT_ELEMENT_LOCAL_NAME = "Logo";
38      
39      /** Default element name. */
40      public static final QName DEFAULT_ELEMENT_NAME = new QName(UIInfo.MDUI_NS, 
41              DEFAULT_ELEMENT_LOCAL_NAME, UIInfo.MDUI_PREFIX);
42      
43      public static final String HEIGHT_ATTR_NAME = "height";
44  
45      public static final String WIDTH_ATTR_NAME = "width";
46  
47  
48      /**
49       * Gets the URL.
50       * 
51       * @return the URL
52       */
53      public LocalizedString getURL();
54      
55      /**
56       * Sets the URL.
57       * 
58       * @param newURL the URL
59       */
60      public void setURL(LocalizedString newURL);
61  
62      /**
63       * Get the height of the logo.
64       * @return the height of the logo
65       */
66      public Integer getHeight();
67      
68      /**
69       * Sets the height of the logo.
70       * @param newHeight the height of the logo
71       */
72      public void setHeight(Integer newHeight);
73  
74      /**
75       * Get the width of the logo.
76       * @return the width of the logo
77       */
78      public Integer getWidth();
79      
80      /**
81       * Sets the width of the logo.
82       * @param newWidth the height of the logo
83       */
84      public void setWidth(Integer newWidth);
85  }