<!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>DiscoveryServiceHandler xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../apidocs/edu/internet2/middleware/shibboleth/wayf/DiscoveryServiceHandler.html">View Javadoc</a></div><pre>
<a name="1" href="#1">1</a> <em class="jxr_javadoccomment">/**</em>
<a name="2" href="#2">2</a> <em class="jxr_javadoccomment"> * Copyright [2006] [University Corporation for Advanced Internet Development, Inc.]</em>
<a name="3" href="#3">3</a> <em class="jxr_javadoccomment"> *</em>
<a name="4" href="#4">4</a> <em class="jxr_javadoccomment"> * Licensed under the Apache License, Version 2.0 (the "License");</em>
<a name="5" href="#5">5</a> <em class="jxr_javadoccomment"> * you may not use this file except in compliance with the License.</em>
<a name="6" href="#6">6</a> <em class="jxr_javadoccomment"> * You may obtain a copy of the License at</em>
<a name="7" href="#7">7</a> <em class="jxr_javadoccomment"> *</em>
<a name="8" href="#8">8</a> <em class="jxr_javadoccomment"> * <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_javadoccomment"> *</em>
<a name="10" href="#10">10</a> <em class="jxr_javadoccomment"> * Unless required by applicable law or agreed to in writing, software</em>
<a name="11" href="#11">11</a> <em class="jxr_javadoccomment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
<a name="12" href="#12">12</a> <em class="jxr_javadoccomment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a name="13" href="#13">13</a> <em class="jxr_javadoccomment"> * See the License for the specific language governing permissions and</em>
<a name="14" href="#14">14</a> <em class="jxr_javadoccomment"> * limitations under the License.</em>
<a name="15" href="#15">15</a> <em class="jxr_javadoccomment"> */</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.IOException;
<a name="19" href="#19">19</a> <strong class="jxr_keyword">import</strong> java.io.UnsupportedEncodingException;
<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.net.URLDecoder;
<a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> java.net.URLEncoder;
<a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> java.util.ArrayList;
<a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> java.util.Collection;
<a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> java.util.Comparator;
<a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> java.util.Date;
<a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> java.util.HashSet;
<a name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> java.util.Hashtable;
<a name="30" href="#30">30</a> <strong class="jxr_keyword">import</strong> java.util.List;
<a name="31" href="#31">31</a> <strong class="jxr_keyword">import</strong> java.util.Locale;
<a name="32" href="#32">32</a> <strong class="jxr_keyword">import</strong> java.util.Map;
<a name="33" href="#33">33</a> <strong class="jxr_keyword">import</strong> java.util.Set;
<a name="34" href="#34">34</a> <strong class="jxr_keyword">import</strong> java.util.TreeSet;
<a name="35" href="#35">35</a>
<a name="36" href="#36">36</a> <strong class="jxr_keyword">import</strong> javax.servlet.RequestDispatcher;
<a name="37" href="#37">37</a> <strong class="jxr_keyword">import</strong> javax.servlet.ServletException;
<a name="38" href="#38">38</a> <strong class="jxr_keyword">import</strong> javax.servlet.http.HttpServletRequest;
<a name="39" href="#39">39</a> <strong class="jxr_keyword">import</strong> javax.servlet.http.HttpServletResponse;
<a name="40" href="#40">40</a>
<a name="41" href="#41">41</a> <strong class="jxr_keyword">import</strong> org.opensaml.saml2.common.Extensions;
<a name="42" href="#42">42</a> <strong class="jxr_keyword">import</strong> org.opensaml.saml2.metadata.EntityDescriptor;
<a name="43" href="#43">43</a> <strong class="jxr_keyword">import</strong> org.opensaml.saml2.metadata.RoleDescriptor;
<a name="44" href="#44">44</a> <strong class="jxr_keyword">import</strong> org.opensaml.saml2.metadata.SPSSODescriptor;
<a name="45" href="#45">45</a> <strong class="jxr_keyword">import</strong> org.opensaml.samlext.idpdisco.DiscoveryResponse;
<a name="46" href="#46">46</a> <strong class="jxr_keyword">import</strong> org.opensaml.xml.XMLObject;
<a name="47" href="#47">47</a> <strong class="jxr_keyword">import</strong> org.slf4j.Logger;
<a name="48" href="#48">48</a> <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory;
<a name="49" href="#49">49</a> <strong class="jxr_keyword">import</strong> org.w3c.dom.Element;
<a name="50" href="#50">50</a> <strong class="jxr_keyword">import</strong> org.w3c.dom.NodeList;
<a name="51" href="#51">51</a>
<a name="52" href="#52">52</a> <strong class="jxr_keyword">import</strong> edu.internet2.middleware.shibboleth.common.ShibbolethConfigurationException;
<a name="53" href="#53">53</a> <strong class="jxr_keyword">import</strong> edu.internet2.middleware.shibboleth.wayf.plugins.Plugin;
<a name="54" href="#54">54</a> <strong class="jxr_keyword">import</strong> edu.internet2.middleware.shibboleth.wayf.plugins.PluginContext;
<a name="55" href="#55">55</a> <strong class="jxr_keyword">import</strong> edu.internet2.middleware.shibboleth.wayf.plugins.PluginMetadataParameter;
<a name="56" href="#56">56</a> <strong class="jxr_keyword">import</strong> edu.internet2.middleware.shibboleth.wayf.plugins.WayfRequestHandled;
<a name="57" href="#57">57</a>
<a name="58" href="#58">58</a> <em class="jxr_javadoccomment">/**</em>
<a name="59" href="#59">59</a> <em class="jxr_javadoccomment"> * Specific handler for each version of the Discovery Service. </em>
<a name="60" href="#60">60</a> <em class="jxr_javadoccomment"> */</em>
<a name="61" href="#61">61</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/DiscoveryServiceHandler.html">DiscoveryServiceHandler</a> {
<a name="62" href="#62">62</a>
<a name="63" href="#63">63</a> <em class="jxr_comment">/*</em>
<a name="64" href="#64">64</a> <em class="jxr_comment"> * Protcol parameters - Old.</em>
<a name="65" href="#65">65</a> <em class="jxr_comment"> */</em>
<a name="66" href="#66">66</a> <em class="jxr_javadoccomment">/**</em>
<a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> * Shire is the SP Assertion Consumer endpoint.</em>
<a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> */</em>
<a name="69" href="#69">69</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String SHIRE_PARAM_NAME = <span class="jxr_string">"shire"</span>;
<a name="70" href="#70">70</a> <em class="jxr_javadoccomment">/**</em>
<a name="71" href="#71">71</a> <em class="jxr_javadoccomment"> * TargetName is where we are trying to get to.</em>
<a name="72" href="#72">72</a> <em class="jxr_javadoccomment"> */</em>
<a name="73" href="#73">73</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String TARGET_PARAM_NAME = <span class="jxr_string">"target"</span>;
<a name="74" href="#74">74</a> <em class="jxr_javadoccomment">/**</em>
<a name="75" href="#75">75</a> <em class="jxr_javadoccomment"> * time is to do with replay attack.</em>
<a name="76" href="#76">76</a> <em class="jxr_javadoccomment"> */</em>
<a name="77" href="#77">77</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String TIME_PARAM_NAME = <span class="jxr_string">"time"</span>;
<a name="78" href="#78">78</a> <em class="jxr_javadoccomment">/**</em>
<a name="79" href="#79">79</a> <em class="jxr_javadoccomment"> * This is the ID (in the metadata) of the SP.</em>
<a name="80" href="#80">80</a> <em class="jxr_javadoccomment"> */</em>
<a name="81" href="#81">81</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String PROVIDERID_PARAM_NAME = <span class="jxr_string">"providerId"</span>;
<a name="82" href="#82">82</a>
<a name="83" href="#83">83</a> <em class="jxr_comment">/*</em>
<a name="84" href="#84">84</a> <em class="jxr_comment"> * Protocol parameters - New</em>
<a name="85" href="#85">85</a> <em class="jxr_comment"> */</em>
<a name="86" href="#86">86</a> <em class="jxr_javadoccomment">/**</em>
<a name="87" href="#87">87</a> <em class="jxr_javadoccomment"> * The SP id.</em>
<a name="88" href="#88">88</a> <em class="jxr_javadoccomment"> */</em>
<a name="89" href="#89">89</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String ENTITYID_PARAM_NAME = <span class="jxr_string">"entityID"</span>;
<a name="90" href="#90">90</a> <em class="jxr_javadoccomment">/**</em>
<a name="91" href="#91">91</a> <em class="jxr_javadoccomment"> * Where to send the request back to.</em>
<a name="92" href="#92">92</a> <em class="jxr_javadoccomment"> */</em>
<a name="93" href="#93">93</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String RETURN_PARAM_NAME = <span class="jxr_string">"return"</span>;
<a name="94" href="#94">94</a> <em class="jxr_javadoccomment">/**</em>
<a name="95" href="#95">95</a> <em class="jxr_javadoccomment"> * "return" is an invalid attribute, so we use returnX.</em>
<a name="96" href="#96">96</a> <em class="jxr_javadoccomment"> */</em>
<a name="97" href="#97">97</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String RETURN_ATTRIBUTE_NAME = <span class="jxr_string">"returnX"</span>;
<a name="98" href="#98">98</a> <em class="jxr_javadoccomment">/**</em>
<a name="99" href="#99">99</a> <em class="jxr_javadoccomment"> * Alternatively the index of where to send the address back to.</em>
<a name="100" href="#100">100</a> <em class="jxr_javadoccomment"> */</em>
<a name="101" href="#101">101</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String RETURN_INDEX_NAME = <span class="jxr_string">"returnIndex"</span>;
<a name="102" href="#102">102</a>
<a name="103" href="#103">103</a> <em class="jxr_javadoccomment">/**</em>
<a name="104" href="#104">104</a> <em class="jxr_javadoccomment"> * What value to put the ID of the selected metadata into.</em>
<a name="105" href="#105">105</a> <em class="jxr_javadoccomment"> */</em>
<a name="106" href="#106">106</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String RETURNID_PARAM_NAME = <span class="jxr_string">"returnIDParam"</span>;
<a name="107" href="#107">107</a>
<a name="108" href="#108">108</a> <em class="jxr_javadoccomment">/**</em>
<a name="109" href="#109">109</a> <em class="jxr_javadoccomment"> * What returnIDParam defaults to.</em>
<a name="110" href="#110">110</a> <em class="jxr_javadoccomment"> */</em>
<a name="111" href="#111">111</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String RETURNID_DEFAULT_VALUE = <span class="jxr_string">"entityID"</span>;
<a name="112" href="#112">112</a> <em class="jxr_javadoccomment">/**</em>
<a name="113" href="#113">113</a> <em class="jxr_javadoccomment"> * Whether we are allowed to interact.</em>
<a name="114" href="#114">114</a> <em class="jxr_javadoccomment"> */</em>
<a name="115" href="#115">115</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String ISPASSIVE_PARAM_NAME = <span class="jxr_string">"isPassive"</span>;
<a name="116" href="#116">116</a>
<a name="117" href="#117">117</a> <em class="jxr_javadoccomment">/**</em>
<a name="118" href="#118">118</a> <em class="jxr_javadoccomment"> * Whether we understand this or not.</em>
<a name="119" href="#119">119</a> <em class="jxr_javadoccomment"> */</em>
<a name="120" href="#120">120</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String POLICY_PARAM_NAME = <span class="jxr_string">"policy"</span>;
<a name="121" href="#121">121</a>
<a name="122" href="#122">122</a> <em class="jxr_javadoccomment">/**</em>
<a name="123" href="#123">123</a> <em class="jxr_javadoccomment"> * The only policy we know about.</em>
<a name="124" href="#124">124</a> <em class="jxr_javadoccomment"> */</em>
<a name="125" href="#125">125</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String KNOWN_POLICY_NAME
<a name="126" href="#126">126</a> = <span class="jxr_string">"urn:oasis:names:tc:SAML:profiles:SSO:idp-discoveryprotocol:single"</span>;
<a name="127" href="#127">127</a>
<a name="128" href="#128">128</a> <em class="jxr_javadoccomment">/**</em>
<a name="129" href="#129">129</a> <em class="jxr_javadoccomment"> * Mandatory Serialization constant.</em>
<a name="130" href="#130">130</a> <em class="jxr_javadoccomment"> */</em>
<a name="131" href="#131">131</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Logger LOG = LoggerFactory.getLogger(DiscoveryServiceHandler.<strong class="jxr_keyword">class</strong>.getName());
<a name="132" href="#132">132</a>
<a name="133" href="#133">133</a> <em class="jxr_javadoccomment">/**</em>
<a name="134" href="#134">134</a> <em class="jxr_javadoccomment"> * The location defines the last part of the URL which distinguished this handler. </em>
<a name="135" href="#135">135</a> <em class="jxr_javadoccomment"> */</em>
<a name="136" href="#136">136</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> String location;
<a name="137" href="#137">137</a>
<a name="138" href="#138">138</a> <em class="jxr_javadoccomment">/**</em>
<a name="139" href="#139">139</a> <em class="jxr_javadoccomment"> * If isDefault is true then if there is a mismatch then this handler is used. </em>
<a name="140" href="#140">140</a> <em class="jxr_javadoccomment"> */</em>
<a name="141" href="#141">141</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> isDefault;
<a name="142" href="#142">142</a>
<a name="143" href="#143">143</a> <em class="jxr_javadoccomment">/**</em>
<a name="144" href="#144">144</a> <em class="jxr_javadoccomment"> * Config handles detailed behavior.</em>
<a name="145" href="#145">145</a> <em class="jxr_javadoccomment"> */</em>
<a name="146" href="#146">146</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/HandlerConfig.html">HandlerConfig</a> config;
<a name="147" href="#147">147</a>
<a name="148" href="#148">148</a> <em class="jxr_javadoccomment">/**</em>
<a name="149" href="#149">149</a> <em class="jxr_javadoccomment"> * The list of all the metadata providers that this discovery handler believes in.</em>
<a name="150" href="#150">150</a> <em class="jxr_javadoccomment"> */</em>
<a name="151" href="#151">151</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> List <IdPSiteSet> siteSets;
<a name="152" href="#152">152</a>
<a name="153" href="#153">153</a> <em class="jxr_javadoccomment">/**</em>
<a name="154" href="#154">154</a> <em class="jxr_javadoccomment"> * The list of all the plugins that this hanlder has had configured.</em>
<a name="155" href="#155">155</a> <em class="jxr_javadoccomment"> */</em>
<a name="156" href="#156">156</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> List <Plugin> plugins;
<a name="157" href="#157">157</a>
<a name="158" href="#158">158</a> <em class="jxr_javadoccomment">/**</em>
<a name="159" href="#159">159</a> <em class="jxr_javadoccomment"> * Constructor to create and configure the handler.</em>
<a name="160" href="#160">160</a> <em class="jxr_javadoccomment"> * @param config - DOM Element with configuration information.</em>
<a name="161" href="#161">161</a> <em class="jxr_javadoccomment"> * @param federations - Supplies all known providers which will be included if so configured.</em>
<a name="162" href="#162">162</a> <em class="jxr_javadoccomment"> * @param plugins - Supplies all known plugins which will be included if configured in. </em>
<a name="163" href="#163">163</a> <em class="jxr_javadoccomment"> * @param defaultConfig - The default configurations.</em>
<a name="164" href="#164">164</a> <em class="jxr_javadoccomment"> * @throws ShibbolethConfigurationException - if we find something odd in the config file. </em>
<a name="165" href="#165">165</a> <em class="jxr_javadoccomment"> */</em>
<a name="166" href="#166">166</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/DiscoveryServiceHandler.html">DiscoveryServiceHandler</a>(Element config,
<a name="167" href="#167">167</a> Hashtable <String, IdPSiteSet> federations,
<a name="168" href="#168">168</a> Hashtable <String, Plugin> plugins,
<a name="169" href="#169">169</a> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/HandlerConfig.html">HandlerConfig</a> defaultConfig) <strong class="jxr_keyword">throws</strong> ShibbolethConfigurationException
<a name="170" href="#170">170</a> {
<a name="171" href="#171">171</a> siteSets = <strong class="jxr_keyword">new</strong> ArrayList <IdPSiteSet>(federations.size());
<a name="172" href="#172">172</a> <strong class="jxr_keyword">this</strong>.plugins = <strong class="jxr_keyword">new</strong> ArrayList <Plugin>(plugins.size());
<a name="173" href="#173">173</a>
<a name="174" href="#174">174</a> <em class="jxr_comment">//</em>
<a name="175" href="#175">175</a> <em class="jxr_comment">// Collect the Configuration from the XML</em>
<a name="176" href="#176">176</a> <em class="jxr_comment">//</em>
<a name="177" href="#177">177</a>
<a name="178" href="#178">178</a> <strong class="jxr_keyword">this</strong>.config = <strong class="jxr_keyword">new</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/HandlerConfig.html">HandlerConfig</a>(config, defaultConfig);
<a name="179" href="#179">179</a>
<a name="180" href="#180">180</a> location = config.getAttribute(<span class="jxr_string">"location"</span>);
<a name="181" href="#181">181</a>
<a name="182" href="#182">182</a> <strong class="jxr_keyword">if</strong> (location == <strong class="jxr_keyword">null</strong> || location.equals(<span class="jxr_string">""</span>)) {
<a name="183" href="#183">183</a>
<a name="184" href="#184">184</a> LOG.error(<span class="jxr_string">"DiscoveryService must have a location specified"</span>);
<a name="185" href="#185">185</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">"DiscoveryService must have a location specified"</span>);
<a name="186" href="#186">186</a> }
<a name="187" href="#187">187</a>
<a name="188" href="#188">188</a> <em class="jxr_comment">//</em>
<a name="189" href="#189">189</a> <em class="jxr_comment">// Is this the default WAYF?</em>
<a name="190" href="#190">190</a> <em class="jxr_comment">//</em>
<a name="191" href="#191">191</a>
<a name="192" href="#192">192</a> String attribute = config.getAttribute(<span class="jxr_string">"default"</span>);
<a name="193" href="#193">193</a> <strong class="jxr_keyword">if</strong> (attribute != <strong class="jxr_keyword">null</strong> && !attribute.equals(<span class="jxr_string">""</span>)) {
<a name="194" href="#194">194</a> isDefault = Boolean.valueOf(attribute).booleanValue();
<a name="195" href="#195">195</a> } <strong class="jxr_keyword">else</strong> {
<a name="196" href="#196">196</a> isDefault = false;
<a name="197" href="#197">197</a> }
<a name="198" href="#198">198</a>
<a name="199" href="#199">199</a> <em class="jxr_comment">//</em>
<a name="200" href="#200">200</a> <em class="jxr_comment">// Which federations (sitesets) do we care about?</em>
<a name="201" href="#201">201</a> <em class="jxr_comment">//</em>
<a name="202" href="#202">202</a>
<a name="203" href="#203">203</a> NodeList list = config.getElementsByTagName(<span class="jxr_string">"Federation"</span>);
<a name="204" href="#204">204</a>
<a name="205" href="#205">205</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i < list.getLength(); i++ ) {
<a name="206" href="#206">206</a>
<a name="207" href="#207">207</a> attribute = ((Element) list.item(i)).getAttribute(<span class="jxr_string">"identifier"</span>);
<a name="208" href="#208">208</a>
<a name="209" href="#209">209</a> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/IdPSiteSet.html">IdPSiteSet</a> siteset = federations.get(attribute);
<a name="210" href="#210">210</a>
<a name="211" href="#211">211</a> <strong class="jxr_keyword">if</strong> (siteset == <strong class="jxr_keyword">null</strong>) {
<a name="212" href="#212">212</a> LOG.error(<span class="jxr_string">"Handler "</span> + location + <span class="jxr_string">": could not find metadata for <Federation> with identifier "</span> + attribute + <span class="jxr_string">"."</span>);
<a name="213" href="#213">213</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/common/ShibbolethConfigurationException.html">ShibbolethConfigurationException</a>(
<a name="214" href="#214">214</a> <span class="jxr_string">"Handler "</span> + location + <span class="jxr_string">": could not find metadata for <Federation> identifier "</span> + attribute + <span class="jxr_string">"."</span>);
<a name="215" href="#215">215</a> }
<a name="216" href="#216">216</a>
<a name="217" href="#217">217</a> siteSets.add(siteset);
<a name="218" href="#218">218</a> }
<a name="219" href="#219">219</a>
<a name="220" href="#220">220</a> <strong class="jxr_keyword">if</strong> (siteSets.size() == 0) {
<a name="221" href="#221">221</a> <em class="jxr_comment">//</em>
<a name="222" href="#222">222</a> <em class="jxr_comment">// No Federations explicitly named pick em all</em>
<a name="223" href="#223">223</a> <em class="jxr_comment">//</em>
<a name="224" href="#224">224</a> siteSets.addAll(federations.values());
<a name="225" href="#225">225</a> }
<a name="226" href="#226">226</a>
<a name="227" href="#227">227</a> <em class="jxr_comment">//</em>
<a name="228" href="#228">228</a> <em class="jxr_comment">// Now, which plugins?</em>
<a name="229" href="#229">229</a> <em class="jxr_comment">//</em>
<a name="230" href="#230">230</a>
<a name="231" href="#231">231</a> list = config.getElementsByTagName(<span class="jxr_string">"PluginInstance"</span>);
<a name="232" href="#232">232</a>
<a name="233" href="#233">233</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i < list.getLength(); i++ ) {
<a name="234" href="#234">234</a>
<a name="235" href="#235">235</a> attribute = ((Element) list.item(i)).getAttribute(<span class="jxr_string">"identifier"</span>);
<a name="236" href="#236">236</a>
<a name="237" href="#237">237</a> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/Plugin.html">Plugin</a> plugin = plugins.get(attribute);
<a name="238" href="#238">238</a>
<a name="239" href="#239">239</a> <strong class="jxr_keyword">if</strong> (plugin == <strong class="jxr_keyword">null</strong>) {
<a name="240" href="#240">240</a> LOG.error(<span class="jxr_string">"Handler "</span> + location + <span class="jxr_string">": could not find plugin for identifier "</span> + attribute);
<a name="241" href="#241">241</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/common/ShibbolethConfigurationException.html">ShibbolethConfigurationException</a>(
<a name="242" href="#242">242</a> <span class="jxr_string">"Handler "</span> + location + <span class="jxr_string">": could not find plugin for identifier "</span> + attribute);
<a name="243" href="#243">243</a> }
<a name="244" href="#244">244</a>
<a name="245" href="#245">245</a> <strong class="jxr_keyword">this</strong>.plugins.add(plugin);
<a name="246" href="#246">246</a> }
<a name="247" href="#247">247</a>
<a name="248" href="#248">248</a> <em class="jxr_comment">//</em>
<a name="249" href="#249">249</a> <em class="jxr_comment">// So now tell every IdPSite about every plugin.</em>
<a name="250" href="#250">250</a> <em class="jxr_comment">//</em>
<a name="251" href="#251">251</a> <em class="jxr_comment">// Note that there is only one idpsite per metadatafile per WAYF and that the discovery </em>
<a name="252" href="#252">252</a> <em class="jxr_comment">// services share them, so the data explosion is only number(IdpSites) * number(Plugins) not</em>
<a name="253" href="#253">253</a> <em class="jxr_comment">// number(IdpSites) * number(Plugins) * number(DiscoverHandlers)</em>
<a name="254" href="#254">254</a>
<a name="255" href="#255">255</a> <strong class="jxr_keyword">for</strong> (IdPSiteSet site: siteSets) {
<a name="256" href="#256">256</a> <strong class="jxr_keyword">for</strong> (Plugin plugin: <strong class="jxr_keyword">this</strong>.plugins) {
<a name="257" href="#257">257</a> site.addPlugin(plugin);
<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>
<a name="263" href="#263">263</a> <em class="jxr_comment">//</em>
<a name="264" href="#264">264</a> <em class="jxr_comment">// Standard Beany Methods</em>
<a name="265" href="#265">265</a> <em class="jxr_comment">//</em>
<a name="266" href="#266">266</a> <em class="jxr_javadoccomment">/**</em>
<a name="267" href="#267">267</a> <em class="jxr_javadoccomment"> * The 'Name' of the service. the path used to identify the ServiceHandler.</em>
<a name="268" href="#268">268</a> <em class="jxr_javadoccomment"> * @return the path used to identify the ServiceHandler.</em>
<a name="269" href="#269">269</a> <em class="jxr_javadoccomment"> */</em>
<a name="270" href="#270">270</a>
<a name="271" href="#271">271</a> <strong class="jxr_keyword">protected</strong> String getLocation() {
<a name="272" href="#272">272</a> <strong class="jxr_keyword">return</strong> location;
<a name="273" href="#273">273</a> }
<a name="274" href="#274">274</a>
<a name="275" href="#275">275</a> <em class="jxr_javadoccomment">/**</em>
<a name="276" href="#276">276</a> <em class="jxr_javadoccomment"> * Whether this is the default service.</em>
<a name="277" href="#277">277</a> <em class="jxr_javadoccomment"> * @return is it?</em>
<a name="278" href="#278">278</a> <em class="jxr_javadoccomment"> */</em>
<a name="279" href="#279">279</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> isDefault() {
<a name="280" href="#280">280</a> <strong class="jxr_keyword">return</strong> isDefault;
<a name="281" href="#281">281</a> }
<a name="282" href="#282">282</a>
<a name="283" href="#283">283</a> <em class="jxr_comment">//</em>
<a name="284" href="#284">284</a> <em class="jxr_comment">// Now the bits that deal with the user request</em>
<a name="285" href="#285">285</a> <em class="jxr_comment">//</em>
<a name="286" href="#286">286</a>
<a name="287" href="#287">287</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> doGet(HttpServletRequest req, HttpServletResponse res) {
<a name="288" href="#288">288</a>
<a name="289" href="#289">289</a> String policy = req.getParameter(POLICY_PARAM_NAME);
<a name="290" href="#290">290</a>
<a name="291" href="#291">291</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">null</strong> != policy && !KNOWN_POLICY_NAME.equals(policy)) {
<a name="292" href="#292">292</a> <em class="jxr_comment">//</em>
<a name="293" href="#293">293</a> <em class="jxr_comment">// unknown policy</em>
<a name="294" href="#294">294</a> <em class="jxr_comment">//</em>
<a name="295" href="#295">295</a> LOG.error(<span class="jxr_string">"Unknown policy "</span> + policy);
<a name="296" href="#296">296</a> handleError(req, res, <span class="jxr_string">"Unknown policy "</span> + policy);
<a name="297" href="#297">297</a> <strong class="jxr_keyword">return</strong>;
<a name="298" href="#298">298</a> }
<a name="299" href="#299">299</a>
<a name="300" href="#300">300</a> <em class="jxr_comment">//</em>
<a name="301" href="#301">301</a> <em class="jxr_comment">// Decide how to route the request based on query string</em>
<a name="302" href="#302">302</a> <em class="jxr_comment">//</em>
<a name="303" href="#303">303</a> String requestType = req.getParameter(<span class="jxr_string">"action"</span>);
<a name="304" href="#304">304</a>
<a name="305" href="#305">305</a> <strong class="jxr_keyword">if</strong> (requestType == <strong class="jxr_keyword">null</strong> || requestType.equals(<span class="jxr_string">""</span>)) {
<a name="306" href="#306">306</a> requestType = <span class="jxr_string">"lookup"</span>;
<a name="307" href="#307">307</a> }
<a name="308" href="#308">308</a>
<a name="309" href="#309">309</a> <strong class="jxr_keyword">try</strong> {
<a name="310" href="#310">310</a>
<a name="311" href="#311">311</a> <strong class="jxr_keyword">if</strong> (requestType.equals(<span class="jxr_string">"search"</span>)) {
<a name="312" href="#312">312</a>
<a name="313" href="#313">313</a> String parameter = req.getParameter(<span class="jxr_string">"string"</span>);
<a name="314" href="#314">314</a> <strong class="jxr_keyword">if</strong> (parameter != <strong class="jxr_keyword">null</strong> && parameter.equals(<span class="jxr_string">""</span>)) {
<a name="315" href="#315">315</a> parameter = <strong class="jxr_keyword">null</strong>;
<a name="316" href="#316">316</a> }
<a name="317" href="#317">317</a> handleLookup(req, res, parameter);
<a name="318" href="#318">318</a>
<a name="319" href="#319">319</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (requestType.equals(<span class="jxr_string">"selection"</span>)) {
<a name="320" href="#320">320</a>
<a name="321" href="#321">321</a> handleSelection(req, res);
<a name="322" href="#322">322</a> } <strong class="jxr_keyword">else</strong> {
<a name="323" href="#323">323</a> handleLookup(req, res, <strong class="jxr_keyword">null</strong>);
<a name="324" href="#324">324</a> }
<a name="325" href="#325">325</a> } <strong class="jxr_keyword">catch</strong> (WayfException we) {
<a name="326" href="#326">326</a> LOG.error(<span class="jxr_string">"Error processing DS request:"</span>, we);
<a name="327" href="#327">327</a> handleError(req, res, we.getLocalizedMessage());
<a name="328" href="#328">328</a> } <strong class="jxr_keyword">catch</strong> (WayfRequestHandled we) {
<a name="329" href="#329">329</a> <em class="jxr_comment">//</em>
<a name="330" href="#330">330</a> <em class="jxr_comment">// Yuck - a sucess path involving an exception</em>
<a name="331" href="#331">331</a> <em class="jxr_comment">//</em>
<a name="332" href="#332">332</a> }
<a name="333" href="#333">333</a>
<a name="334" href="#334">334</a> }
<a name="335" href="#335">335</a>
<a name="336" href="#336">336</a> <em class="jxr_javadoccomment">/**</em>
<a name="337" href="#337">337</a> <em class="jxr_javadoccomment"> * When the WAYF user has selected something we look it up, tell the plugins and then dispatch to the Idp.</em>
<a name="338" href="#338">338</a> <em class="jxr_javadoccomment"> * </em>
<a name="339" href="#339">339</a> <em class="jxr_javadoccomment"> * @param req - standard J2EE stuff</em>
<a name="340" href="#340">340</a> <em class="jxr_javadoccomment"> * @param res - standard J2EE stuff</em>
<a name="341" href="#341">341</a> <em class="jxr_javadoccomment"> * @throws WayfRequestHandled - if one of the plugins has done the dispatch</em>
<a name="342" href="#342">342</a> <em class="jxr_javadoccomment"> * @throws WayfException - if we had an errors</em>
<a name="343" href="#343">343</a> <em class="jxr_javadoccomment"> */</em>
<a name="344" href="#344">344</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> handleSelection(HttpServletRequest req,
<a name="345" href="#345">345</a> HttpServletResponse res) <strong class="jxr_keyword">throws</strong> WayfRequestHandled, WayfException
<a name="346" href="#346">346</a> {
<a name="347" href="#347">347</a>
<a name="348" href="#348">348</a> String idpName = req.getParameter(<span class="jxr_string">"origin"</span>);
<a name="349" href="#349">349</a> LOG.debug(<span class="jxr_string">"Processing handle selection: "</span> + idpName);
<a name="350" href="#350">350</a>
<a name="351" href="#351">351</a> String sPName = getSPId(req);
<a name="352" href="#352">352</a>
<a name="353" href="#353">353</a> <strong class="jxr_keyword">if</strong> (idpName == <strong class="jxr_keyword">null</strong> || idpName.equals(<span class="jxr_string">""</span>)) {
<a name="354" href="#354">354</a> handleLookup(req, res, <strong class="jxr_keyword">null</strong>);
<a name="355" href="#355">355</a> <strong class="jxr_keyword">return</strong>;
<a name="356" href="#356">356</a> }
<a name="357" href="#357">357</a>
<a name="358" href="#358">358</a> <strong class="jxr_keyword">if</strong> (getValue(req, SHIRE_PARAM_NAME) == <strong class="jxr_keyword">null</strong>) {
<a name="359" href="#359">359</a> <em class="jxr_comment">//</em>
<a name="360" href="#360">360</a> <em class="jxr_comment">// 2.0 protocol</em>
<a name="361" href="#361">361</a> <em class="jxr_comment">//</em>
<a name="362" href="#362">362</a> setupReturnAddress(sPName, req);
<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">// Notify plugins</em>
<a name="366" href="#366">366</a> <em class="jxr_comment">//</em>
<a name="367" href="#367">367</a> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/IdPSite.html">IdPSite</a> site = <strong class="jxr_keyword">null</strong>;
<a name="368" href="#368">368</a>
<a name="369" href="#369">369</a> <strong class="jxr_keyword">for</strong> (Plugin plugin:plugins) {
<a name="370" href="#370">370</a> <strong class="jxr_keyword">for</strong> (IdPSiteSet idPSiteSet: siteSets) {
<a name="371" href="#371">371</a> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/PluginMetadataParameter.html">PluginMetadataParameter</a> param = idPSiteSet.paramFor(plugin);
<a name="372" href="#372">372</a> plugin.selected(req, res, param, idpName);
<a name="373" href="#373">373</a> <strong class="jxr_keyword">if</strong> (site == <strong class="jxr_keyword">null</strong> && idPSiteSet.containsIdP(idpName)) {
<a name="374" href="#374">374</a> site = idPSiteSet.getSite(idpName);
<a name="375" href="#375">375</a> }
<a name="376" href="#376">376</a> }
<a name="377" href="#377">377</a> }
<a name="378" href="#378">378</a>
<a name="379" href="#379">379</a> <strong class="jxr_keyword">if</strong> (site == <strong class="jxr_keyword">null</strong>) {
<a name="380" href="#380">380</a> handleLookup(req, res, <strong class="jxr_keyword">null</strong>);
<a name="381" href="#381">381</a> } <strong class="jxr_keyword">else</strong> {
<a name="382" href="#382">382</a> forwardRequest(req, res, site);
<a name="383" href="#383">383</a> }
<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"> * This sets up the parameter RETURN_ATTRIBUTE_NAME with the return address </em>
<a name="389" href="#389">389</a> <em class="jxr_javadoccomment"> * harvested from the reqest.</em>
<a name="390" href="#390">390</a> <em class="jxr_javadoccomment"> * <ul><le>If a "return" parameter is present we check in the metadata for spoofing </em>
<a name="391" href="#391">391</a> <em class="jxr_javadoccomment"> * and then set up from there </le></em>
<a name="392" href="#392">392</a> <em class="jxr_javadoccomment"> * <le>If "returnID" is specified we get this from the metadata</le></em>
<a name="393" href="#393">393</a> <em class="jxr_javadoccomment"> * <le>If nothing is provided we get the default from the metadata (if provided)</le></em>
<a name="394" href="#394">394</a> <em class="jxr_javadoccomment"> * <le>Otherwise we whine</le></em>
<a name="395" href="#395">395</a> <em class="jxr_javadoccomment"> * </ul> </em>
<a name="396" href="#396">396</a> <em class="jxr_javadoccomment"> * @param spName - the name of the Service provider.</em>
<a name="397" href="#397">397</a> <em class="jxr_javadoccomment"> * @param req - The request.</em>
<a name="398" href="#398">398</a> <em class="jxr_javadoccomment"> * @throws WayfException - if we spot spoofing or there is no defaumlt </em>
<a name="399" href="#399">399</a> <em class="jxr_javadoccomment"> */</em>
<a name="400" href="#400">400</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> setupReturnAddress(String spName, HttpServletRequest req) <strong class="jxr_keyword">throws</strong> WayfException{
<a name="401" href="#401">401</a>
<a name="402" href="#402">402</a> DiscoveryResponse[] discoveryServices;
<a name="403" href="#403">403</a> Set<XMLObject> objects = <strong class="jxr_keyword">new</strong> HashSet<XMLObject>();
<a name="404" href="#404">404</a> String defaultName = <strong class="jxr_keyword">null</strong>;
<a name="405" href="#405">405</a>
<a name="406" href="#406">406</a> <strong class="jxr_keyword">for</strong> (IdPSiteSet metadataProvider:siteSets) {
<a name="407" href="#407">407</a>
<a name="408" href="#408">408</a> <em class="jxr_comment">//</em>
<a name="409" href="#409">409</a> <em class="jxr_comment">// Only do work if the SP makes sense</em>
<a name="410" href="#410">410</a> <em class="jxr_comment">//</em>
<a name="411" href="#411">411</a>
<a name="412" href="#412">412</a> <strong class="jxr_keyword">if</strong> (metadataProvider.containsSP(spName)) {
<a name="413" href="#413">413</a>
<a name="414" href="#414">414</a> <em class="jxr_comment">//</em>
<a name="415" href="#415">415</a> <em class="jxr_comment">// The name makes sense so let's get the entity and from that</em>
<a name="416" href="#416">416</a> <em class="jxr_comment">// all of its roles</em>
<a name="417" href="#417">417</a> <em class="jxr_comment">//</em>
<a name="418" href="#418">418</a>
<a name="419" href="#419">419</a> EntityDescriptor entity = metadataProvider.getEntity(spName);
<a name="420" href="#420">420</a> List<RoleDescriptor> roles = entity.getRoleDescriptors();
<a name="421" href="#421">421</a>
<a name="422" href="#422">422</a> <strong class="jxr_keyword">for</strong> (RoleDescriptor role:roles) {
<a name="423" href="#423">423</a>
<a name="424" href="#424">424</a> <em class="jxr_comment">//</em>
<a name="425" href="#425">425</a> <em class="jxr_comment">// Check every role</em>
<a name="426" href="#426">426</a> <em class="jxr_comment">//</em>
<a name="427" href="#427">427</a>
<a name="428" href="#428">428</a> <strong class="jxr_keyword">if</strong> (role instanceof SPSSODescriptor) {
<a name="429" href="#429">429</a>
<a name="430" href="#430">430</a> <em class="jxr_comment">//</em>
<a name="431" href="#431">431</a> <em class="jxr_comment">// And grab hold of all the extensions for SPSSO descriptors</em>
<a name="432" href="#432">432</a> <em class="jxr_comment">//</em>
<a name="433" href="#433">433</a>
<a name="434" href="#434">434</a> Extensions exts = role.getExtensions();
<a name="435" href="#435">435</a> <strong class="jxr_keyword">if</strong> (exts != <strong class="jxr_keyword">null</strong>) {
<a name="436" href="#436">436</a> objects.addAll(exts.getOrderedChildren());
<a name="437" href="#437">437</a> }
<a name="438" href="#438">438</a> }
<a name="439" href="#439">439</a> }
<a name="440" href="#440">440</a> }
<a name="441" href="#441">441</a> }
<a name="442" href="#442">442</a>
<a name="443" href="#443">443</a> <em class="jxr_comment">//</em>
<a name="444" href="#444">444</a> <em class="jxr_comment">// Now, let's strip out everything which isn't a DiscoveryService</em>
<a name="445" href="#445">445</a> <em class="jxr_comment">//</em>
<a name="446" href="#446">446</a>
<a name="447" href="#447">447</a> discoveryServices = <strong class="jxr_keyword">new</strong> DiscoveryResponse[objects.size()];
<a name="448" href="#448">448</a> <strong class="jxr_keyword">int</strong> dsCount = 0;
<a name="449" href="#449">449</a>
<a name="450" href="#450">450</a> <strong class="jxr_keyword">for</strong> (XMLObject obj:objects) {
<a name="451" href="#451">451</a> <strong class="jxr_keyword">if</strong> (obj instanceof DiscoveryResponse) {
<a name="452" href="#452">452</a> DiscoveryResponse ds = (DiscoveryResponse) obj;
<a name="453" href="#453">453</a> discoveryServices[dsCount++] = ds;
<a name="454" href="#454">454</a> <strong class="jxr_keyword">if</strong> (ds.isDefault() || <strong class="jxr_keyword">null</strong> == defaultName) {
<a name="455" href="#455">455</a> defaultName = ds.getLocation();
<a name="456" href="#456">456</a> }
<a name="457" href="#457">457</a> }
<a name="458" href="#458">458</a> }
<a name="459" href="#459">459</a>
<a name="460" href="#460">460</a> <em class="jxr_comment">//</em>
<a name="461" href="#461">461</a> <em class="jxr_comment">// Now process the return parameters. The name is either a parameter</em>
<a name="462" href="#462">462</a> <em class="jxr_comment">// called RETURN_PARAM_NAME or an attributes called RETURN_ATTRIBUTE_NAME</em>
<a name="463" href="#463">463</a> <em class="jxr_comment">//</em>
<a name="464" href="#464">464</a> String returnName = req.getParameter(RETURN_PARAM_NAME);
<a name="465" href="#465">465</a>
<a name="466" href="#466">466</a> <strong class="jxr_keyword">if</strong> (returnName == <strong class="jxr_keyword">null</strong> || returnName.length() == 0) {
<a name="467" href="#467">467</a> returnName = getValue(req, RETURN_ATTRIBUTE_NAME);
<a name="468" href="#468">468</a> }
<a name="469" href="#469">469</a>
<a name="470" href="#470">470</a> <em class="jxr_comment">//</em>
<a name="471" href="#471">471</a> <em class="jxr_comment">// Return index is only ever a parameter</em>
<a name="472" href="#472">472</a> <em class="jxr_comment">//</em>
<a name="473" href="#473">473</a>
<a name="474" href="#474">474</a> String returnIndex = req.getParameter(RETURN_INDEX_NAME);
<a name="475" href="#475">475</a>
<a name="476" href="#476">476</a> <strong class="jxr_keyword">if</strong> (returnName != <strong class="jxr_keyword">null</strong> && returnName.length() != 0) {
<a name="477" href="#477">477</a> <em class="jxr_comment">//</em>
<a name="478" href="#478">478</a> <em class="jxr_comment">// Given something so we have to police it.</em>
<a name="479" href="#479">479</a> <em class="jxr_comment">//</em>
<a name="480" href="#480">480</a> String nameNoParam = returnName;
<a name="481" href="#481">481</a> URL providedReturnURL;
<a name="482" href="#482">482</a> <strong class="jxr_keyword">int</strong> index = nameNoParam.indexOf('?');
<a name="483" href="#483">483</a> <strong class="jxr_keyword">boolean</strong> found = false;
<a name="484" href="#484">484</a>
<a name="485" href="#485">485</a> <strong class="jxr_keyword">if</strong> (index >= 0) {
<a name="486" href="#486">486</a> nameNoParam = nameNoParam.substring(0,index);
<a name="487" href="#487">487</a> }
<a name="488" href="#488">488</a>
<a name="489" href="#489">489</a> <strong class="jxr_keyword">try</strong> {
<a name="490" href="#490">490</a> providedReturnURL = <strong class="jxr_keyword">new</strong> URL(nameNoParam);
<a name="491" href="#491">491</a> } <strong class="jxr_keyword">catch</strong> (MalformedURLException e) {
<a name="492" href="#492">492</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/WayfException.html">WayfException</a>(<span class="jxr_string">"Couldn't parse provided return name "</span> + nameNoParam, e);
<a name="493" href="#493">493</a> }
<a name="494" href="#494">494</a>
<a name="495" href="#495">495</a>
<a name="496" href="#496">496</a> <strong class="jxr_keyword">for</strong> (DiscoveryResponse disc: discoveryServices) {
<a name="497" href="#497">497</a> <strong class="jxr_keyword">if</strong> (equalsURL(disc, providedReturnURL)) {
<a name="498" href="#498">498</a> found = <strong class="jxr_keyword">true</strong>;
<a name="499" href="#499">499</a> <strong class="jxr_keyword">break</strong>;
<a name="500" href="#500">500</a> }
<a name="501" href="#501">501</a> }
<a name="502" href="#502">502</a> <strong class="jxr_keyword">if</strong> (!found) {
<a name="503" href="#503">503</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/WayfException.html">WayfException</a>(<span class="jxr_string">"Couldn't find endpoint "</span> + nameNoParam + <span class="jxr_string">" in metadata"</span>);
<a name="504" href="#504">504</a> }
<a name="505" href="#505">505</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (returnIndex != <strong class="jxr_keyword">null</strong> && returnIndex.length() != 0) {
<a name="506" href="#506">506</a>
<a name="507" href="#507">507</a> <strong class="jxr_keyword">int</strong> index;
<a name="508" href="#508">508</a> <strong class="jxr_keyword">try</strong> {
<a name="509" href="#509">509</a> index = Integer.parseInt(returnIndex);
<a name="510" href="#510">510</a> } <strong class="jxr_keyword">catch</strong> (NumberFormatException e) {
<a name="511" href="#511">511</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/WayfException.html">WayfException</a>(<span class="jxr_string">"Couldn't convert "</span> + returnIndex + <span class="jxr_string">" into an index"</span>);
<a name="512" href="#512">512</a> }
<a name="513" href="#513">513</a> <em class="jxr_comment">//</em>
<a name="514" href="#514">514</a> <em class="jxr_comment">// So look throught to find the endpoint with the correct index</em>
<a name="515" href="#515">515</a> <em class="jxr_comment">//</em>
<a name="516" href="#516">516</a>
<a name="517" href="#517">517</a> <strong class="jxr_keyword">boolean</strong> found = false;
<a name="518" href="#518">518</a>
<a name="519" href="#519">519</a> <strong class="jxr_keyword">for</strong> (DiscoveryResponse disc: discoveryServices) {
<a name="520" href="#520">520</a> <strong class="jxr_keyword">if</strong> (index == disc.getIndex()) {
<a name="521" href="#521">521</a> found = <strong class="jxr_keyword">true</strong>;
<a name="522" href="#522">522</a> returnName = disc.getLocation();
<a name="523" href="#523">523</a> <strong class="jxr_keyword">break</strong>;
<a name="524" href="#524">524</a> }
<a name="525" href="#525">525</a> }
<a name="526" href="#526">526</a> <strong class="jxr_keyword">if</strong> (!found) {
<a name="527" href="#527">527</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/WayfException.html">WayfException</a>(<span class="jxr_string">"Couldn't not find endpoint "</span> + returnIndex + <span class="jxr_string">"in metadata"</span>);
<a name="528" href="#528">528</a> }
<a name="529" href="#529">529</a> } <strong class="jxr_keyword">else</strong> {
<a name="530" href="#530">530</a> <em class="jxr_comment">//</em>
<a name="531" href="#531">531</a> <em class="jxr_comment">// No name, not index, so we want the default</em>
<a name="532" href="#532">532</a> <em class="jxr_comment">//</em>
<a name="533" href="#533">533</a> returnName = defaultName;
<a name="534" href="#534">534</a> }
<a name="535" href="#535">535</a> <em class="jxr_comment">//</em>
<a name="536" href="#536">536</a> <em class="jxr_comment">// So by now returnName has the correct value, either harvested from or</em>
<a name="537" href="#537">537</a> <em class="jxr_comment">// policed against the metadata</em>
<a name="538" href="#538">538</a> <em class="jxr_comment">//</em>
<a name="539" href="#539">539</a> req.setAttribute(RETURN_ATTRIBUTE_NAME, returnName);
<a name="540" href="#540">540</a> }
<a name="541" href="#541">541</a>
<a name="542" href="#542">542</a> <em class="jxr_javadoccomment">/**</em>
<a name="543" href="#543">543</a> <em class="jxr_javadoccomment"> * Helper function to see whather the provided endpoint in the metadata matches the </em>
<a name="544" href="#544">544</a> <em class="jxr_javadoccomment"> * provided return URL in the request.</em>
<a name="545" href="#545">545</a> <em class="jxr_javadoccomment"> * </em>
<a name="546" href="#546">546</a> <em class="jxr_javadoccomment"> * @param discovery</em>
<a name="547" href="#547">547</a> <em class="jxr_javadoccomment"> * @param providedName</em>
<a name="548" href="#548">548</a> <em class="jxr_javadoccomment"> * @return</em>
<a name="549" href="#549">549</a> <em class="jxr_javadoccomment"> */</em>
<a name="550" href="#550">550</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">boolean</strong> equalsURL(DiscoveryResponse discovery, URL providedName) {
<a name="551" href="#551">551</a>
<a name="552" href="#552">552</a> <em class="jxr_comment">//</em>
<a name="553" href="#553">553</a> <em class="jxr_comment">// Nothing provided - no match</em>
<a name="554" href="#554">554</a> <em class="jxr_comment">//</em>
<a name="555" href="#555">555</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">null</strong> == discovery) {
<a name="556" href="#556">556</a> <strong class="jxr_keyword">return</strong> false;
<a name="557" href="#557">557</a> }
<a name="558" href="#558">558</a>
<a name="559" href="#559">559</a> URL discoveryName;
<a name="560" href="#560">560</a> <strong class="jxr_keyword">try</strong> {
<a name="561" href="#561">561</a> discoveryName = <strong class="jxr_keyword">new</strong> URL(discovery.getLocation());
<a name="562" href="#562">562</a> } <strong class="jxr_keyword">catch</strong> (MalformedURLException e) {
<a name="563" href="#563">563</a> <em class="jxr_comment">//</em>
<a name="564" href="#564">564</a> <em class="jxr_comment">// Something bad happened. Log it (it is only of interest to the sysadmin, not to the user)</em>
<a name="565" href="#565">565</a> <em class="jxr_comment">//</em>
<a name="566" href="#566">566</a> LOG.warn(<span class="jxr_string">"Found invalid discovery end point : "</span> + discovery.getLocation(), e);
<a name="567" href="#567">567</a> <strong class="jxr_keyword">return</strong> false;
<a name="568" href="#568">568</a> }
<a name="569" href="#569">569</a>
<a name="570" href="#570">570</a> <strong class="jxr_keyword">return</strong> providedName.equals(discoveryName);
<a name="571" href="#571">571</a>
<a name="572" href="#572">572</a> }
<a name="573" href="#573">573</a>
<a name="574" href="#574">574</a> <em class="jxr_javadoccomment">/**</em>
<a name="575" href="#575">575</a> <em class="jxr_javadoccomment"> * Displays a Discovery Service selection page, having first consulted the plugins as needed.</em>
<a name="576" href="#576">576</a> <em class="jxr_javadoccomment"> * @param req Describes the request</em>
<a name="577" href="#577">577</a> <em class="jxr_javadoccomment"> * @param res Describes the response</em>
<a name="578" href="#578">578</a> <em class="jxr_javadoccomment"> * @param searchName What are we looking for?</em>
<a name="579" href="#579">579</a> <em class="jxr_javadoccomment"> * </em>
<a name="580" href="#580">580</a> <em class="jxr_javadoccomment"> * @throws WayfRequestHandled if a plugin has dealt with the request</em>
<a name="581" href="#581">581</a> <em class="jxr_javadoccomment"> * @throws WayfException in case of an error.</em>
<a name="582" href="#582">582</a> <em class="jxr_javadoccomment"> */</em>
<a name="583" href="#583">583</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> handleLookup(HttpServletRequest req,
<a name="584" href="#584">584</a> HttpServletResponse res,
<a name="585" href="#585">585</a> String searchName) <strong class="jxr_keyword">throws</strong> WayfException, WayfRequestHandled {
<a name="586" href="#586">586</a>
<a name="587" href="#587">587</a> String shire = getValue(req, SHIRE_PARAM_NAME);
<a name="588" href="#588">588</a> String providerId = getSPId(req);
<a name="589" href="#589">589</a> <strong class="jxr_keyword">boolean</strong> twoZeroProtocol = (shire == <strong class="jxr_keyword">null</strong>);
<a name="590" href="#590">590</a> <strong class="jxr_keyword">boolean</strong> isPassive = (twoZeroProtocol &&
<a name="591" href="#591">591</a> <span class="jxr_string">"true"</span>.equalsIgnoreCase(getValue(req, ISPASSIVE_PARAM_NAME)));
<a name="592" href="#592">592</a>
<a name="593" href="#593">593</a> Collection <IdPSiteSetEntry> siteLists = <strong class="jxr_keyword">null</strong>;
<a name="594" href="#594">594</a> Collection<IdPSite> searchResults = <strong class="jxr_keyword">null</strong>;
<a name="595" href="#595">595</a>
<a name="596" href="#596">596</a> <strong class="jxr_keyword">if</strong> (config.getProvideListOfLists()) {
<a name="597" href="#597">597</a> siteLists = <strong class="jxr_keyword">new</strong> ArrayList <IdPSiteSetEntry>(siteSets.size());
<a name="598" href="#598">598</a> }
<a name="599" href="#599">599</a>
<a name="600" href="#600">600</a> Collection <IdPSite> sites = <strong class="jxr_keyword">null</strong>;
<a name="601" href="#601">601</a> Comparator<IdPSite> comparator = <strong class="jxr_keyword">new</strong> IdPSite.Compare(req);
<a name="602" href="#602">602</a>
<a name="603" href="#603">603</a> <strong class="jxr_keyword">if</strong> (config.getProvideList()) {
<a name="604" href="#604">604</a> sites = <strong class="jxr_keyword">new</strong> TreeSet<IdPSite>(comparator);
<a name="605" href="#605">605</a> }
<a name="606" href="#606">606</a>
<a name="607" href="#607">607</a> <strong class="jxr_keyword">if</strong> (searchName != <strong class="jxr_keyword">null</strong> && !searchName.equals(<span class="jxr_string">""</span>)) {
<a name="608" href="#608">608</a> searchResults = <strong class="jxr_keyword">new</strong> TreeSet<IdPSite>(comparator);
<a name="609" href="#609">609</a> }
<a name="610" href="#610">610</a>
<a name="611" href="#611">611</a> LOG.debug(<span class="jxr_string">"Processing Idp Lookup for : "</span> + providerId);
<a name="612" href="#612">612</a>
<a name="613" href="#613">613</a> <em class="jxr_comment">//</em>
<a name="614" href="#614">614</a> <em class="jxr_comment">// Iterate over all the sitesets and if they know about the SP pass them to the plugins</em>
<a name="615" href="#615">615</a> <em class="jxr_comment">// and then add them too the list</em>
<a name="616" href="#616">616</a> <em class="jxr_comment">//</em>
<a name="617" href="#617">617</a>
<a name="618" href="#618">618</a> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/PluginContext.html">PluginContext</a>[] ctx = <strong class="jxr_keyword">new</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/PluginContext.html">PluginContext</a>[plugins.size()];
<a name="619" href="#619">619</a> List<IdPSite> hintList = <strong class="jxr_keyword">new</strong> ArrayList<IdPSite>();
<a name="620" href="#620">620</a>
<a name="621" href="#621">621</a> <strong class="jxr_keyword">if</strong> (twoZeroProtocol) {
<a name="622" href="#622">622</a> setupReturnAddress(providerId, req);
<a name="623" href="#623">623</a> }
<a name="624" href="#624">624</a> <em class="jxr_comment">//</em>
<a name="625" href="#625">625</a> <em class="jxr_comment">// By having siteLists and sites as parameters we only iterate over </em>
<a name="626" href="#626">626</a> <em class="jxr_comment">// the metadata arrays once.</em>
<a name="627" href="#627">627</a> <em class="jxr_comment">//</em>
<a name="628" href="#628">628</a> <strong class="jxr_keyword">try</strong> {
<a name="629" href="#629">629</a> <strong class="jxr_keyword">for</strong> (IdPSiteSet metadataProvider:siteSets) {
<a name="630" href="#630">630</a>
<a name="631" href="#631">631</a> <em class="jxr_comment">//</em>
<a name="632" href="#632">632</a> <em class="jxr_comment">// Only do work if the SP makes sense</em>
<a name="633" href="#633">633</a> <em class="jxr_comment">//</em>
<a name="634" href="#634">634</a>
<a name="635" href="#635">635</a> <strong class="jxr_keyword">if</strong> (metadataProvider.containsSP(providerId) || !config.getLookupSp()) {
<a name="636" href="#636">636</a>
<a name="637" href="#637">637</a> Collection <IdPSite> search = <strong class="jxr_keyword">null</strong>;
<a name="638" href="#638">638</a>
<a name="639" href="#639">639</a> <strong class="jxr_keyword">if</strong> (searchResults != <strong class="jxr_keyword">null</strong>) {
<a name="640" href="#640">640</a> search = <strong class="jxr_keyword">new</strong> TreeSet<IdPSite>(comparator);
<a name="641" href="#641">641</a> }
<a name="642" href="#642">642</a>
<a name="643" href="#643">643</a> Map <String, IdPSite> theseSites = metadataProvider.getIdPSites(searchName, config, search);
<a name="644" href="#644">644</a>
<a name="645" href="#645">645</a> <em class="jxr_comment">//</em>
<a name="646" href="#646">646</a> <em class="jxr_comment">// Consult the plugins</em>
<a name="647" href="#647">647</a> <em class="jxr_comment">//</em>
<a name="648" href="#648">648</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i < plugins.size(); i++) {
<a name="649" href="#649">649</a>
<a name="650" href="#650">650</a> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/Plugin.html">Plugin</a> plugin = plugins.get(i);
<a name="651" href="#651">651</a>
<a name="652" href="#652">652</a> <strong class="jxr_keyword">if</strong> (searchResults == <strong class="jxr_keyword">null</strong>) {
<a name="653" href="#653">653</a> <em class="jxr_comment">//</em>
<a name="654" href="#654">654</a> <em class="jxr_comment">// This was a search</em>
<a name="655" href="#655">655</a> <em class="jxr_comment">//</em>
<a name="656" href="#656">656</a> ctx[i] = plugin.lookup(req,
<a name="657" href="#657">657</a> res,
<a name="658" href="#658">658</a> metadataProvider.paramFor(plugin),
<a name="659" href="#659">659</a> theseSites,
<a name="660" href="#660">660</a> ctx[i],
<a name="661" href="#661">661</a> hintList);
<a name="662" href="#662">662</a> } <strong class="jxr_keyword">else</strong> {
<a name="663" href="#663">663</a> ctx[i] = plugin.search(req,
<a name="664" href="#664">664</a> res,
<a name="665" href="#665">665</a> metadataProvider.paramFor(plugin),
<a name="666" href="#666">666</a> searchName,
<a name="667" href="#667">667</a> theseSites,
<a name="668" href="#668">668</a> ctx[i],
<a name="669" href="#669">669</a> searchResults,
<a name="670" href="#670">670</a> hintList);
<a name="671" href="#671">671</a> }
<a name="672" href="#672">672</a> }
<a name="673" href="#673">673</a>
<a name="674" href="#674">674</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">null</strong> == theseSites || theseSites.isEmpty()) {
<a name="675" href="#675">675</a> <strong class="jxr_keyword">continue</strong>;
<a name="676" href="#676">676</a> }
<a name="677" href="#677">677</a>
<a name="678" href="#678">678</a> <em class="jxr_comment">//</em>
<a name="679" href="#679">679</a>
<a name="680" href="#680">680</a> <em class="jxr_comment">// Accumulate any per-metadata provider information</em>
<a name="681" href="#681">681</a> <em class="jxr_comment">// </em>
<a name="682" href="#682">682</a>
<a name="683" href="#683">683</a> Collection<IdPSite> values = <strong class="jxr_keyword">new</strong> TreeSet<IdPSite>(comparator);
<a name="684" href="#684">684</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">null</strong> != theseSites) {
<a name="685" href="#685">685</a> values.addAll(theseSites.values());
<a name="686" href="#686">686</a> }
<a name="687" href="#687">687</a>
<a name="688" href="#688">688</a> <strong class="jxr_keyword">if</strong> (siteLists != <strong class="jxr_keyword">null</strong>) {
<a name="689" href="#689">689</a> siteLists.add(<strong class="jxr_keyword">new</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/IdPSiteSetEntry.html">IdPSiteSetEntry</a>(metadataProvider,values));
<a name="690" href="#690">690</a> }
<a name="691" href="#691">691</a>
<a name="692" href="#692">692</a> <strong class="jxr_keyword">if</strong> (sites != <strong class="jxr_keyword">null</strong>) {
<a name="693" href="#693">693</a> sites.addAll(values);
<a name="694" href="#694">694</a> }
<a name="695" href="#695">695</a>
<a name="696" href="#696">696</a> <strong class="jxr_keyword">if</strong> (searchResults != <strong class="jxr_keyword">null</strong>) {
<a name="697" href="#697">697</a> searchResults.addAll(search);
<a name="698" href="#698">698</a> }
<a name="699" href="#699">699</a> }
<a name="700" href="#700">700</a> }
<a name="701" href="#701">701</a>
<a name="702" href="#702">702</a> <strong class="jxr_keyword">if</strong> (isPassive) {
<a name="703" href="#703">703</a> <em class="jxr_comment">//</em>
<a name="704" href="#704">704</a> <em class="jxr_comment">// No GUI intervention.</em>
<a name="705" href="#705">705</a> <em class="jxr_comment">//</em>
<a name="706" href="#706">706</a> <strong class="jxr_keyword">if</strong> (0 != hintList.size()) {
<a name="707" href="#707">707</a> <em class="jxr_comment">//</em>
<a name="708" href="#708">708</a> <em class="jxr_comment">// We found a candidate, hand it back</em>
<a name="709" href="#709">709</a> <em class="jxr_comment">//</em>
<a name="710" href="#710">710</a> forwardRequest(req, res, hintList.get(0));
<a name="711" href="#711">711</a> } <strong class="jxr_keyword">else</strong> {
<a name="712" href="#712">712</a> forwardRequest(req, res, <strong class="jxr_keyword">null</strong>);
<a name="713" href="#713">713</a> }
<a name="714" href="#714">714</a> <strong class="jxr_keyword">return</strong>;
<a name="715" href="#715">715</a> }
<a name="716" href="#716">716</a>
<a name="717" href="#717">717</a> <em class="jxr_comment">//</em>
<a name="718" href="#718">718</a> <em class="jxr_comment">// Now set up all the funky stuff that the JSP needs. Firstly the protocol</em>
<a name="719" href="#719">719</a> <em class="jxr_comment">// specific parameters which will come back to us</em>
<a name="720" href="#720">720</a> <em class="jxr_comment">//</em>
<a name="721" href="#721">721</a>
<a name="722" href="#722">722</a> <strong class="jxr_keyword">if</strong> (twoZeroProtocol) {
<a name="723" href="#723">723</a> <em class="jxr_comment">//</em>
<a name="724" href="#724">724</a> <em class="jxr_comment">// The return address was set up in setupReturnAddress</em>
<a name="725" href="#725">725</a> <em class="jxr_comment">//</em>
<a name="726" href="#726">726</a> String returnString = (String) req.getAttribute(RETURN_ATTRIBUTE_NAME);
<a name="727" href="#727">727</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">null</strong> == returnString || 0 == returnString.length()) {
<a name="728" href="#728">728</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/WayfException.html">WayfException</a>(<span class="jxr_string">"Parameter "</span> + RETURN_PARAM_NAME + <span class="jxr_string">" not supplied"</span>);
<a name="729" href="#729">729</a> }
<a name="730" href="#730">730</a>
<a name="731" href="#731">731</a> String returnId = getValue(req, RETURNID_PARAM_NAME);
<a name="732" href="#732">732</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">null</strong> == returnId || 0 == returnId.length()) {
<a name="733" href="#733">733</a> returnId = RETURNID_DEFAULT_VALUE;
<a name="734" href="#734">734</a> }
<a name="735" href="#735">735</a> <em class="jxr_comment">//</em>
<a name="736" href="#736">736</a> <em class="jxr_comment">// Return *means* something so we cannot use it as an attribute</em>
<a name="737" href="#737">737</a> <em class="jxr_comment">//</em>
<a name="738" href="#738">738</a> req.setAttribute(RETURN_ATTRIBUTE_NAME, returnString);
<a name="739" href="#739">739</a> req.setAttribute(RETURNID_PARAM_NAME, returnId);
<a name="740" href="#740">740</a> req.setAttribute(ENTITYID_PARAM_NAME, providerId);
<a name="741" href="#741">741</a>
<a name="742" href="#742">742</a> } <strong class="jxr_keyword">else</strong> {
<a name="743" href="#743">743</a> String target = getValue(req, TARGET_PARAM_NAME);
<a name="744" href="#744">744</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">null</strong> == target || 0 == target.length()) {
<a name="745" href="#745">745</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/WayfException.html">WayfException</a>(<span class="jxr_string">"Could not extract target from provided parameters"</span>);
<a name="746" href="#746">746</a> }
<a name="747" href="#747">747</a> req.setAttribute(SHIRE_PARAM_NAME, shire);
<a name="748" href="#748">748</a> req.setAttribute(TARGET_PARAM_NAME, target);
<a name="749" href="#749">749</a> req.setAttribute(PROVIDERID_PARAM_NAME, providerId);
<a name="750" href="#750">750</a> <em class="jxr_comment">//</em>
<a name="751" href="#751">751</a> <em class="jxr_comment">// Time is in unix format</em>
<a name="752" href="#752">752</a> <em class="jxr_comment">//</em>
<a name="753" href="#753">753</a> req.setAttribute(<span class="jxr_string">"time"</span>, <strong class="jxr_keyword">new</strong> Long(<strong class="jxr_keyword">new</strong> Date().getTime() / 1000).toString());
<a name="754" href="#754">754</a>
<a name="755" href="#755">755</a> }
<a name="756" href="#756">756</a>
<a name="757" href="#757">757</a> <em class="jxr_comment">//</em>
<a name="758" href="#758">758</a> <em class="jxr_comment">// Setup the stuff that the GUI wants. </em>
<a name="759" href="#759">759</a> <em class="jxr_comment">//</em>
<a name="760" href="#760">760</a>
<a name="761" href="#761">761</a> setDisplayLanguage(sites, req);
<a name="762" href="#762">762</a> req.setAttribute(<span class="jxr_string">"sites"</span>, sites);
<a name="763" href="#763">763</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">null</strong> != siteLists) {
<a name="764" href="#764">764</a> <strong class="jxr_keyword">for</strong> (IdPSiteSetEntry siteSetEntry:siteLists) {
<a name="765" href="#765">765</a> setDisplayLanguage(siteSetEntry.getSites(), req);
<a name="766" href="#766">766</a> }
<a name="767" href="#767">767</a> }
<a name="768" href="#768">768</a>
<a name="769" href="#769">769</a> req.setAttribute(<span class="jxr_string">"siteLists"</span>, siteLists);
<a name="770" href="#770">770</a> req.setAttribute(<span class="jxr_string">"requestURL"</span>, req.getRequestURI().toString());
<a name="771" href="#771">771</a>
<a name="772" href="#772">772</a> <strong class="jxr_keyword">if</strong> (searchResults != <strong class="jxr_keyword">null</strong>) {
<a name="773" href="#773">773</a> <strong class="jxr_keyword">if</strong> (searchResults.size() != 0) {
<a name="774" href="#774">774</a> setDisplayLanguage(searchResults, req);
<a name="775" href="#775">775</a> req.setAttribute(<span class="jxr_string">"searchresults"</span>, searchResults);
<a name="776" href="#776">776</a> } <strong class="jxr_keyword">else</strong> {
<a name="777" href="#777">777</a> req.setAttribute(<span class="jxr_string">"searchResultsEmpty"</span>, <span class="jxr_string">"true"</span>);
<a name="778" href="#778">778</a> }
<a name="779" href="#779">779</a> }
<a name="780" href="#780">780</a>
<a name="781" href="#781">781</a> <strong class="jxr_keyword">if</strong> (hintList.size() > 0) {
<a name="782" href="#782">782</a> setDisplayLanguage(hintList, req);
<a name="783" href="#783">783</a> req.setAttribute(<span class="jxr_string">"cookieList"</span>, hintList);
<a name="784" href="#784">784</a> }
<a name="785" href="#785">785</a>
<a name="786" href="#786">786</a> LOG.debug(<span class="jxr_string">"Displaying WAYF selection page."</span>);
<a name="787" href="#787">787</a> RequestDispatcher rd = req.getRequestDispatcher(config.getJspFile());
<a name="788" href="#788">788</a>
<a name="789" href="#789">789</a> <em class="jxr_comment">//</em>
<a name="790" href="#790">790</a> <em class="jxr_comment">// And off to the jsp</em>
<a name="791" href="#791">791</a> <em class="jxr_comment">//</em>
<a name="792" href="#792">792</a> rd.forward(req, res);
<a name="793" href="#793">793</a> } <strong class="jxr_keyword">catch</strong> (IOException ioe) {
<a name="794" href="#794">794</a> LOG.error(<span class="jxr_string">"Problem displaying WAYF UI.\n"</span> + ioe.getMessage());
<a name="795" href="#795">795</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/WayfException.html">WayfException</a>(<span class="jxr_string">"Problem displaying WAYF UI"</span>, ioe);
<a name="796" href="#796">796</a> } <strong class="jxr_keyword">catch</strong> (ServletException se) {
<a name="797" href="#797">797</a> LOG.error(<span class="jxr_string">"Problem displaying WAYF UI.\n"</span> + se.getMessage());
<a name="798" href="#798">798</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/WayfException.html">WayfException</a>(<span class="jxr_string">"Problem displaying WAYF UI"</span>, se);
<a name="799" href="#799">799</a> }
<a name="800" href="#800">800</a> }
<a name="801" href="#801">801</a>
<a name="802" href="#802">802</a> <em class="jxr_javadoccomment">/**</em>
<a name="803" href="#803">803</a> <em class="jxr_javadoccomment"> * Prior to display we set the display language from the</em>
<a name="804" href="#804">804</a> <em class="jxr_javadoccomment"> * browser. There is probably a proper way to do this using</em>
<a name="805" href="#805">805</a> <em class="jxr_javadoccomment"> * jsp, but I want to keep the API between JSP and java the same 1.3->2.0</em>
<a name="806" href="#806">806</a> <em class="jxr_javadoccomment"> * @param sites - the sites we need to impact</em>
<a name="807" href="#807">807</a> <em class="jxr_javadoccomment"> * @param req - from whiuch we get the locale</em>
<a name="808" href="#808">808</a> <em class="jxr_javadoccomment"> */</em>
<a name="809" href="#809">809</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> setDisplayLanguage(Collection<IdPSite> sites, HttpServletRequest req) {
<a name="810" href="#810">810</a>
<a name="811" href="#811">811</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">null</strong> == sites) {
<a name="812" href="#812">812</a> <strong class="jxr_keyword">return</strong>;
<a name="813" href="#813">813</a> }
<a name="814" href="#814">814</a> Locale locale = req.getLocale();
<a name="815" href="#815">815</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">null</strong> == locale) {
<a name="816" href="#816">816</a> Locale.getDefault();
<a name="817" href="#817">817</a> }
<a name="818" href="#818">818</a> String lang = locale.getLanguage();
<a name="819" href="#819">819</a>
<a name="820" href="#820">820</a> <strong class="jxr_keyword">for</strong> (IdPSite site : sites) {
<a name="821" href="#821">821</a> site.setDisplayLanguage(lang);
<a name="822" href="#822">822</a> }
<a name="823" href="#823">823</a> }
<a name="824" href="#824">824</a>
<a name="825" href="#825">825</a>
<a name="826" href="#826">826</a> <em class="jxr_javadoccomment">/**</em>
<a name="827" href="#827">827</a> <em class="jxr_javadoccomment"> * Uses an HTTP Status 307 redirect to forward the user to the IdP or the SP.</em>
<a name="828" href="#828">828</a> <em class="jxr_javadoccomment"> * </em>
<a name="829" href="#829">829</a> <em class="jxr_javadoccomment"> * @param req request under consideration</em>
<a name="830" href="#830">830</a> <em class="jxr_javadoccomment"> * @param res response under construction</em>
<a name="831" href="#831">831</a> <em class="jxr_javadoccomment"> * @param site The Idp</em>
<a name="832" href="#832">832</a> <em class="jxr_javadoccomment"> * @throws WayfException if bad things happen.</em>
<a name="833" href="#833">833</a> <em class="jxr_javadoccomment"> */</em>
<a name="834" href="#834">834</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> forwardRequest(HttpServletRequest req, HttpServletResponse res, <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/IdPSite.html">IdPSite</a> site)
<a name="835" href="#835">835</a> <strong class="jxr_keyword">throws</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/WayfException.html">WayfException</a> {
<a name="836" href="#836">836</a>
<a name="837" href="#837">837</a> String shire = getValue(req, SHIRE_PARAM_NAME);
<a name="838" href="#838">838</a> String providerId = getSPId(req);
<a name="839" href="#839">839</a> <strong class="jxr_keyword">boolean</strong> twoZeroProtocol = (shire == <strong class="jxr_keyword">null</strong>);
<a name="840" href="#840">840</a>
<a name="841" href="#841">841</a> <strong class="jxr_keyword">if</strong> (!twoZeroProtocol) {
<a name="842" href="#842">842</a> String handleService = site.getAddressForWAYF();
<a name="843" href="#843">843</a> <strong class="jxr_keyword">if</strong> (handleService != <strong class="jxr_keyword">null</strong> ) {
<a name="844" href="#844">844</a>
<a name="845" href="#845">845</a> String target = getValue(req, TARGET_PARAM_NAME);
<a name="846" href="#846">846</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">null</strong> == target || 0 == target.length()) {
<a name="847" href="#847">847</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/WayfException.html">WayfException</a>(<span class="jxr_string">"Could not extract target from provided parameters"</span>);
<a name="848" href="#848">848</a> }
<a name="849" href="#849">849</a>
<a name="850" href="#850">850</a> LOG.info(<span class="jxr_string">"Redirecting to selected Handle Service: "</span> + handleService);
<a name="851" href="#851">851</a> <strong class="jxr_keyword">try</strong> {
<a name="852" href="#852">852</a> StringBuffer buffer = <strong class="jxr_keyword">new</strong> StringBuffer(handleService +
<a name="853" href="#853">853</a> <span class="jxr_string">"?"</span> + TARGET_PARAM_NAME + <span class="jxr_string">"="</span>);
<a name="854" href="#854">854</a> buffer.append(URLEncoder.encode(target, <span class="jxr_string">"UTF-8"</span>));
<a name="855" href="#855">855</a> buffer.append(<span class="jxr_string">"&"</span> + SHIRE_PARAM_NAME + <span class="jxr_string">"="</span>);
<a name="856" href="#856">856</a> buffer.append(URLEncoder.encode(shire, <span class="jxr_string">"UTF-8"</span>));
<a name="857" href="#857">857</a> buffer.append(<span class="jxr_string">"&"</span> + PROVIDERID_PARAM_NAME + <span class="jxr_string">"="</span>);
<a name="858" href="#858">858</a> buffer.append(URLEncoder.encode(providerId, <span class="jxr_string">"UTF-8"</span>));
<a name="859" href="#859">859</a>
<a name="860" href="#860">860</a> <em class="jxr_comment">//</em>
<a name="861" href="#861">861</a> <em class="jxr_comment">// Time is as per U**X</em>
<a name="862" href="#862">862</a> <em class="jxr_comment">//</em>
<a name="863" href="#863">863</a> buffer.append(<span class="jxr_string">"&"</span> + TIME_PARAM_NAME + <span class="jxr_string">"="</span>);
<a name="864" href="#864">864</a> buffer.append(<strong class="jxr_keyword">new</strong> Long(<strong class="jxr_keyword">new</strong> Date().getTime() / 1000).toString());
<a name="865" href="#865">865</a> res.sendRedirect(buffer.toString());
<a name="866" href="#866">866</a> } <strong class="jxr_keyword">catch</strong> (IOException ioe) {
<a name="867" href="#867">867</a> <em class="jxr_comment">//</em>
<a name="868" href="#868">868</a> <em class="jxr_comment">// That failed. </em>
<a name="869" href="#869">869</a> <em class="jxr_comment">//</em>
<a name="870" href="#870">870</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/WayfException.html">WayfException</a>(<span class="jxr_string">"Error forwarding to IdP: \n"</span> + ioe.getMessage());
<a name="871" href="#871">871</a> }
<a name="872" href="#872">872</a> } <strong class="jxr_keyword">else</strong> {
<a name="873" href="#873">873</a> String s = <span class="jxr_string">"Error finding to IdP: "</span> + site.getDisplayName(req);
<a name="874" href="#874">874</a> LOG.error(s);
<a name="875" href="#875">875</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);
<a name="876" href="#876">876</a> }
<a name="877" href="#877">877</a> } <strong class="jxr_keyword">else</strong> {
<a name="878" href="#878">878</a> String returnUrl = (String) req.getAttribute(RETURN_ATTRIBUTE_NAME);
<a name="879" href="#879">879</a>
<a name="880" href="#880">880</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">null</strong> == returnUrl || 0 == returnUrl.length()) {
<a name="881" href="#881">881</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/WayfException.html">WayfException</a>(<span class="jxr_string">"Could not find return parameter"</span>);
<a name="882" href="#882">882</a> }
<a name="883" href="#883">883</a> <strong class="jxr_keyword">try</strong> {
<a name="884" href="#884">884</a> returnUrl = URLDecoder.decode(returnUrl, <span class="jxr_string">"UTF-8"</span>);
<a name="885" href="#885">885</a> } <strong class="jxr_keyword">catch</strong> (UnsupportedEncodingException e) {
<a name="886" href="#886">886</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/WayfException.html">WayfException</a>(<span class="jxr_string">"Did not understand parameter "</span>, e);
<a name="887" href="#887">887</a> }
<a name="888" href="#888">888</a> String redirect;
<a name="889" href="#889">889</a> <strong class="jxr_keyword">if</strong> (site != <strong class="jxr_keyword">null</strong>) {
<a name="890" href="#890">890</a> StringBuffer buffer = <strong class="jxr_keyword">new</strong> StringBuffer(returnUrl);
<a name="891" href="#891">891</a> <em class="jxr_comment">//</em>
<a name="892" href="#892">892</a> <em class="jxr_comment">// If we were given anybody to lookup, construct the URL</em>
<a name="893" href="#893">893</a> <em class="jxr_comment">//</em>
<a name="894" href="#894">894</a> String returnParam = getValue(req, RETURNID_PARAM_NAME);
<a name="895" href="#895">895</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">null</strong> == returnParam || 0 == returnParam.length()) {
<a name="896" href="#896">896</a> returnParam = RETURNID_DEFAULT_VALUE;
<a name="897" href="#897">897</a> }
<a name="898" href="#898">898</a> <em class="jxr_comment">//</em>
<a name="899" href="#899">899</a> <em class="jxr_comment">// Do we add a '?' or a '&' for the parameters</em>
<a name="900" href="#900">900</a> <em class="jxr_comment">//</em>
<a name="901" href="#901">901</a>
<a name="902" href="#902">902</a> <strong class="jxr_keyword">if</strong> (returnUrl.indexOf('?') >= 0) {
<a name="903" href="#903">903</a> <em class="jxr_comment">//</em>
<a name="904" href="#904">904</a> <em class="jxr_comment">// there is a parameter already. Add a '&'</em>
<a name="905" href="#905">905</a> <em class="jxr_comment">//</em>
<a name="906" href="#906">906</a> buffer.append(<span class="jxr_string">"&"</span> + returnParam + <span class="jxr_string">"="</span>);
<a name="907" href="#907">907</a> } <strong class="jxr_keyword">else</strong> {
<a name="908" href="#908">908</a> <em class="jxr_comment">//</em>
<a name="909" href="#909">909</a> <em class="jxr_comment">// No parameter. Use ?</em>
<a name="910" href="#910">910</a> <em class="jxr_comment">//</em>
<a name="911" href="#911">911</a> buffer.append(<span class="jxr_string">"?"</span> + returnParam + <span class="jxr_string">"="</span>);
<a name="912" href="#912">912</a> }
<a name="913" href="#913">913</a> buffer.append(site.getName());
<a name="914" href="#914">914</a> redirect = buffer.toString();
<a name="915" href="#915">915</a> } <strong class="jxr_keyword">else</strong> {
<a name="916" href="#916">916</a> <em class="jxr_comment">//</em>
<a name="917" href="#917">917</a> <em class="jxr_comment">// Just send it back</em>
<a name="918" href="#918">918</a> <em class="jxr_comment">//</em>
<a name="919" href="#919">919</a> redirect = returnUrl;
<a name="920" href="#920">920</a> }
<a name="921" href="#921">921</a>
<a name="922" href="#922">922</a> LOG.debug(<span class="jxr_string">"Dispatching to "</span> + redirect);
<a name="923" href="#923">923</a>
<a name="924" href="#924">924</a> <strong class="jxr_keyword">try</strong> {
<a name="925" href="#925">925</a> res.sendRedirect(redirect);
<a name="926" href="#926">926</a> } <strong class="jxr_keyword">catch</strong> (IOException ioe) {
<a name="927" href="#927">927</a> <em class="jxr_comment">//</em>
<a name="928" href="#928">928</a> <em class="jxr_comment">// That failed. </em>
<a name="929" href="#929">929</a> <em class="jxr_comment">//</em>
<a name="930" href="#930">930</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/WayfException.html">WayfException</a>(<span class="jxr_string">"Error forwarding back to Sp: \n"</span> + ioe.getMessage());
<a name="931" href="#931">931</a> }
<a name="932" href="#932">932</a> }
<a name="933" href="#933">933</a> }
<a name="934" href="#934">934</a>
<a name="935" href="#935">935</a> <em class="jxr_javadoccomment">/**</em>
<a name="936" href="#936">936</a> <em class="jxr_javadoccomment"> * Handles all "recoverable" errors in WAYF processing by logging the error and forwarding the user to an</em>
<a name="937" href="#937">937</a> <em class="jxr_javadoccomment"> * appropriate error page.</em>
<a name="938" href="#938">938</a> <em class="jxr_javadoccomment"> * </em>
<a name="939" href="#939">939</a> <em class="jxr_javadoccomment"> * @param req request under consideration</em>
<a name="940" href="#940">940</a> <em class="jxr_javadoccomment"> * @param res response under construction</em>
<a name="941" href="#941">941</a> <em class="jxr_javadoccomment"> * @param message - what so say</em>
<a name="942" href="#942">942</a> <em class="jxr_javadoccomment"> */</em>
<a name="943" href="#943">943</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> handleError(HttpServletRequest req, HttpServletResponse res, String message) {
<a name="944" href="#944">944</a>
<a name="945" href="#945">945</a> LOG.debug(<span class="jxr_string">"Displaying WAYF error page."</span>);
<a name="946" href="#946">946</a> req.setAttribute(<span class="jxr_string">"errorText"</span>, message);
<a name="947" href="#947">947</a> req.setAttribute(<span class="jxr_string">"requestURL"</span>, req.getRequestURI().toString());
<a name="948" href="#948">948</a> RequestDispatcher rd = req.getRequestDispatcher(config.getErrorJspFile());
<a name="949" href="#949">949</a>
<a name="950" href="#950">950</a> <strong class="jxr_keyword">try</strong> {
<a name="951" href="#951">951</a> rd.forward(req, res);
<a name="952" href="#952">952</a> } <strong class="jxr_keyword">catch</strong> (IOException ioe) {
<a name="953" href="#953">953</a> LOG.error(<span class="jxr_string">"Problem trying to display WAYF error page: "</span> + ioe.toString());
<a name="954" href="#954">954</a> } <strong class="jxr_keyword">catch</strong> (ServletException se) {
<a name="955" href="#955">955</a> LOG.error(<span class="jxr_string">"Problem trying to display WAYF error page: "</span> + se.toString());
<a name="956" href="#956">956</a> }
<a name="957" href="#957">957</a> }
<a name="958" href="#958">958</a>
<a name="959" href="#959">959</a> <em class="jxr_javadoccomment">/**</em>
<a name="960" href="#960">960</a> <em class="jxr_javadoccomment"> * Gets the value for the parameter either from the parameter or from jsp.</em>
<a name="961" href="#961">961</a> <em class="jxr_javadoccomment"> * @param req - the request.</em>
<a name="962" href="#962">962</a> <em class="jxr_javadoccomment"> * @param name - the name of the parameter.</em>
<a name="963" href="#963">963</a> <em class="jxr_javadoccomment"> * @return - result</em>
<a name="964" href="#964">964</a> <em class="jxr_javadoccomment"> */</em>
<a name="965" href="#965">965</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> String getValue(HttpServletRequest req, String name) {
<a name="966" href="#966">966</a>
<a name="967" href="#967">967</a>
<a name="968" href="#968">968</a> String value = req.getParameter(name);
<a name="969" href="#969">969</a> <strong class="jxr_keyword">if</strong> (value != <strong class="jxr_keyword">null</strong>) {
<a name="970" href="#970">970</a> <strong class="jxr_keyword">return</strong> value;
<a name="971" href="#971">971</a> }
<a name="972" href="#972">972</a> <strong class="jxr_keyword">return</strong> (String) req.getAttribute(name);
<a name="973" href="#973">973</a> }
<a name="974" href="#974">974</a>
<a name="975" href="#975">975</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> String getSPId(HttpServletRequest req) <strong class="jxr_keyword">throws</strong> WayfException {
<a name="976" href="#976">976</a>
<a name="977" href="#977">977</a> <em class="jxr_comment">//</em>
<a name="978" href="#978">978</a> <em class="jxr_comment">// Try first with 2.0 version</em>
<a name="979" href="#979">979</a> <em class="jxr_comment">//</em>
<a name="980" href="#980">980</a> String param = req.getParameter(ENTITYID_PARAM_NAME);
<a name="981" href="#981">981</a> <strong class="jxr_keyword">if</strong> (param != <strong class="jxr_keyword">null</strong> && !(param.length() == 0)) {
<a name="982" href="#982">982</a> <strong class="jxr_keyword">return</strong> param;
<a name="983" href="#983">983</a> }
<a name="984" href="#984">984</a>
<a name="985" href="#985">985</a> param = (String) req.getAttribute(ENTITYID_PARAM_NAME);
<a name="986" href="#986">986</a> <strong class="jxr_keyword">if</strong> (param != <strong class="jxr_keyword">null</strong> && !(param.length() == 0)) {
<a name="987" href="#987">987</a> <strong class="jxr_keyword">return</strong> param;
<a name="988" href="#988">988</a> }
<a name="989" href="#989">989</a> <em class="jxr_comment">//</em>
<a name="990" href="#990">990</a> <em class="jxr_comment">// So Try with 1.3 version</em>
<a name="991" href="#991">991</a> <em class="jxr_comment">//</em>
<a name="992" href="#992">992</a> param = req.getParameter(PROVIDERID_PARAM_NAME);
<a name="993" href="#993">993</a> <strong class="jxr_keyword">if</strong> (param != <strong class="jxr_keyword">null</strong> && !(param.length() == 0)) {
<a name="994" href="#994">994</a> <strong class="jxr_keyword">return</strong> param;
<a name="995" href="#995">995</a> }
<a name="996" href="#996">996</a>
<a name="997" href="#997">997</a> param = (String) req.getAttribute(PROVIDERID_PARAM_NAME);
<a name="998" href="#998">998</a> <strong class="jxr_keyword">if</strong> (param != <strong class="jxr_keyword">null</strong> && !(param.length() == 0)) {
<a name="999" href="#999">999</a> <strong class="jxr_keyword">return</strong> param;
<a name="1000" href="#1000">1000</a> }
<a name="1001" href="#1001">1001</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/WayfException.html">WayfException</a>(<span class="jxr_string">"Could not locate SP identifier in parameters"</span>);
<a name="1002" href="#1002">1002</a> }
<a name="1003" href="#1003">1003</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>