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