summaryrefslogtreecommitdiff
path: root/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/IdPSiteSet.html
blob: af6f8279343f258892a5b8f4f38bc710a1ad8115 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
<title>IdPSiteSet xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../apidocs/edu/internet2/middleware/shibboleth/wayf/IdPSiteSet.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <em class="jxr_comment">/*</em>
<a name="2" href="#2">2</a>   <em class="jxr_comment"> * Copyright [2005] [University Corporation for Advanced Internet Development, Inc.]</em>
<a name="3" href="#3">3</a>   <em class="jxr_comment"> *</em>
<a name="4" href="#4">4</a>   <em class="jxr_comment"> * Licensed under the Apache License, Version 2.0 (the "License");</em>
<a name="5" href="#5">5</a>   <em class="jxr_comment"> * you may not use this file except in compliance with the License.</em>
<a name="6" href="#6">6</a>   <em class="jxr_comment"> * You may obtain a copy of the License at</em>
<a name="7" href="#7">7</a>   <em class="jxr_comment"> *</em>
<a name="8" href="#8">8</a>   <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a name="9" href="#9">9</a>   <em class="jxr_comment"> *</em>
<a name="10" href="#10">10</a>  <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, software</em>
<a name="11" href="#11">11</a>  <em class="jxr_comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
<a name="12" href="#12">12</a>  <em class="jxr_comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a name="13" href="#13">13</a>  <em class="jxr_comment"> * See the License for the specific language governing permissions and</em>
<a name="14" href="#14">14</a>  <em class="jxr_comment"> * limitations under the License.</em>
<a name="15" href="#15">15</a>  <em class="jxr_comment"> */</em>
<a name="16" href="#16">16</a>  <strong class="jxr_keyword">package</strong> edu.internet2.middleware.shibboleth.wayf;
<a name="17" href="#17">17</a>  
<a name="18" href="#18">18</a>  <strong class="jxr_keyword">import</strong> java.io.File;
<a name="19" href="#19">19</a>  <strong class="jxr_keyword">import</strong> java.lang.reflect.Constructor;
<a name="20" href="#20">20</a>  <strong class="jxr_keyword">import</strong> java.net.MalformedURLException;
<a name="21" href="#21">21</a>  <strong class="jxr_keyword">import</strong> java.net.URL;
<a name="22" href="#22">22</a>  <strong class="jxr_keyword">import</strong> java.util.ArrayList;
<a name="23" href="#23">23</a>  <strong class="jxr_keyword">import</strong> java.util.Collection;
<a name="24" href="#24">24</a>  <strong class="jxr_keyword">import</strong> java.util.Enumeration;
<a name="25" href="#25">25</a>  <strong class="jxr_keyword">import</strong> java.util.HashMap;
<a name="26" href="#26">26</a>  <strong class="jxr_keyword">import</strong> java.util.HashSet;
<a name="27" href="#27">27</a>  <strong class="jxr_keyword">import</strong> java.util.List;
<a name="28" href="#28">28</a>  <strong class="jxr_keyword">import</strong> java.util.Map;
<a name="29" href="#29">29</a>  <strong class="jxr_keyword">import</strong> java.util.Set;
<a name="30" href="#30">30</a>  <strong class="jxr_keyword">import</strong> java.util.StringTokenizer;
<a name="31" href="#31">31</a>  <strong class="jxr_keyword">import</strong> java.util.TreeMap;
<a name="32" href="#32">32</a>  
<a name="33" href="#33">33</a>  <strong class="jxr_keyword">import</strong> org.opensaml.saml2.metadata.EntitiesDescriptor;
<a name="34" href="#34">34</a>  <strong class="jxr_keyword">import</strong> org.opensaml.saml2.metadata.EntityDescriptor;
<a name="35" href="#35">35</a>  <strong class="jxr_keyword">import</strong> org.opensaml.saml2.metadata.IDPSSODescriptor;
<a name="36" href="#36">36</a>  <strong class="jxr_keyword">import</strong> org.opensaml.saml2.metadata.Organization;
<a name="37" href="#37">37</a>  <strong class="jxr_keyword">import</strong> org.opensaml.saml2.metadata.OrganizationDisplayName;
<a name="38" href="#38">38</a>  <strong class="jxr_keyword">import</strong> org.opensaml.saml2.metadata.OrganizationName;
<a name="39" href="#39">39</a>  <strong class="jxr_keyword">import</strong> org.opensaml.saml2.metadata.RoleDescriptor;
<a name="40" href="#40">40</a>  <strong class="jxr_keyword">import</strong> org.opensaml.saml2.metadata.SPSSODescriptor;
<a name="41" href="#41">41</a>  <strong class="jxr_keyword">import</strong> org.opensaml.saml2.metadata.provider.FileBackedHTTPMetadataProvider;
<a name="42" href="#42">42</a>  <strong class="jxr_keyword">import</strong> org.opensaml.saml2.metadata.provider.FilesystemMetadataProvider;
<a name="43" href="#43">43</a>  <strong class="jxr_keyword">import</strong> org.opensaml.saml2.metadata.provider.MetadataFilter;
<a name="44" href="#44">44</a>  <strong class="jxr_keyword">import</strong> org.opensaml.saml2.metadata.provider.MetadataFilterChain;
<a name="45" href="#45">45</a>  <strong class="jxr_keyword">import</strong> org.opensaml.saml2.metadata.provider.MetadataProvider;
<a name="46" href="#46">46</a>  <strong class="jxr_keyword">import</strong> org.opensaml.saml2.metadata.provider.MetadataProviderException;
<a name="47" href="#47">47</a>  <strong class="jxr_keyword">import</strong> org.opensaml.saml2.metadata.provider.ObservableMetadataProvider;
<a name="48" href="#48">48</a>  <strong class="jxr_keyword">import</strong> org.opensaml.xml.XMLObject;
<a name="49" href="#49">49</a>  <strong class="jxr_keyword">import</strong> org.opensaml.xml.parse.ParserPool;
<a name="50" href="#50">50</a>  <strong class="jxr_keyword">import</strong> org.slf4j.Logger;
<a name="51" href="#51">51</a>  <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory;
<a name="52" href="#52">52</a>  <strong class="jxr_keyword">import</strong> org.w3c.dom.Element;
<a name="53" href="#53">53</a>  <strong class="jxr_keyword">import</strong> org.w3c.dom.NodeList;
<a name="54" href="#54">54</a>  
<a name="55" href="#55">55</a>  <strong class="jxr_keyword">import</strong> edu.internet2.middleware.shibboleth.common.ShibbolethConfigurationException;
<a name="56" href="#56">56</a>  <strong class="jxr_keyword">import</strong> edu.internet2.middleware.shibboleth.wayf.plugins.Plugin;
<a name="57" href="#57">57</a>  <strong class="jxr_keyword">import</strong> edu.internet2.middleware.shibboleth.wayf.plugins.PluginMetadataParameter;
<a name="58" href="#58">58</a>  <strong class="jxr_keyword">import</strong> edu.internet2.middleware.shibboleth.wayf.plugins.provider.BindingFilter;
<a name="59" href="#59">59</a>  
<a name="60" href="#60">60</a>  <em class="jxr_javadoccomment">/**</em>
<a name="61" href="#61">61</a>  <em class="jxr_javadoccomment"> * </em>
<a name="62" href="#62">62</a>  <em class="jxr_javadoccomment"> * Represents a collection of related sites as desribed by a single soirce of metadata. </em>
<a name="63" href="#63">63</a>  <em class="jxr_javadoccomment"> * This is usually a federation.  When the WAYF looks to see which IdP sites to show, </em>
<a name="64" href="#64">64</a>  <em class="jxr_javadoccomment"> * it trims the list so as to not show IdP's which do not trust the SP.</em>
<a name="65" href="#65">65</a>  <em class="jxr_javadoccomment"> *</em>
<a name="66" href="#66">66</a>  <em class="jxr_javadoccomment"> * This class is opaque outside this file.  The three static methods getSitesLists,</em>
<a name="67" href="#67">67</a>  <em class="jxr_javadoccomment"> * searchForMatchingOrigins and lookupIdP provide mechansims for accessing </em>
<a name="68" href="#68">68</a>  <em class="jxr_javadoccomment"> * collections of IdPSiteSets.</em>
<a name="69" href="#69">69</a>  <em class="jxr_javadoccomment"> * </em>
<a name="70" href="#70">70</a>  <em class="jxr_javadoccomment"> */</em>
<a name="71" href="#71">71</a>  
<a name="72" href="#72">72</a>  <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/IdPSiteSet.html">IdPSiteSet</a> implements ObservableMetadataProvider.Observer {
<a name="73" href="#73">73</a>          
<a name="74" href="#74">74</a>      <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Handle for error output. */</em>
<a name="75" href="#75">75</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Logger LOG = LoggerFactory.getLogger(IdPSiteSet.<strong class="jxr_keyword">class</strong>.getName());
<a name="76" href="#76">76</a>  
<a name="77" href="#77">77</a>      <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> The OpenSaml metadat6a source. */</em>
<a name="78" href="#78">78</a>      <strong class="jxr_keyword">private</strong> ObservableMetadataProvider metadata;
<a name="79" href="#79">79</a>  
<a name="80" href="#80">80</a>      <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Is the named SP in the current metadata set? */</em>
<a name="81" href="#81">81</a>      <strong class="jxr_keyword">private</strong> Set&lt;String&gt; spNames = <strong class="jxr_keyword">new</strong> HashSet&lt;String&gt;(0);
<a name="82" href="#82">82</a>  
<a name="83" href="#83">83</a>      <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Is the named IdP in the current metadata set? */</em>
<a name="84" href="#84">84</a>      <strong class="jxr_keyword">private</strong> Set&lt;String&gt; idpNames = <strong class="jxr_keyword">new</strong> HashSet&lt;String&gt;(0);
<a name="85" href="#85">85</a>      
<a name="86" href="#86">86</a>      <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> What does the configuration identify this as? */</em>
<a name="87" href="#87">87</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> String identifier;
<a name="88" href="#88">88</a>      
<a name="89" href="#89">89</a>      <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> What name should we display for this set of entities? */</em>
<a name="90" href="#90">90</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> String displayName;
<a name="91" href="#91">91</a>      
<a name="92" href="#92">92</a>      <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Where does the metadata exist? */</em>
<a name="93" href="#93">93</a>      <strong class="jxr_keyword">private</strong> String location;
<a name="94" href="#94">94</a>      
<a name="95" href="#95">95</a>      <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> What parameters do we pass in to which plugin? */</em>
<a name="96" href="#96">96</a>      <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> Map&lt;Plugin, PluginMetadataParameter&gt; plugins = <strong class="jxr_keyword">new</strong> HashMap&lt;Plugin, PluginMetadataParameter&gt;();
<a name="97" href="#97">97</a>      
<a name="98" href="#98">98</a>      <em class="jxr_javadoccomment">/**</em>
<a name="99" href="#99">99</a>  <em class="jxr_javadoccomment">     * Create a new IdPSiteSet as described by the supplied XML segment. </em>
<a name="100" href="#100">100</a> <em class="jxr_javadoccomment">     * @param el - configuration details.</em>
<a name="101" href="#101">101</a> <em class="jxr_javadoccomment">     * @param parserPool - the parsers we initialized above.</em>
<a name="102" href="#102">102</a> <em class="jxr_javadoccomment">     * @param warnOnBadBinding if we just warn or give an error if an SP has bad entry points.</em>
<a name="103" href="#103">103</a> <em class="jxr_javadoccomment">     * @throws ShibbolethConfigurationException - if something goes wrong.</em>
<a name="104" href="#104">104</a> <em class="jxr_javadoccomment">     */</em>
<a name="105" href="#105">105</a>     <strong class="jxr_keyword">protected</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/IdPSiteSet.html">IdPSiteSet</a>(Element el, ParserPool parserPool, <strong class="jxr_keyword">boolean</strong> warnOnBadBinding) <strong class="jxr_keyword">throws</strong> ShibbolethConfigurationException {
<a name="106" href="#106">106</a> 
<a name="107" href="#107">107</a>         String spoolSpace;
<a name="108" href="#108">108</a>         String delayString;
<a name="109" href="#109">109</a> 
<a name="110" href="#110">110</a>         <strong class="jxr_keyword">this</strong>.identifier = el.getAttribute(<span class="jxr_string">"identifier"</span>);
<a name="111" href="#111">111</a>         <strong class="jxr_keyword">this</strong>.displayName = el.getAttribute(<span class="jxr_string">"displayName"</span>);
<a name="112" href="#112">112</a>         location = el.getAttribute(<span class="jxr_string">"url"</span>);
<a name="113" href="#113">113</a>         <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">null</strong> == location || location.length() == 0) {
<a name="114" href="#114">114</a>             <em class="jxr_comment">//</em>
<a name="115" href="#115">115</a>             <em class="jxr_comment">// Sigh for a few releases this was documented as URI</em>
<a name="116" href="#116">116</a>             <em class="jxr_comment">//</em>
<a name="117" href="#117">117</a>             location = el.getAttribute(<span class="jxr_string">"url"</span>);
<a name="118" href="#118">118</a>         }
<a name="119" href="#119">119</a>         spoolSpace = el.getAttribute(<span class="jxr_string">"backingFile"</span>);
<a name="120" href="#120">120</a>         delayString = el.getAttribute(<span class="jxr_string">"timeout"</span>);
<a name="121" href="#121">121</a>         
<a name="122" href="#122">122</a>         <em class="jxr_comment">//</em>
<a name="123" href="#123">123</a>         <em class="jxr_comment">// Configure the filters (before the metadata so we can add them before we start reading)</em>
<a name="124" href="#124">124</a>         <em class="jxr_comment">//</em>
<a name="125" href="#125">125</a>         String ident;
<a name="126" href="#126">126</a>         String className;
<a name="127" href="#127">127</a>         ident = <span class="jxr_string">"&lt;not specified&gt;"</span>; 
<a name="128" href="#128">128</a>         className = <span class="jxr_string">"&lt;not specified&gt;"</span>; 
<a name="129" href="#129">129</a>         MetadataFilterChain filterChain = <strong class="jxr_keyword">null</strong>;
<a name="130" href="#130">130</a>         filterChain = <strong class="jxr_keyword">new</strong> MetadataFilterChain();
<a name="131" href="#131">131</a>         <strong class="jxr_keyword">try</strong> {
<a name="132" href="#132">132</a>             NodeList itemElements = el.getElementsByTagNameNS(XMLConstants.CONFIG_NS, <span class="jxr_string">"Filter"</span>);
<a name="133" href="#133">133</a>             List &lt;MetadataFilter&gt; filters = <strong class="jxr_keyword">new</strong> ArrayList&lt;MetadataFilter&gt;(1 + itemElements.getLength());
<a name="134" href="#134">134</a>             
<a name="135" href="#135">135</a>             <em class="jxr_comment">//</em>
<a name="136" href="#136">136</a>             <em class="jxr_comment">// We always have a binding filter</em>
<a name="137" href="#137">137</a>             <em class="jxr_comment">//</em>
<a name="138" href="#138">138</a>             filters.add(<strong class="jxr_keyword">new</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/provider/BindingFilter.html">BindingFilter</a>(warnOnBadBinding));
<a name="139" href="#139">139</a>                 
<a name="140" href="#140">140</a>             <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i &lt; itemElements.getLength(); i++) {
<a name="141" href="#141">141</a>                 Element element = (Element) itemElements.item(i);
<a name="142" href="#142">142</a>    
<a name="143" href="#143">143</a>                 ident = <span class="jxr_string">"&lt;not specified&gt;"</span>; 
<a name="144" href="#144">144</a>                 className = <span class="jxr_string">"&lt;not specified&gt;"</span>; 
<a name="145" href="#145">145</a>             
<a name="146" href="#146">146</a>                 ident = element.getAttribute(<span class="jxr_string">"identifier"</span>);
<a name="147" href="#147">147</a> 
<a name="148" href="#148">148</a>                 <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">null</strong> == ident || ident.equals(<span class="jxr_string">""</span>)) {
<a name="149" href="#149">149</a>                     LOG.error(<span class="jxr_string">"Could not load filter with no identifier"</span>);
<a name="150" href="#150">150</a>                     <strong class="jxr_keyword">continue</strong>;
<a name="151" href="#151">151</a>                 }
<a name="152" href="#152">152</a>             
<a name="153" href="#153">153</a>                 className = element.getAttribute(<span class="jxr_string">"type"</span>);
<a name="154" href="#154">154</a>                 <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">null</strong> == className || className.equals(<span class="jxr_string">""</span>)) {
<a name="155" href="#155">155</a>                     LOG.error(<span class="jxr_string">"Filter "</span> + identifier + <span class="jxr_string">" did not have a valid type"</span>);
<a name="156" href="#156">156</a>                 }
<a name="157" href="#157">157</a>                 <em class="jxr_comment">//</em>
<a name="158" href="#158">158</a>                 <em class="jxr_comment">// So try to get hold of the Filter</em>
<a name="159" href="#159">159</a>                 <em class="jxr_comment">//</em>
<a name="160" href="#160">160</a>                 Class&lt;MetadataFilter&gt; filterClass = (Class&lt;MetadataFilter&gt;) Class.forName(className);
<a name="161" href="#161">161</a>                 Class[] classParams = {Element.<strong class="jxr_keyword">class</strong>};
<a name="162" href="#162">162</a>                 Constructor&lt;MetadataFilter&gt; constructor = filterClass.getConstructor(classParams);
<a name="163" href="#163">163</a>                 Object[] constructorParams = {element};
<a name="164" href="#164">164</a>             
<a name="165" href="#165">165</a>                 filters.add(constructor.newInstance(constructorParams));
<a name="166" href="#166">166</a>             }
<a name="167" href="#167">167</a>             filterChain.setFilters(filters);
<a name="168" href="#168">168</a>         } <strong class="jxr_keyword">catch</strong> (Exception e) {
<a name="169" href="#169">169</a>             LOG.error(<span class="jxr_string">"Could not load filter "</span> + ident + <span class="jxr_string">"()"</span> + className + <span class="jxr_string">") for "</span> + <strong class="jxr_keyword">this</strong>.identifier, e);
<a name="170" href="#170">170</a>             <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/common/ShibbolethConfigurationException.html">ShibbolethConfigurationException</a>(<span class="jxr_string">"Could not load filter"</span>, e);
<a name="171" href="#171">171</a>         }
<a name="172" href="#172">172</a>     
<a name="173" href="#173">173</a>         LOG.info(<span class="jxr_string">"Loading Metadata for "</span> + displayName);
<a name="174" href="#174">174</a>         <strong class="jxr_keyword">try</strong> {
<a name="175" href="#175">175</a>             <strong class="jxr_keyword">int</strong> delay;
<a name="176" href="#176">176</a>             delay = 30000;
<a name="177" href="#177">177</a>             <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">null</strong> != delayString &amp;&amp; !<span class="jxr_string">""</span>.equals(delayString)) {
<a name="178" href="#178">178</a>                 delay = Integer.parseInt(delayString);
<a name="179" href="#179">179</a>             }
<a name="180" href="#180">180</a>             
<a name="181" href="#181">181</a>             URL url = <strong class="jxr_keyword">new</strong> URL(location); 
<a name="182" href="#182">182</a>             <strong class="jxr_keyword">if</strong> (<span class="jxr_string">"file"</span>.equalsIgnoreCase(url.getProtocol())){
<a name="183" href="#183">183</a>                 FilesystemMetadataProvider provider = <strong class="jxr_keyword">new</strong> FilesystemMetadataProvider(<strong class="jxr_keyword">new</strong> File(url.getFile()));
<a name="184" href="#184">184</a>                 provider.setParserPool(parserPool);
<a name="185" href="#185">185</a>                 <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">null</strong> != filterChain) {
<a name="186" href="#186">186</a>                     provider.setMetadataFilter(filterChain);
<a name="187" href="#187">187</a>                 }
<a name="188" href="#188">188</a>                 provider.initialize();
<a name="189" href="#189">189</a>                 metadata = provider;
<a name="190" href="#190">190</a>             } <strong class="jxr_keyword">else</strong> {
<a name="191" href="#191">191</a>                 <strong class="jxr_keyword">if</strong> (spoolSpace == <strong class="jxr_keyword">null</strong> || <span class="jxr_string">""</span>.equals(spoolSpace)) {
<a name="192" href="#192">192</a>                     <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/common/ShibbolethConfigurationException.html">ShibbolethConfigurationException</a>(<span class="jxr_string">"backingFile must be specified for "</span> + identifier);
<a name="193" href="#193">193</a>                 }
<a name="194" href="#194">194</a>                 
<a name="195" href="#195">195</a>                 FileBackedHTTPMetadataProvider provider;
<a name="196" href="#196">196</a>             
<a name="197" href="#197">197</a>                 provider = <strong class="jxr_keyword">new</strong> FileBackedHTTPMetadataProvider(location, delay, spoolSpace);
<a name="198" href="#198">198</a>                 provider.setParserPool(parserPool);
<a name="199" href="#199">199</a>                 <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">null</strong> != filterChain) {
<a name="200" href="#200">200</a>                     provider.setMetadataFilter(filterChain);
<a name="201" href="#201">201</a>                 }
<a name="202" href="#202">202</a>                 provider.initialize();
<a name="203" href="#203">203</a>                 metadata = provider;
<a name="204" href="#204">204</a>             }
<a name="205" href="#205">205</a>         } <strong class="jxr_keyword">catch</strong> (MetadataProviderException e) {
<a name="206" href="#206">206</a>             <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/common/ShibbolethConfigurationException.html">ShibbolethConfigurationException</a>(<span class="jxr_string">"Could not read "</span> + location, e);
<a name="207" href="#207">207</a>         } <strong class="jxr_keyword">catch</strong> (NumberFormatException e) {
<a name="208" href="#208">208</a>             <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/common/ShibbolethConfigurationException.html">ShibbolethConfigurationException</a>(<span class="jxr_string">"Badly formed timeout "</span> + delayString, e);
<a name="209" href="#209">209</a>         } <strong class="jxr_keyword">catch</strong> (MalformedURLException e) {
<a name="210" href="#210">210</a>             <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/common/ShibbolethConfigurationException.html">ShibbolethConfigurationException</a>(<span class="jxr_string">"Badly formed url "</span>, e);
<a name="211" href="#211">211</a>         }
<a name="212" href="#212">212</a>         metadata.getObservers().add(<strong class="jxr_keyword">this</strong>);
<a name="213" href="#213">213</a>         onEvent(metadata);
<a name="214" href="#214">214</a>     }
<a name="215" href="#215">215</a> 
<a name="216" href="#216">216</a>     <em class="jxr_javadoccomment">/**</em>
<a name="217" href="#217">217</a> <em class="jxr_javadoccomment">     * Based on 1.2 Origin.isMatch.  There must have been a reason for it...</em>
<a name="218" href="#218">218</a> <em class="jxr_javadoccomment">     * [Kindas of] support for the search function in the wayf.  This return many false positives</em>
<a name="219" href="#219">219</a> <em class="jxr_javadoccomment">     * but given the aim is to provide input for a pull down list...</em>
<a name="220" href="#220">220</a> <em class="jxr_javadoccomment">     * </em>
<a name="221" href="#221">221</a> <em class="jxr_javadoccomment">     * @param entity   The entity to match.</em>
<a name="222" href="#222">222</a> <em class="jxr_javadoccomment">     * @param str      The patten to match against.</em>
<a name="223" href="#223">223</a> <em class="jxr_javadoccomment">     * @param config   Provides list of tokens to not lookup</em>
<a name="224" href="#224">224</a> <em class="jxr_javadoccomment">     * @return         Whether this entity matches  </em>
<a name="225" href="#225">225</a> <em class="jxr_javadoccomment">     */</em>
<a name="226" href="#226">226</a> 
<a name="227" href="#227">227</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">boolean</strong> isMatch(EntityDescriptor entity, String str, <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/HandlerConfig.html">HandlerConfig</a> config) {
<a name="228" href="#228">228</a>         
<a name="229" href="#229">229</a>         Enumeration input = <strong class="jxr_keyword">new</strong> StringTokenizer(str);
<a name="230" href="#230">230</a>         <strong class="jxr_keyword">while</strong> (input.hasMoreElements()) {
<a name="231" href="#231">231</a>             String currentToken = (String) input.nextElement();
<a name="232" href="#232">232</a> 
<a name="233" href="#233">233</a>             <strong class="jxr_keyword">if</strong> (config.isIgnoredForMatch(currentToken)) {                           
<a name="234" href="#234">234</a>                 <strong class="jxr_keyword">continue</strong>;
<a name="235" href="#235">235</a>             }
<a name="236" href="#236">236</a>                 
<a name="237" href="#237">237</a>             currentToken = currentToken.toLowerCase(); 
<a name="238" href="#238">238</a> 
<a name="239" href="#239">239</a>             <strong class="jxr_keyword">if</strong> (entity.getEntityID().indexOf(currentToken) &gt; -1) {
<a name="240" href="#240">240</a>                 <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>; 
<a name="241" href="#241">241</a>             }
<a name="242" href="#242">242</a>                                 
<a name="243" href="#243">243</a>             Organization org = entity.getOrganization();
<a name="244" href="#244">244</a>                 
<a name="245" href="#245">245</a>             <strong class="jxr_keyword">if</strong> (org != <strong class="jxr_keyword">null</strong>) {
<a name="246" href="#246">246</a>                         
<a name="247" href="#247">247</a>                 List &lt;OrganizationName&gt; orgNames = org.getOrganizationNames();
<a name="248" href="#248">248</a>                 <strong class="jxr_keyword">for</strong> (OrganizationName name : orgNames) {
<a name="249" href="#249">249</a>                     <strong class="jxr_keyword">if</strong> (name.getName().getLocalString().indexOf(currentToken) &gt; -1) {
<a name="250" href="#250">250</a>                         <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
<a name="251" href="#251">251</a>                     }
<a name="252" href="#252">252</a>                 }
<a name="253" href="#253">253</a>                         
<a name="254" href="#254">254</a>                 List &lt;OrganizationDisplayName&gt; orgDisplayNames = org.getDisplayNames();
<a name="255" href="#255">255</a>                 <strong class="jxr_keyword">for</strong> (OrganizationDisplayName name : orgDisplayNames) {
<a name="256" href="#256">256</a>                     <strong class="jxr_keyword">if</strong> (name.getName().getLocalString().indexOf(currentToken) &gt; -1) {
<a name="257" href="#257">257</a>                         <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
<a name="258" href="#258">258</a>                     }
<a name="259" href="#259">259</a>                 }                                
<a name="260" href="#260">260</a>             }
<a name="261" href="#261">261</a>         }
<a name="262" href="#262">262</a>         <strong class="jxr_keyword">return</strong> false;
<a name="263" href="#263">263</a>     }
<a name="264" href="#264">264</a> 
<a name="265" href="#265">265</a>     <em class="jxr_javadoccomment">/**</em>
<a name="266" href="#266">266</a> <em class="jxr_javadoccomment">     * Return all the Idp in the provided entities descriptor.  If SearchMatches</em>
<a name="267" href="#267">267</a> <em class="jxr_javadoccomment">     * is non null it is populated with whatever of the IdPs matches the search string </em>
<a name="268" href="#268">268</a> <em class="jxr_javadoccomment">     * (as noted above). </em>
<a name="269" href="#269">269</a> <em class="jxr_javadoccomment">     * @param searchString to match with</em>
<a name="270" href="#270">270</a> <em class="jxr_javadoccomment">     * @param config parameter to mathing</em>
<a name="271" href="#271">271</a> <em class="jxr_javadoccomment">     * @param searchMatches if non null is filled with such of the sites which match the string</em>
<a name="272" href="#272">272</a> <em class="jxr_javadoccomment">     * @return the sites which fit.</em>
<a name="273" href="#273">273</a> <em class="jxr_javadoccomment">     */</em>
<a name="274" href="#274">274</a>     <strong class="jxr_keyword">protected</strong> Map&lt;String, IdPSite&gt; getIdPSites(String searchString, 
<a name="275" href="#275">275</a>                                                <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/HandlerConfig.html">HandlerConfig</a> config, 
<a name="276" href="#276">276</a>                                                Collection&lt;IdPSite&gt; searchMatches)
<a name="277" href="#277">277</a>     {
<a name="278" href="#278">278</a>         XMLObject object;
<a name="279" href="#279">279</a>         List &lt;EntityDescriptor&gt; entities;
<a name="280" href="#280">280</a>         <strong class="jxr_keyword">try</strong> {
<a name="281" href="#281">281</a>             object = metadata.getMetadata();
<a name="282" href="#282">282</a>         } <strong class="jxr_keyword">catch</strong> (MetadataProviderException e) {
<a name="283" href="#283">283</a>             LOG.error(<span class="jxr_string">"Metadata for "</span> + location + <span class="jxr_string">"could not be read"</span>, e);
<a name="284" href="#284">284</a>             <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a name="285" href="#285">285</a>         }
<a name="286" href="#286">286</a>         
<a name="287" href="#287">287</a>         <strong class="jxr_keyword">if</strong> (object == <strong class="jxr_keyword">null</strong>) {
<a name="288" href="#288">288</a>             <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a name="289" href="#289">289</a>         }
<a name="290" href="#290">290</a>         
<a name="291" href="#291">291</a>         <em class="jxr_comment">//</em>
<a name="292" href="#292">292</a>         <em class="jxr_comment">// Fill in entities approptiately</em>
<a name="293" href="#293">293</a>         <em class="jxr_comment">//</em>
<a name="294" href="#294">294</a>         
<a name="295" href="#295">295</a>         <strong class="jxr_keyword">if</strong> (object instanceof EntityDescriptor) {
<a name="296" href="#296">296</a>             entities = <strong class="jxr_keyword">new</strong> ArrayList&lt;EntityDescriptor&gt;(1);
<a name="297" href="#297">297</a>             entities.add((EntityDescriptor) object);
<a name="298" href="#298">298</a>         } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (object instanceof EntitiesDescriptor) {
<a name="299" href="#299">299</a> 
<a name="300" href="#300">300</a>             EntitiesDescriptor entitiesDescriptor = (EntitiesDescriptor) object; 
<a name="301" href="#301">301</a>     
<a name="302" href="#302">302</a>             entities = entitiesDescriptor.getEntityDescriptors();
<a name="303" href="#303">303</a>         } <strong class="jxr_keyword">else</strong> {
<a name="304" href="#304">304</a>            <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a name="305" href="#305">305</a>         }
<a name="306" href="#306">306</a>        
<a name="307" href="#307">307</a>         <em class="jxr_comment">//</em>
<a name="308" href="#308">308</a>         <em class="jxr_comment">// populate the result (and the searchlist) from the entities list</em>
<a name="309" href="#309">309</a>         <em class="jxr_comment">//</em>
<a name="310" href="#310">310</a>         
<a name="311" href="#311">311</a>         TreeMap&lt;String, IdPSite&gt; result = <strong class="jxr_keyword">new</strong> TreeMap &lt;String,IdPSite&gt;();
<a name="312" href="#312">312</a>                     
<a name="313" href="#313">313</a>         <strong class="jxr_keyword">for</strong> (EntityDescriptor entity : entities) {
<a name="314" href="#314">314</a>                 
<a name="315" href="#315">315</a>             <strong class="jxr_keyword">if</strong> (entity.isValid() &amp;&amp; hasIdPRole(entity)) {
<a name="316" href="#316">316</a> 
<a name="317" href="#317">317</a>                 <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/IdPSite.html">IdPSite</a> site = <strong class="jxr_keyword">new</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/IdPSite.html">IdPSite</a>(entity);
<a name="318" href="#318">318</a>                 result.put(site.getName(), site);
<a name="319" href="#319">319</a>                 <strong class="jxr_keyword">if</strong> (searchMatches != <strong class="jxr_keyword">null</strong> &amp;&amp; isMatch(entity, searchString, config)) {           
<a name="320" href="#320">320</a> 
<a name="321" href="#321">321</a>                     searchMatches.add(site);
<a name="322" href="#322">322</a>                 }
<a name="323" href="#323">323</a> 
<a name="324" href="#324">324</a>             }
<a name="325" href="#325">325</a>         } <em class="jxr_comment">// iterate over all entities</em>
<a name="326" href="#326">326</a>         <strong class="jxr_keyword">return</strong> result;
<a name="327" href="#327">327</a>     }
<a name="328" href="#328">328</a> 
<a name="329" href="#329">329</a> 
<a name="330" href="#330">330</a>     <em class="jxr_javadoccomment">/**</em>
<a name="331" href="#331">331</a> <em class="jxr_javadoccomment">     * Return this sites (internal) identifier.</em>
<a name="332" href="#332">332</a> <em class="jxr_javadoccomment">     * @return the identifier</em>
<a name="333" href="#333">333</a> <em class="jxr_javadoccomment">     */</em>
<a name="334" href="#334">334</a>     <strong class="jxr_keyword">protected</strong> String getIdentifier() {
<a name="335" href="#335">335</a>         <strong class="jxr_keyword">return</strong> identifier;
<a name="336" href="#336">336</a>     }
<a name="337" href="#337">337</a> 
<a name="338" href="#338">338</a>     <em class="jxr_javadoccomment">/**</em>
<a name="339" href="#339">339</a> <em class="jxr_javadoccomment">     * Return the human friendly name for this siteset.</em>
<a name="340" href="#340">340</a> <em class="jxr_javadoccomment">     * @return The friendly name</em>
<a name="341" href="#341">341</a> <em class="jxr_javadoccomment">     */</em>
<a name="342" href="#342">342</a>     <strong class="jxr_keyword">protected</strong> String getDisplayName() {
<a name="343" href="#343">343</a>         <strong class="jxr_keyword">return</strong> displayName;
<a name="344" href="#344">344</a>     }
<a name="345" href="#345">345</a> 
<a name="346" href="#346">346</a>     <em class="jxr_javadoccomment">/**</em>
<a name="347" href="#347">347</a> <em class="jxr_javadoccomment">     * We do not need to look at a set if it doesn't know about the given SP.  However if</em>
<a name="348" href="#348">348</a> <em class="jxr_javadoccomment">     * no SP is given (as per 1.1) then we do need to look.  This calls lets us know whether </em>
<a name="349" href="#349">349</a> <em class="jxr_javadoccomment">     * this set is a canddiate for looking into.</em>
<a name="350" href="#350">350</a> <em class="jxr_javadoccomment">     * @param SPName the Sp we are interested in.</em>
<a name="351" href="#351">351</a> <em class="jxr_javadoccomment">     * @return whether the site contains the SP.</em>
<a name="352" href="#352">352</a> <em class="jxr_javadoccomment">     */</em>
<a name="353" href="#353">353</a>     <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> containsSP(String SPName) {
<a name="354" href="#354">354</a> 
<a name="355" href="#355">355</a>         <em class="jxr_comment">//</em>
<a name="356" href="#356">356</a>         <em class="jxr_comment">// Deal with the case where we do *not* want to search by</em>
<a name="357" href="#357">357</a>         <em class="jxr_comment">// SP (also handles the 1.1 case)</em>
<a name="358" href="#358">358</a>         <em class="jxr_comment">//</em>
<a name="359" href="#359">359</a>         
<a name="360" href="#360">360</a>         <strong class="jxr_keyword">if</strong> ((SPName == <strong class="jxr_keyword">null</strong>) || (SPName.length() == 0)) {
<a name="361" href="#361">361</a>             <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
<a name="362" href="#362">362</a>         }
<a name="363" href="#363">363</a> 
<a name="364" href="#364">364</a>         <em class="jxr_comment">//</em>
<a name="365" href="#365">365</a>         <em class="jxr_comment">// Get hold of the current object list so as to provoke observer to fire </em>
<a name="366" href="#366">366</a>         <em class="jxr_comment">// if needs be.</em>
<a name="367" href="#367">367</a>         <em class="jxr_comment">// </em>
<a name="368" href="#368">368</a>         
<a name="369" href="#369">369</a>         XMLObject object;
<a name="370" href="#370">370</a>         <strong class="jxr_keyword">try</strong> {
<a name="371" href="#371">371</a>             object = metadata.getMetadata();
<a name="372" href="#372">372</a>         } <strong class="jxr_keyword">catch</strong> (MetadataProviderException e) {
<a name="373" href="#373">373</a>             <strong class="jxr_keyword">return</strong> false;
<a name="374" href="#374">374</a>         }
<a name="375" href="#375">375</a>         <em class="jxr_comment">//</em>
<a name="376" href="#376">376</a>         <em class="jxr_comment">// Now lookup</em>
<a name="377" href="#377">377</a>         <em class="jxr_comment">//</em>
<a name="378" href="#378">378</a> 
<a name="379" href="#379">379</a>         <strong class="jxr_keyword">if</strong> (object instanceof EntitiesDescriptor ||
<a name="380" href="#380">380</a>             object instanceof EntityDescriptor) {
<a name="381" href="#381">381</a>             <strong class="jxr_keyword">return</strong> spNames.contains(SPName);
<a name="382" href="#382">382</a>         } <strong class="jxr_keyword">else</strong> {
<a name="383" href="#383">383</a>             <strong class="jxr_keyword">return</strong> false;
<a name="384" href="#384">384</a>         }
<a name="385" href="#385">385</a>     }
<a name="386" href="#386">386</a> 
<a name="387" href="#387">387</a>     <em class="jxr_javadoccomment">/**</em>
<a name="388" href="#388">388</a> <em class="jxr_javadoccomment">     * For plugin handling we need to know quickly if a metadataset contains the idp.</em>
<a name="389" href="#389">389</a> <em class="jxr_javadoccomment">     * @param IdPName the IdP we are interested in.</em>
<a name="390" href="#390">390</a> <em class="jxr_javadoccomment">     * @return whether the site contains the IdP.</em>
<a name="391" href="#391">391</a> <em class="jxr_javadoccomment">     * </em>
<a name="392" href="#392">392</a> <em class="jxr_javadoccomment">     */</em>
<a name="393" href="#393">393</a> 
<a name="394" href="#394">394</a>     <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> containsIdP(String IdPName) {
<a name="395" href="#395">395</a>         
<a name="396" href="#396">396</a>         <strong class="jxr_keyword">if</strong> ((IdPName == <strong class="jxr_keyword">null</strong>) || (IdPName.length() == 0)) {
<a name="397" href="#397">397</a>             <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
<a name="398" href="#398">398</a>         }
<a name="399" href="#399">399</a> 
<a name="400" href="#400">400</a>         <em class="jxr_comment">//</em>
<a name="401" href="#401">401</a>         <em class="jxr_comment">// Get hold of the current object list so as to provoke observer to fire </em>
<a name="402" href="#402">402</a>         <em class="jxr_comment">// if needs be.</em>
<a name="403" href="#403">403</a>         <em class="jxr_comment">// </em>
<a name="404" href="#404">404</a>         
<a name="405" href="#405">405</a>         XMLObject object;
<a name="406" href="#406">406</a>         <strong class="jxr_keyword">try</strong> {
<a name="407" href="#407">407</a>             object = metadata.getMetadata();
<a name="408" href="#408">408</a>         } <strong class="jxr_keyword">catch</strong> (MetadataProviderException e) {
<a name="409" href="#409">409</a>             <strong class="jxr_keyword">return</strong> false;
<a name="410" href="#410">410</a>         }
<a name="411" href="#411">411</a>         <strong class="jxr_keyword">if</strong> (object instanceof EntitiesDescriptor ||
<a name="412" href="#412">412</a>             object instanceof EntityDescriptor) {
<a name="413" href="#413">413</a>             <strong class="jxr_keyword">return</strong> idpNames.contains(IdPName);
<a name="414" href="#414">414</a>         } <strong class="jxr_keyword">else</strong> {
<a name="415" href="#415">415</a>             <strong class="jxr_keyword">return</strong> false;
<a name="416" href="#416">416</a>         }
<a name="417" href="#417">417</a>     }
<a name="418" href="#418">418</a> 
<a name="419" href="#419">419</a>     <em class="jxr_comment">//</em>
<a name="420" href="#420">420</a>     <em class="jxr_comment">// Now deal with plugins - these are delcared to use but we are</em>
<a name="421" href="#421">421</a>     <em class="jxr_comment">// responsible for their parameter</em>
<a name="422" href="#422">422</a>     <em class="jxr_comment">//</em>
<a name="423" href="#423">423</a> 
<a name="424" href="#424">424</a>     <em class="jxr_javadoccomment">/**</em>
<a name="425" href="#425">425</a> <em class="jxr_javadoccomment">     * Declares a plugin to the siteset.</em>
<a name="426" href="#426">426</a> <em class="jxr_javadoccomment">     * @param plugin what to declare</em>
<a name="427" href="#427">427</a> <em class="jxr_javadoccomment">     */</em>
<a name="428" href="#428">428</a>     <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> addPlugin(<a href="../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/Plugin.html">Plugin</a> plugin) {
<a name="429" href="#429">429</a> 
<a name="430" href="#430">430</a>         <strong class="jxr_keyword">if</strong> (plugins.containsKey(plugin)) {
<a name="431" href="#431">431</a>             <strong class="jxr_keyword">return</strong>;
<a name="432" href="#432">432</a>         }
<a name="433" href="#433">433</a>         
<a name="434" href="#434">434</a>         <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/PluginMetadataParameter.html">PluginMetadataParameter</a> param = plugin.refreshMetadata(metadata);
<a name="435" href="#435">435</a>         
<a name="436" href="#436">436</a>         plugins.put(plugin, param);
<a name="437" href="#437">437</a>     }
<a name="438" href="#438">438</a> 
<a name="439" href="#439">439</a>     <em class="jxr_javadoccomment">/**</em>
<a name="440" href="#440">440</a> <em class="jxr_javadoccomment">     * Return the parameter that this plugin uses.</em>
<a name="441" href="#441">441</a> <em class="jxr_javadoccomment">     * @param plugin</em>
<a name="442" href="#442">442</a> <em class="jxr_javadoccomment">     * @return teh parameter.</em>
<a name="443" href="#443">443</a> <em class="jxr_javadoccomment">     */</em>
<a name="444" href="#444">444</a>     <strong class="jxr_keyword">protected</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/PluginMetadataParameter.html">PluginMetadataParameter</a> paramFor(<a href="../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/Plugin.html">Plugin</a> plugin) {
<a name="445" href="#445">445</a>         <strong class="jxr_keyword">return</strong> plugins.get(plugin);
<a name="446" href="#446">446</a>     }
<a name="447" href="#447">447</a> 
<a name="448" href="#448">448</a> 
<a name="449" href="#449">449</a>     <em class="jxr_comment">/*<em class="jxr_comment"> (non-Javadoc)</em></em>
<a name="450" href="#450">450</a> <em class="jxr_comment">     * @see org.opensaml.saml2.metadata.provider.ObservableMetadataProvider.Observer#onEvent(org.opensaml.saml2.metadata.provider.MetadataProvider)</em>
<a name="451" href="#451">451</a> <em class="jxr_comment">     */</em>
<a name="452" href="#452">452</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> onEvent(MetadataProvider provider) {
<a name="453" href="#453">453</a>         Set&lt;String&gt; spNameSet = <strong class="jxr_keyword">new</strong> HashSet&lt;String&gt;(0);
<a name="454" href="#454">454</a>         Set&lt;String&gt; idpNameSet = <strong class="jxr_keyword">new</strong> HashSet&lt;String&gt;(0);
<a name="455" href="#455">455</a> 
<a name="456" href="#456">456</a>         XMLObject obj; 
<a name="457" href="#457">457</a>         <strong class="jxr_keyword">try</strong> {
<a name="458" href="#458">458</a>             obj = provider.getMetadata();
<a name="459" href="#459">459</a>         } <strong class="jxr_keyword">catch</strong> (MetadataProviderException e) {
<a name="460" href="#460">460</a>             LOG.error(<span class="jxr_string">"Couldn't read metadata for "</span> + location, e);
<a name="461" href="#461">461</a>             <strong class="jxr_keyword">return</strong>;
<a name="462" href="#462">462</a>         }
<a name="463" href="#463">463</a>         <strong class="jxr_keyword">if</strong> ((obj instanceof EntitiesDescriptor)) {
<a name="464" href="#464">464</a>             EntitiesDescriptor entitiesDescriptor = (EntitiesDescriptor) obj;
<a name="465" href="#465">465</a>             
<a name="466" href="#466">466</a>             <strong class="jxr_keyword">for</strong> (EntityDescriptor entity : entitiesDescriptor.getEntityDescriptors()) {
<a name="467" href="#467">467</a>                 <strong class="jxr_keyword">if</strong> (hasSPRole(entity)) {
<a name="468" href="#468">468</a>                     spNameSet.add(entity.getEntityID());
<a name="469" href="#469">469</a>                 }
<a name="470" href="#470">470</a>                 <strong class="jxr_keyword">if</strong> (hasIdPRole(entity)) {
<a name="471" href="#471">471</a>                     idpNameSet.add(entity.getEntityID());
<a name="472" href="#472">472</a>                 }
<a name="473" href="#473">473</a>             }
<a name="474" href="#474">474</a>         } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (obj instanceof EntityDescriptor) {
<a name="475" href="#475">475</a>             EntityDescriptor entity = (EntityDescriptor) obj;
<a name="476" href="#476">476</a>             <strong class="jxr_keyword">if</strong> (hasSPRole(entity)) {
<a name="477" href="#477">477</a>                 spNameSet.add(entity.getEntityID());
<a name="478" href="#478">478</a>             }
<a name="479" href="#479">479</a>             <strong class="jxr_keyword">if</strong> (hasIdPRole(entity)) {
<a name="480" href="#480">480</a>                 idpNameSet.add(entity.getEntityID());
<a name="481" href="#481">481</a>             }
<a name="482" href="#482">482</a>         } <strong class="jxr_keyword">else</strong> {
<a name="483" href="#483">483</a>             LOG.error(<span class="jxr_string">"Metadata for "</span> + location + <span class="jxr_string">" isn't &lt;EntitiesDescriptor&gt; or &lt;EntityDescriptor&gt;"</span>);
<a name="484" href="#484">484</a>             <strong class="jxr_keyword">return</strong>;
<a name="485" href="#485">485</a>         }
<a name="486" href="#486">486</a>         <em class="jxr_comment">//</em>
<a name="487" href="#487">487</a>         <em class="jxr_comment">// Now that we have the new set sorted out commit it in</em>
<a name="488" href="#488">488</a>         <em class="jxr_comment">//</em>
<a name="489" href="#489">489</a>         <strong class="jxr_keyword">this</strong>.spNames = spNameSet;
<a name="490" href="#490">490</a>         <strong class="jxr_keyword">this</strong>.idpNames = idpNameSet;
<a name="491" href="#491">491</a>         
<a name="492" href="#492">492</a>         <strong class="jxr_keyword">for</strong> (Plugin plugin:plugins.keySet()) {
<a name="493" href="#493">493</a>             plugins.put(plugin, plugin.refreshMetadata(provider));
<a name="494" href="#494">494</a>         }
<a name="495" href="#495">495</a>     }
<a name="496" href="#496">496</a> 
<a name="497" href="#497">497</a>     <em class="jxr_javadoccomment">/**</em>
<a name="498" href="#498">498</a> <em class="jxr_javadoccomment">     * Enumerate all the roles and see whether this entity can be an IdP.</em>
<a name="499" href="#499">499</a> <em class="jxr_javadoccomment">     * @param entity</em>
<a name="500" href="#500">500</a> <em class="jxr_javadoccomment">     * @return true if one of the roles that entity has is IdPSSO</em>
<a name="501" href="#501">501</a> <em class="jxr_javadoccomment">     */</em>
<a name="502" href="#502">502</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">boolean</strong> hasIdPRole(EntityDescriptor entity) {
<a name="503" href="#503">503</a>         List&lt;RoleDescriptor&gt; roles = entity.getRoleDescriptors();
<a name="504" href="#504">504</a>         
<a name="505" href="#505">505</a>         <strong class="jxr_keyword">for</strong> (RoleDescriptor role:roles) {
<a name="506" href="#506">506</a>            <strong class="jxr_keyword">if</strong> (role instanceof IDPSSODescriptor) {
<a name="507" href="#507">507</a>                <em class="jxr_comment">//</em>
<a name="508" href="#508">508</a>                <em class="jxr_comment">// So the entity knows how to be some sort of an Idp</em>
<a name="509" href="#509">509</a>                <em class="jxr_comment">//</em>
<a name="510" href="#510">510</a>                <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;            
<a name="511" href="#511">511</a>            }
<a name="512" href="#512">512</a>         }
<a name="513" href="#513">513</a>         <strong class="jxr_keyword">return</strong> false;
<a name="514" href="#514">514</a>     }
<a name="515" href="#515">515</a> 
<a name="516" href="#516">516</a>     <em class="jxr_javadoccomment">/**</em>
<a name="517" href="#517">517</a> <em class="jxr_javadoccomment">     * Enumerate all the roles and see whether this entity can be an SP.</em>
<a name="518" href="#518">518</a> <em class="jxr_javadoccomment">     * @param entity</em>
<a name="519" href="#519">519</a> <em class="jxr_javadoccomment">     * @return true if one of the roles that entity has is SPSSO</em>
<a name="520" href="#520">520</a> <em class="jxr_javadoccomment">     */</em>
<a name="521" href="#521">521</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">boolean</strong> hasSPRole(EntityDescriptor entity) {
<a name="522" href="#522">522</a>         List&lt;RoleDescriptor&gt; roles = entity.getRoleDescriptors();
<a name="523" href="#523">523</a>         
<a name="524" href="#524">524</a>         <strong class="jxr_keyword">for</strong> (RoleDescriptor role:roles) {
<a name="525" href="#525">525</a>            <strong class="jxr_keyword">if</strong> (role instanceof SPSSODescriptor) {
<a name="526" href="#526">526</a>                <em class="jxr_comment">//</em>
<a name="527" href="#527">527</a>                <em class="jxr_comment">// "I can do that"</em>
<a name="528" href="#528">528</a>                <em class="jxr_comment">//</em>
<a name="529" href="#529">529</a>                <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
<a name="530" href="#530">530</a>            }
<a name="531" href="#531">531</a>         }
<a name="532" href="#532">532</a>         <strong class="jxr_keyword">return</strong> false;
<a name="533" href="#533">533</a>     }
<a name="534" href="#534">534</a> 
<a name="535" href="#535">535</a>     <em class="jxr_javadoccomment">/**</em>
<a name="536" href="#536">536</a> <em class="jxr_javadoccomment">     * Return the idpSite for the given entity name.</em>
<a name="537" href="#537">537</a> <em class="jxr_javadoccomment">     * @param idpName the entityname to look up</em>
<a name="538" href="#538">538</a> <em class="jxr_javadoccomment">     * @return the associated idpSite</em>
<a name="539" href="#539">539</a> <em class="jxr_javadoccomment">     * @throws WayfException</em>
<a name="540" href="#540">540</a> <em class="jxr_javadoccomment">     */</em>
<a name="541" href="#541">541</a>     <strong class="jxr_keyword">protected</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/IdPSite.html">IdPSite</a> getSite(String idpName) <strong class="jxr_keyword">throws</strong> WayfException {
<a name="542" href="#542">542</a> 
<a name="543" href="#543">543</a>         <strong class="jxr_keyword">try</strong> {
<a name="544" href="#544">544</a>             <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/IdPSite.html">IdPSite</a>(metadata.getEntityDescriptor(idpName));
<a name="545" href="#545">545</a>         } <strong class="jxr_keyword">catch</strong> (MetadataProviderException e) {
<a name="546" href="#546">546</a>             String s = <span class="jxr_string">"Couldn't resolve "</span> + idpName + <span class="jxr_string">" in "</span>  + getDisplayName();
<a name="547" href="#547">547</a>             LOG.error(s, e);
<a name="548" href="#548">548</a>             <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/WayfException.html">WayfException</a>(s, e);
<a name="549" href="#549">549</a>         }
<a name="550" href="#550">550</a>     }
<a name="551" href="#551">551</a>     
<a name="552" href="#552">552</a>     <strong class="jxr_keyword">protected</strong> EntityDescriptor getEntity(String name) <strong class="jxr_keyword">throws</strong> WayfException {
<a name="553" href="#553">553</a>         <strong class="jxr_keyword">try</strong> {
<a name="554" href="#554">554</a>             <strong class="jxr_keyword">return</strong> metadata.getEntityDescriptor(name);
<a name="555" href="#555">555</a>         } <strong class="jxr_keyword">catch</strong> (MetadataProviderException e) {
<a name="556" href="#556">556</a>             String s = <span class="jxr_string">"Couldn't resolve "</span> + name + <span class="jxr_string">" in "</span>  + getDisplayName();
<a name="557" href="#557">557</a>             LOG.error(s, e);
<a name="558" href="#558">558</a>             <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/WayfException.html">WayfException</a>(s, e);
<a name="559" href="#559">559</a>         }
<a name="560" href="#560">560</a>         
<a name="561" href="#561">561</a>     }
<a name="562" href="#562">562</a> }
<a name="563" href="#563">563</a> 
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>