src/edu/internet2/middleware/shibboleth/wayf/WayfConfig.java

   1 /*
   2  * The Shibboleth License, Version 1.
   3  * Copyright (c) 2002
   4  * University Corporation for Advanced Internet Development, Inc.
   5  * All rights reserved
   6  *
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions are met:
  10  *
  11  * Redistributions of source code must retain the above copyright notice, this
  12  * list of conditions and the following disclaimer.
  13  *
  14  * Redistributions in binary form must reproduce the above copyright notice,
  15  * this list of conditions and the following disclaimer in the documentation
  16  * and/or other materials provided with the distribution, if any, must include
  17  * the following acknowledgment: "This product includes software developed by
  18  * the University Corporation for Advanced Internet Development
  19  * <http://www.ucaid.edu>Internet2 Project. Alternately, this acknowledegement
  20  * may appear in the software itself, if and wherever such third-party
  21  * acknowledgments normally appear.
  22  *
  23  * Neither the name of Shibboleth nor the names of its contributors, nor
  24  * Internet2, nor the University Corporation for Advanced Internet Development,
  25  * Inc., nor UCAID may be used to endorse or promote products derived from this
  26  * software without specific prior written permission. For written permission,
  27  * please contact shibboleth@shibboleth.org
  28  *
  29  * Products derived from this software may not be called Shibboleth, Internet2,
  30  * UCAID, or the University Corporation for Advanced Internet Development, nor
  31  * may Shibboleth appear in their name, without prior written permission of the
  32  * University Corporation for Advanced Internet Development.
  33  *
  34  *
  35  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  36  * AND WITH ALL FAULTS. ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  37  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
  38  * PARTICULAR PURPOSE, AND NON-INFRINGEMENT ARE DISCLAIMED AND THE ENTIRE RISK
  39  * OF SATISFACTORY QUALITY, PERFORMANCE, ACCURACY, AND EFFORT IS WITH LICENSEE.
  40  * IN NO EVENT SHALL THE COPYRIGHT OWNER, CONTRIBUTORS OR THE UNIVERSITY
  41  * CORPORATION FOR ADVANCED INTERNET DEVELOPMENT, INC. BE LIABLE FOR ANY DIRECT,
  42  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  43  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  44  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  45  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  46  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  47  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  48  */
  49
  50 package edu.internet2.middleware.shibboleth.wayf;
  51
  52 import java.util.HashSet;
  53
  54 import org.apache.log4j.Logger;
  55
  56 /**
  57  * Class used by the  WAYF service to determine runtime options
  58  * Most of the fields of this class should have reasonable defaults.
  59  * @author Walter Hoehn wassa&#064;columbia.edu
  60  */
  61
  62 public class WayfConfig {
  63
  64         private static Logger log = Logger.getLogger(WayfConfig.class.getName());
  65
  66         private String logoLocation = "images/internet2.gif";
  67         private String supportContact = "mailto:shib-support@internet2.org";
  68         private String helpText =
  69                 "In order to fulfill the request for the  web resource you "
  70                         + "have just chosen, information must first be obtained from "
  71                         + "your home institution. Please select the institution with "
  72                         + "which you are affiliated.";
  73         private String searchResultEmptyText =
  74                 "No institution found that matches your search " + "criteria, please try again.";
  75         private HashSet ignoredForMatch = new HashSet();
  76         private int cacheExpiration;
  77         private String cacheDomain;
  78         private String cacheType = "COOKIES";
  79
  80         public WayfConfig() {
  81                 super();
  82         }
  83
  84         public String getSearchResultEmptyText() {
  85                 return searchResultEmptyText;
  86         }
  87
  88         public void setSearchResultEmptyText(String searchResultEmptyText) {
  89                 this.searchResultEmptyText = searchResultEmptyText;
  90         }
  91
  92         public String getHelpText() {
  93                 return helpText;
  94         }
  95
  96         public void setHelpText(String helpText) {
  97                 this.helpText = helpText;
  98         }
  99
 100         public String getSupportContact() {
 101                 return supportContact;
 102         }
 103
 104         public void setSupportContact(String supportContact) {
 105                 this.supportContact = supportContact;
 106         }
 107
 108         public String getLogoLocation() {
 109                 return logoLocation;
 110         }
 111
 112         public void setLogoLocation(String logoLocation) {
 113                 this.logoLocation = logoLocation;
 114         }
 115
 116         /**
 117          * Determines if a particular string token should be used for matching when a user searches for origins.
 118          * @param str The string to lookup
 119          */
 120         public boolean isIgnoredForMatch(String str) {
 121
 122                 if (ignoredForMatch.contains(str.toLowerCase())) {
 123                         return true;
 124                 } else {
 125                         return false;
 126                 }
 127         }
 128
 129         /**
 130          * Sets the tokens that should be ignored when a user searches for an origin site.
 131          * @param s The ignored tokens are passed as a single string, each separated by whitespace
 132          */
 133         public void addIgnoredForMatch(String s) {
 134
 135                 ignoredForMatch.add(s.toLowerCase());
 136         }
 137
 138         public String getCacheType() {
 139                 return cacheType;
 140         }
 141
 142         public void setCacheType(String cache) {
 143                 if (cache.toUpperCase().equals("NONE")
 144                         || cache.toUpperCase().equals("SESSION")
 145                         || cache.toUpperCase().equals("COOKIES")) {
 146                         this.cacheType = cache.toUpperCase();
 147                 } else {
 148                         log.warn("Cache type :" + cache + ": not recognized, using default.");
 149                 }
 150         }
 151
 152         /**
 153          * Returns the cacheDomain.
 154          * @return String
 155          */
 156         public String getCacheDomain() {
 157                 return cacheDomain;
 158         }
 159
 160
 161         /**
 162          * Returns the cacheExpiration.
 163          * @return int
 164          */
 165         public int getCacheExpiration() {
 166                 return cacheExpiration;
 167         }
 168
 169
 170         /**
 171          * Sets the cacheDomain.
 172          * @param cacheDomain The cacheDomain to set
 173          */
 174         public void setCacheDomain(String cacheDomain) {
 175                 this.cacheDomain = cacheDomain;
 176         }
 177
 178
 179         /**
 180          * Sets the cacheExpiration.
 181          * @param cacheExpiration The cacheExpiration to set
 182          */
 183         public void setCacheExpiration(int cacheExpiration) {
 184                 this.cacheExpiration = cacheExpiration;
 185         }
 186
 187
 188 }