Cleaned up the WAYF javadoc somewhat.
[java-idp.git] / src / edu / internet2 / middleware / shibboleth / wayf / WayfConfig.java
1 package edu.internet2.middleware.shibboleth.wayf;
2
3 import java.util.HashSet;
4
5 import org.apache.log4j.Logger;
6
7 /**
8  * Class used by the  WAYF service to determine runtime options
9  * Most of the fields of this class should have reasonable defaults set
10  * @author Walter Hoehn wassa@columbia.edu
11  */
12
13 public class WayfConfig {
14
15         private static Logger log = Logger.getLogger(WayfConfig.class.getName());
16
17         private static WayfOrigins wd;
18         private static String location;
19         private static String logoLocation = "images/internet2.gif";
20         private static String supportContact = "mailto:shib-support@internet2.org";
21         private static String helpText =
22                 "In order to fulfill the request for the  web resource you "
23                         + "have just chosen, information must first be obtained from "
24                         + "your home institution. Please select the institution with "
25                         + "which you are affiliated.";
26         private static String searchResultEmptyText =
27                 "No institution found that matches your search "
28                         + "criteria, please try again.";
29         private static HashSet ignoredForMatch = new HashSet();
30
31         private static String cache = "SESSION";
32
33         public WayfConfig() {
34                 super();
35         }
36
37         public static WayfOrigins getWAYFData() {
38                 return wd;
39         }
40
41         public void setWAYFData(WayfOrigins wd) {
42                 WayfConfig.wd = wd;
43         }
44
45         public static String getSearchResultEmptyText() {
46                 return searchResultEmptyText;
47         }
48
49         public void setSearchResultEmptyText(String searchResultEmptyText) {
50                 WayfConfig.searchResultEmptyText = searchResultEmptyText;
51         }
52
53         public static String getHelpText() {
54                 return helpText;
55         }
56
57         public void setHelpText(String helpText) {
58                 WayfConfig.helpText = helpText;
59         }
60
61         public static String getSupportContact() {
62                 return supportContact;
63         }
64
65         public void setSupportContact(String supportContact) {
66                 WayfConfig.supportContact = supportContact;
67         }
68
69         public static String getLogoLocation() {
70                 return logoLocation;
71         }
72
73         public void setLogoLocation(String logoLocation) {
74                 WayfConfig.logoLocation = logoLocation;
75         }
76
77         public static String getLocation() {
78                 return location;
79         }
80
81         public void setLocation(String location) {
82                 WayfConfig.location = location;
83         }
84
85         /**
86          * Determines if a particular string token should be used for matching when a user searches for origins.
87          * @param str The string to lookup
88          */
89         public static boolean isIgnoredForMatch(String str) {
90
91                 if (ignoredForMatch.contains(str.toLowerCase())) {
92                         return true;
93                 } else {
94                         return false;
95                 }
96         }
97
98         /**
99          * Sets the tokens that should be ignored when a user searches for an origin site.
100          * @param s The ignored tokens are passed as a single string, each separated by whitespace
101          */
102         public void addIgnoredForMatch(String s) {
103
104                 ignoredForMatch.add(s.toLowerCase());
105         }
106
107         public static String getCache() {
108                 return cache;
109         }
110
111         public void setCache(String cache) {
112                 if (cache.toUpperCase().equals("NONE")
113                         || cache.toUpperCase().equals("SESSION")
114                         || cache.toUpperCase().equals("COOKIES")) {
115                         WayfConfig.cache = cache.toUpperCase();
116                 } else {
117                         log.warn(
118                                 "Cache type :" + cache + ": not recognized, using default.");
119                 }
120         }
121
122 }