2f6e83ad6b2b83b609fcbeb4f43f377c8e7497b5
[java-idp.git] / src / edu / internet2 / middleware / shibboleth / wayf / Origin.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.io.UnsupportedEncodingException;
53 import java.net.URLEncoder;
54 import java.util.ArrayList;
55 import java.util.Enumeration;
56 import java.util.Iterator;
57 import java.util.StringTokenizer;
58
59 import org.apache.log4j.Logger;
60
61 /**
62  * This class represents an Origin site in the shibboleth parlance.
63  * 
64  * @author Walter Hoehn wassa&#064;columbia.edu
65  */
66
67 public class Origin implements Comparable {
68
69         private static Logger log = Logger.getLogger(Origin.class.getName());
70     private String name = "";
71     private ArrayList aliases = new ArrayList();
72     private String handleService = "";
73
74     /**
75      * Gets the handleService for this origin.
76      * @return Returns a String
77      */
78     public String getHandleService() {
79         return handleService;
80     }
81
82     /**
83      * Sets the handleService for this origin.
84      * @param handleService The handleService to set
85      */
86     public void setHandleService(String handleService) {
87         this.handleService = handleService;
88     }
89
90     /**
91      * Gets the origin name.
92      * @return Returns a String
93      */
94     public String getName() {
95         return name;
96     }
97     
98     public String getDisplayName() {
99         if (aliases.get(0) != null) {
100                 return (String) aliases.get(0);
101         } else {
102                 return getName();
103         }
104     }
105
106     public String getUrlEncodedName() throws UnsupportedEncodingException {
107
108                         return URLEncoder.encode(name, "UTF-8");
109     }
110
111     /**
112      * Sets a name for this origin.
113      * @param name The name to set
114      */
115     public void setName(String name) {
116         this.name = name;
117     }
118
119     /**
120      * Gets all aliases for this origin.
121      * @return Returns a String[]
122      */
123     public String[] getAliases() {
124         return (String[]) aliases.toArray(new String[0]);
125     }
126
127     /**
128      * Adds an alias for this origin.
129      * @param alias The aliases to set
130      */
131     public void addAlias(String alias) {
132         aliases.add(alias);
133     }
134
135     /**
136      * Determines if a given string matches one of the registered names/aliases of this origin.
137      * @param str The string to match on
138      */
139     public boolean isMatch(String str, WayfConfig config) {
140
141         Enumeration input = new StringTokenizer(str);
142         while (input.hasMoreElements()) {
143             String currentToken = (String) input.nextElement();
144
145             if (config.isIgnoredForMatch(currentToken)) {
146                 continue;
147             }
148
149             if (getName().toLowerCase().indexOf(currentToken.toLowerCase()) > -1) {
150                 return true;
151             }
152             Iterator aliasit = aliases.iterator();
153             while (aliasit.hasNext()) {
154                 String alias = (String) aliasit.next();
155                 if (alias.toLowerCase().indexOf(currentToken.toLowerCase()) > -1) {
156                     return true;
157                 }
158             }
159
160         }
161         return false;
162     }
163
164         /**
165          * @see java.lang.Comparable#compareTo(java.lang.Object)
166          */
167         public int compareTo(Object o) {
168                 int result = getDisplayName().toLowerCase().compareTo(((Origin) o).getDisplayName().toLowerCase());
169                 if (result == 0) {
170                         result = getDisplayName().compareTo(((Origin) o).getDisplayName());
171                 }
172                 return result;
173         }
174
175 }