<!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=UTF-8" />
<title>SamlCookiePlugin xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../../apidocs/edu/internet2/middleware/shibboleth/wayf/plugins/provider/SamlCookiePlugin.html">View Javadoc</a></div><pre>
<a class="jxr_linenumber" name="1" href="#1">1</a> <strong class="jxr_keyword">package</strong> edu.internet2.middleware.shibboleth.wayf.plugins.provider;
<a class="jxr_linenumber" name="2" href="#2">2</a>
<a class="jxr_linenumber" name="3" href="#3">3</a> <strong class="jxr_keyword">import</strong> java.io.UnsupportedEncodingException;
<a class="jxr_linenumber" name="4" href="#4">4</a> <strong class="jxr_keyword">import</strong> java.net.URLDecoder;
<a class="jxr_linenumber" name="5" href="#5">5</a> <strong class="jxr_keyword">import</strong> java.net.URLEncoder;
<a class="jxr_linenumber" name="6" href="#6">6</a> <strong class="jxr_keyword">import</strong> java.util.ArrayList;
<a class="jxr_linenumber" name="7" href="#7">7</a> <strong class="jxr_keyword">import</strong> java.util.Collection;
<a class="jxr_linenumber" name="8" href="#8">8</a> <strong class="jxr_keyword">import</strong> java.util.Iterator;
<a class="jxr_linenumber" name="9" href="#9">9</a> <strong class="jxr_keyword">import</strong> java.util.List;
<a class="jxr_linenumber" name="10" href="#10">10</a> <strong class="jxr_keyword">import</strong> java.util.Map;
<a class="jxr_linenumber" name="11" href="#11">11</a>
<a class="jxr_linenumber" name="12" href="#12">12</a> <strong class="jxr_keyword">import</strong> javax.servlet.http.Cookie;
<a class="jxr_linenumber" name="13" href="#13">13</a> <strong class="jxr_keyword">import</strong> javax.servlet.http.HttpServletRequest;
<a class="jxr_linenumber" name="14" href="#14">14</a> <strong class="jxr_keyword">import</strong> javax.servlet.http.HttpServletResponse;
<a class="jxr_linenumber" name="15" href="#15">15</a>
<a class="jxr_linenumber" name="16" href="#16">16</a> <strong class="jxr_keyword">import</strong> org.apache.log4j.Logger;
<a class="jxr_linenumber" name="17" href="#17">17</a> <strong class="jxr_keyword">import</strong> org.opensaml.saml2.metadata.provider.MetadataProvider;
<a class="jxr_linenumber" name="18" href="#18">18</a> <strong class="jxr_keyword">import</strong> org.opensaml.xml.util.Base64;
<a class="jxr_linenumber" name="19" href="#19">19</a> <strong class="jxr_keyword">import</strong> org.w3c.dom.Element;
<a class="jxr_linenumber" name="20" href="#20">20</a>
<a class="jxr_linenumber" name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> edu.internet2.middleware.shibboleth.wayf.DiscoveryServiceHandler;
<a class="jxr_linenumber" name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> edu.internet2.middleware.shibboleth.wayf.IdPSite;
<a class="jxr_linenumber" name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> edu.internet2.middleware.shibboleth.wayf.WayfException;
<a class="jxr_linenumber" name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> edu.internet2.middleware.shibboleth.wayf.plugins.Plugin;
<a class="jxr_linenumber" name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> edu.internet2.middleware.shibboleth.wayf.plugins.PluginContext;
<a class="jxr_linenumber" name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> edu.internet2.middleware.shibboleth.wayf.plugins.PluginMetadataParameter;
<a class="jxr_linenumber" name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> edu.internet2.middleware.shibboleth.wayf.plugins.WayfRequestHandled;
<a class="jxr_linenumber" name="28" href="#28">28</a>
<a class="jxr_linenumber" name="29" href="#29">29</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="30" href="#30">30</a> <em class="jxr_javadoccomment"> * This is a test implementation of the saml cookie lookup stuff to </em>
<a class="jxr_linenumber" name="31" href="#31">31</a> <em class="jxr_javadoccomment"> * see whether it fits the plugin architecture.</em>
<a class="jxr_linenumber" name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * </em>
<a class="jxr_linenumber" name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * @author Rod Widdowson</em>
<a class="jxr_linenumber" name="34" href="#34">34</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="35" href="#35">35</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="36" href="#36">36</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/provider/SamlCookiePlugin.html">SamlCookiePlugin</a> <strong class="jxr_keyword">implements</strong> <a href="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/Plugin.html">Plugin</a> {
<a class="jxr_linenumber" name="37" href="#37">37</a>
<a class="jxr_linenumber" name="38" href="#38">38</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * The parameter which controls the cache.</em>
<a class="jxr_linenumber" name="40" href="#40">40</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="41" href="#41">41</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String PARAMETER_NAME = <span class="jxr_string">"cache"</span>;
<a class="jxr_linenumber" name="42" href="#42">42</a>
<a class="jxr_linenumber" name="43" href="#43">43</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * Parameter to say make it last a long time.</em>
<a class="jxr_linenumber" name="45" href="#45">45</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="46" href="#46">46</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String PARAMETER_PERM = <span class="jxr_string">"perm"</span>;
<a class="jxr_linenumber" name="47" href="#47">47</a>
<a class="jxr_linenumber" name="48" href="#48">48</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * Parameter to say just keep this as long as the brower is open.</em>
<a class="jxr_linenumber" name="50" href="#50">50</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="51" href="#51">51</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String PARAMETER_SESSION = <span class="jxr_string">"session"</span>;
<a class="jxr_linenumber" name="52" href="#52">52</a>
<a class="jxr_linenumber" name="53" href="#53">53</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * Handle for logging. </em>
<a class="jxr_linenumber" name="55" href="#55">55</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="56" href="#56">56</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> Logger log = Logger.getLogger(SamlCookiePlugin.<strong class="jxr_keyword">class</strong>.getName());
<a class="jxr_linenumber" name="57" href="#57">57</a>
<a class="jxr_linenumber" name="58" href="#58">58</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="59" href="#59">59</a> <em class="jxr_javadoccomment"> * As specified in the SAML2 profiles specification.</em>
<a class="jxr_linenumber" name="60" href="#60">60</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="61" href="#61">61</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String COOKIE_NAME = <span class="jxr_string">"_saml_idp"</span>;
<a class="jxr_linenumber" name="62" href="#62">62</a>
<a class="jxr_linenumber" name="63" href="#63">63</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * By default we keep the cookie around for a week.</em>
<a class="jxr_linenumber" name="65" href="#65">65</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="66" href="#66">66</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> DEFAULT_CACHE_EXPIRATION = 6048000;
<a class="jxr_linenumber" name="67" href="#67">67</a>
<a class="jxr_linenumber" name="68" href="#68">68</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="69" href="#69">69</a> <em class="jxr_javadoccomment"> * Do we always go where the cookie tells us, or do we just provide the cookie as a hint.</em>
<a class="jxr_linenumber" name="70" href="#70">70</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="71" href="#71">71</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> alwaysFollow;
<a class="jxr_linenumber" name="72" href="#72">72</a>
<a class="jxr_linenumber" name="73" href="#73">73</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="74" href="#74">74</a> <em class="jxr_javadoccomment"> * Is our job to clean up the cookie. </em>
<a class="jxr_linenumber" name="75" href="#75">75</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="76" href="#76">76</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> deleteCookie;
<a class="jxr_linenumber" name="77" href="#77">77</a>
<a class="jxr_linenumber" name="78" href="#78">78</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="79" href="#79">79</a> <em class="jxr_javadoccomment"> * Lipservice towards having a common domain cookie. </em>
<a class="jxr_linenumber" name="80" href="#80">80</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="81" href="#81">81</a> <strong class="jxr_keyword">private</strong> String cacheDomain;
<a class="jxr_linenumber" name="82" href="#82">82</a>
<a class="jxr_linenumber" name="83" href="#83">83</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="84" href="#84">84</a> <em class="jxr_javadoccomment"> * How long the cookie our will be active? </em>
<a class="jxr_linenumber" name="85" href="#85">85</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="86" href="#86">86</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">int</strong> cacheExpiration;
<a class="jxr_linenumber" name="87" href="#87">87</a>
<a class="jxr_linenumber" name="88" href="#88">88</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="89" href="#89">89</a> <em class="jxr_javadoccomment"> * This constructor is called during wayf initialization with it's</em>
<a class="jxr_linenumber" name="90" href="#90">90</a> <em class="jxr_javadoccomment"> * own little bit of XML config.</em>
<a class="jxr_linenumber" name="91" href="#91">91</a> <em class="jxr_javadoccomment"> * </em>
<a class="jxr_linenumber" name="92" href="#92">92</a> <em class="jxr_javadoccomment"> * @param element - further information to be gleaned from the DOM.</em>
<a class="jxr_linenumber" name="93" href="#93">93</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="94" href="#94">94</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/provider/SamlCookiePlugin.html">SamlCookiePlugin</a>(Element element) {
<a class="jxr_linenumber" name="95" href="#95">95</a> <em class="jxr_comment">/*</em>
<a class="jxr_linenumber" name="96" href="#96">96</a> <em class="jxr_comment"> * <Plugin idenfifier="WayfCookiePlugin" </em>
<a class="jxr_linenumber" name="97" href="#97">97</a> <em class="jxr_comment"> * type="edu.internet2.middleware.shibboleth.wayf.plugins.provider.SamlCookiePlugin"</em>
<a class="jxr_linenumber" name="98" href="#98">98</a> <em class="jxr_comment"> * alwaysFollow = "FALSE"</em>
<a class="jxr_linenumber" name="99" href="#99">99</a> <em class="jxr_comment"> * deleteCookie = "FALSE"</em>
<a class="jxr_linenumber" name="100" href="#100">100</a> <em class="jxr_comment"> * cacheExpiration = "number" </em>
<a class="jxr_linenumber" name="101" href="#101">101</a> <em class="jxr_comment"> * cacheDomain = "string"/> </em>
<a class="jxr_linenumber" name="102" href="#102">102</a> <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="103" href="#103">103</a> log.info(<span class="jxr_string">"New plugin"</span>);
<a class="jxr_linenumber" name="104" href="#104">104</a> String s;
<a class="jxr_linenumber" name="105" href="#105">105</a>
<a class="jxr_linenumber" name="106" href="#106">106</a> s = element.getAttribute(<span class="jxr_string">"alwaysFollow"</span>);
<a class="jxr_linenumber" name="107" href="#107">107</a> <strong class="jxr_keyword">if</strong> (s != <strong class="jxr_keyword">null</strong> && !s.equals(<span class="jxr_string">""</span>) ) {
<a class="jxr_linenumber" name="108" href="#108">108</a> alwaysFollow = Boolean.valueOf(s).booleanValue();
<a class="jxr_linenumber" name="109" href="#109">109</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="110" href="#110">110</a> alwaysFollow = <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="111" href="#111">111</a> }
<a class="jxr_linenumber" name="112" href="#112">112</a>
<a class="jxr_linenumber" name="113" href="#113">113</a> s = element.getAttribute(<span class="jxr_string">"deleteCookie"</span>);
<a class="jxr_linenumber" name="114" href="#114">114</a> <strong class="jxr_keyword">if</strong> (s != <strong class="jxr_keyword">null</strong> && !s.equals(<span class="jxr_string">""</span>)) {
<a class="jxr_linenumber" name="115" href="#115">115</a> deleteCookie = Boolean.valueOf(s).booleanValue();
<a class="jxr_linenumber" name="116" href="#116">116</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="117" href="#117">117</a> deleteCookie = false;
<a class="jxr_linenumber" name="118" href="#118">118</a> }
<a class="jxr_linenumber" name="119" href="#119">119</a>
<a class="jxr_linenumber" name="120" href="#120">120</a> s = element.getAttribute(<span class="jxr_string">"cacheDomain"</span>);
<a class="jxr_linenumber" name="121" href="#121">121</a> <strong class="jxr_keyword">if</strong> ((s != <strong class="jxr_keyword">null</strong>) && !s.equals(<span class="jxr_string">""</span>)) {
<a class="jxr_linenumber" name="122" href="#122">122</a> cacheDomain = s;
<a class="jxr_linenumber" name="123" href="#123">123</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="124" href="#124">124</a> cacheDomain = <span class="jxr_string">""</span>;
<a class="jxr_linenumber" name="125" href="#125">125</a> }
<a class="jxr_linenumber" name="126" href="#126">126</a>
<a class="jxr_linenumber" name="127" href="#127">127</a> s = element.getAttribute(<span class="jxr_string">"cacheExpiration"</span>);
<a class="jxr_linenumber" name="128" href="#128">128</a> <strong class="jxr_keyword">if</strong> ((s != <strong class="jxr_keyword">null</strong>) && !s.equals(<span class="jxr_string">""</span>)) {
<a class="jxr_linenumber" name="129" href="#129">129</a>
<a class="jxr_linenumber" name="130" href="#130">130</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="131" href="#131">131</a>
<a class="jxr_linenumber" name="132" href="#132">132</a> cacheExpiration = Integer.parseInt(s);
<a class="jxr_linenumber" name="133" href="#133">133</a> } <strong class="jxr_keyword">catch</strong> (NumberFormatException ex) {
<a class="jxr_linenumber" name="134" href="#134">134</a>
<a class="jxr_linenumber" name="135" href="#135">135</a> log.error(<span class="jxr_string">"Invalid CacheExpiration value - "</span> + s);
<a class="jxr_linenumber" name="136" href="#136">136</a> cacheExpiration = DEFAULT_CACHE_EXPIRATION;
<a class="jxr_linenumber" name="137" href="#137">137</a> }
<a class="jxr_linenumber" name="138" href="#138">138</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="139" href="#139">139</a> cacheExpiration = DEFAULT_CACHE_EXPIRATION;
<a class="jxr_linenumber" name="140" href="#140">140</a> }
<a class="jxr_linenumber" name="141" href="#141">141</a> }
<a class="jxr_linenumber" name="142" href="#142">142</a>
<a class="jxr_linenumber" name="143" href="#143">143</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="144" href="#144">144</a> <em class="jxr_javadoccomment"> * Create a plugin with the hard-wired default settings.</em>
<a class="jxr_linenumber" name="145" href="#145">145</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="146" href="#146">146</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/provider/SamlCookiePlugin.html">SamlCookiePlugin</a>() {
<a class="jxr_linenumber" name="147" href="#147">147</a> alwaysFollow = false;
<a class="jxr_linenumber" name="148" href="#148">148</a> deleteCookie = false;
<a class="jxr_linenumber" name="149" href="#149">149</a> cacheExpiration = DEFAULT_CACHE_EXPIRATION;
<a class="jxr_linenumber" name="150" href="#150">150</a> }
<a class="jxr_linenumber" name="151" href="#151">151</a>
<a class="jxr_linenumber" name="152" href="#152">152</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="153" href="#153">153</a> <em class="jxr_javadoccomment"> * This is the 'hook' in the lookup part of Discovery Service processing. </em>
<a class="jxr_linenumber" name="154" href="#154">154</a> <em class="jxr_javadoccomment"> * </em>
<a class="jxr_linenumber" name="155" href="#155">155</a> <em class="jxr_javadoccomment"> * @param req - Describes the current request. Used to find any appropriate cookies </em>
<a class="jxr_linenumber" name="156" href="#156">156</a> <em class="jxr_javadoccomment"> * @param res - Describes the current response. Used to redirect the request. </em>
<a class="jxr_linenumber" name="157" href="#157">157</a> <em class="jxr_javadoccomment"> * @param parameter - Describes the metadata.</em>
<a class="jxr_linenumber" name="158" href="#158">158</a> <em class="jxr_javadoccomment"> * @param context - Any processing context returned from a previous call. We set this on first call and</em>
<a class="jxr_linenumber" name="159" href="#159">159</a> <em class="jxr_javadoccomment"> * use non null to indicate that we don't go there again.</em>
<a class="jxr_linenumber" name="160" href="#160">160</a> <em class="jxr_javadoccomment"> * @param validIdps The list of IdPs which is currently views as possibly matches for the pattern. </em>
<a class="jxr_linenumber" name="161" href="#161">161</a> <em class="jxr_javadoccomment"> * The Key is the EntityId for the IdP and the value the object which describes </em>
<a class="jxr_linenumber" name="162" href="#162">162</a> <em class="jxr_javadoccomment"> * the Idp </em>
<a class="jxr_linenumber" name="163" href="#163">163</a> <em class="jxr_javadoccomment"> * @param idpList The set of Idps which are currently considered as potential hints. </em>
<a class="jxr_linenumber" name="164" href="#164">164</a> <em class="jxr_javadoccomment"> * @return a context to hand to subsequent calls</em>
<a class="jxr_linenumber" name="165" href="#165">165</a> <em class="jxr_javadoccomment"> * @throws WayfRequestHandled if the plugin has handled the request.</em>
<a class="jxr_linenumber" name="166" href="#166">166</a> <em class="jxr_javadoccomment"> * issues a redirect)</em>
<a class="jxr_linenumber" name="167" href="#167">167</a> <em class="jxr_javadoccomment"> * </em>
<a class="jxr_linenumber" name="168" href="#168">168</a> <em class="jxr_javadoccomment"> * @see edu.internet2.middleware.shibboleth.wayf.plugins.Plugin#lookup</em>
<a class="jxr_linenumber" name="169" href="#169">169</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="170" href="#170">170</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/PluginContext.html">PluginContext</a> lookup(HttpServletRequest req,
<a class="jxr_linenumber" name="171" href="#171">171</a> HttpServletResponse res,
<a class="jxr_linenumber" name="172" href="#172">172</a> <a href="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/PluginMetadataParameter.html">PluginMetadataParameter</a> parameter,
<a class="jxr_linenumber" name="173" href="#173">173</a> Map<String, IdPSite> validIdps,
<a class="jxr_linenumber" name="174" href="#174">174</a> <a href="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/PluginContext.html">PluginContext</a> context,
<a class="jxr_linenumber" name="175" href="#175">175</a> List <IdPSite> idpList) <strong class="jxr_keyword">throws</strong> WayfRequestHandled {
<a class="jxr_linenumber" name="176" href="#176">176</a>
<a class="jxr_linenumber" name="177" href="#177">177</a> <strong class="jxr_keyword">if</strong> (context != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="178" href="#178">178</a> <em class="jxr_comment">//</em>
<a class="jxr_linenumber" name="179" href="#179">179</a> <em class="jxr_comment">// We only need to be called once</em>
<a class="jxr_linenumber" name="180" href="#180">180</a> <em class="jxr_comment">//</em>
<a class="jxr_linenumber" name="181" href="#181">181</a> <strong class="jxr_keyword">return</strong> context;
<a class="jxr_linenumber" name="182" href="#182">182</a> }
<a class="jxr_linenumber" name="183" href="#183">183</a>
<a class="jxr_linenumber" name="184" href="#184">184</a> <strong class="jxr_keyword">if</strong> (deleteCookie) {
<a class="jxr_linenumber" name="185" href="#185">185</a> deleteCookie(req, res);
<a class="jxr_linenumber" name="186" href="#186">186</a> <em class="jxr_comment">//</em>
<a class="jxr_linenumber" name="187" href="#187">187</a> <em class="jxr_comment">// Only need to be called once - so set up a parameter</em>
<a class="jxr_linenumber" name="188" href="#188">188</a> <em class="jxr_comment">//</em>
<a class="jxr_linenumber" name="189" href="#189">189</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/provider/SamlCookiePlugin.html">Context</a>() ;
<a class="jxr_linenumber" name="190" href="#190">190</a> }
<a class="jxr_linenumber" name="191" href="#191">191</a> List <String> idps = getIdPCookie(req, res, cacheDomain).getIdPList();
<a class="jxr_linenumber" name="192" href="#192">192</a>
<a class="jxr_linenumber" name="193" href="#193">193</a> <strong class="jxr_keyword">for</strong> (String idpName : idps) {
<a class="jxr_linenumber" name="194" href="#194">194</a> <a href="../../../../../../../edu/internet2/middleware/shibboleth/wayf/IdPSite.html">IdPSite</a> idp = validIdps.get(idpName);
<a class="jxr_linenumber" name="195" href="#195">195</a> <strong class="jxr_keyword">if</strong> (idp != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="196" href="#196">196</a> <strong class="jxr_keyword">if</strong> (alwaysFollow) {
<a class="jxr_linenumber" name="197" href="#197">197</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="198" href="#198">198</a> DiscoveryServiceHandler.forwardRequest(req, res, idp);
<a class="jxr_linenumber" name="199" href="#199">199</a> } <strong class="jxr_keyword">catch</strong> (WayfException e) {
<a class="jxr_linenumber" name="200" href="#200">200</a> <em class="jxr_comment">// Do nothing we are going to throw anyway</em>
<a class="jxr_linenumber" name="201" href="#201">201</a> ;
<a class="jxr_linenumber" name="202" href="#202">202</a> }
<a class="jxr_linenumber" name="203" href="#203">203</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/WayfRequestHandled.html">WayfRequestHandled</a>();
<a class="jxr_linenumber" name="204" href="#204">204</a> }
<a class="jxr_linenumber" name="205" href="#205">205</a> <em class="jxr_comment">//</em>
<a class="jxr_linenumber" name="206" href="#206">206</a> <em class="jxr_comment">// This IDP is ok </em>
<a class="jxr_linenumber" name="207" href="#207">207</a> <em class="jxr_comment">//</em>
<a class="jxr_linenumber" name="208" href="#208">208</a> idpList.add(idp);
<a class="jxr_linenumber" name="209" href="#209">209</a> }
<a class="jxr_linenumber" name="210" href="#210">210</a> }
<a class="jxr_linenumber" name="211" href="#211">211</a>
<a class="jxr_linenumber" name="212" href="#212">212</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="213" href="#213">213</a> }
<a class="jxr_linenumber" name="214" href="#214">214</a>
<a class="jxr_linenumber" name="215" href="#215">215</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="216" href="#216">216</a> <em class="jxr_javadoccomment"> * Plugin point which is called when the data is refreshed.</em>
<a class="jxr_linenumber" name="217" href="#217">217</a> <em class="jxr_javadoccomment"> * @param metadata - where to get the data from.</em>
<a class="jxr_linenumber" name="218" href="#218">218</a> <em class="jxr_javadoccomment"> * @return the value which will be provided as input to subsequent calls</em>
<a class="jxr_linenumber" name="219" href="#219">219</a> <em class="jxr_javadoccomment"> * @see edu.internet2.middleware.shibboleth.wayf.plugins.Plugin#refreshMetadata</em>
<a class="jxr_linenumber" name="220" href="#220">220</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="221" href="#221">221</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/PluginMetadataParameter.html">PluginMetadataParameter</a> refreshMetadata(MetadataProvider metadata) {
<a class="jxr_linenumber" name="222" href="#222">222</a> <em class="jxr_comment">//</em>
<a class="jxr_linenumber" name="223" href="#223">223</a> <em class="jxr_comment">// We don't care about metadata - we are given all that we need</em>
<a class="jxr_linenumber" name="224" href="#224">224</a> <em class="jxr_comment">//</em>
<a class="jxr_linenumber" name="225" href="#225">225</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="226" href="#226">226</a> }
<a class="jxr_linenumber" name="227" href="#227">227</a>
<a class="jxr_linenumber" name="228" href="#228">228</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="229" href="#229">229</a> <em class="jxr_javadoccomment"> * Plgin point for searching.</em>
<a class="jxr_linenumber" name="230" href="#230">230</a> <em class="jxr_javadoccomment"> * </em>
<a class="jxr_linenumber" name="231" href="#231">231</a> <em class="jxr_javadoccomment"> * @throws WayfRequestHandled </em>
<a class="jxr_linenumber" name="232" href="#232">232</a> <em class="jxr_javadoccomment"> * @param req Describes the current request. </em>
<a class="jxr_linenumber" name="233" href="#233">233</a> <em class="jxr_javadoccomment"> * @param res Describes the current response.</em>
<a class="jxr_linenumber" name="234" href="#234">234</a> <em class="jxr_javadoccomment"> * @param parameter Describes the metadata.</em>
<a class="jxr_linenumber" name="235" href="#235">235</a> <em class="jxr_javadoccomment"> * @param pattern What we are searchign for. </em>
<a class="jxr_linenumber" name="236" href="#236">236</a> <em class="jxr_javadoccomment"> * @param validIdps The list of IdPs which is currently views as possibly matches for the pattern. </em>
<a class="jxr_linenumber" name="237" href="#237">237</a> <em class="jxr_javadoccomment"> * The Key is the EntityId for the IdP and the value the object which describes </em>
<a class="jxr_linenumber" name="238" href="#238">238</a> <em class="jxr_javadoccomment"> * the Idp </em>
<a class="jxr_linenumber" name="239" href="#239">239</a> <em class="jxr_javadoccomment"> * @param context Any processing context returned from a previous call. We set this on first call and</em>
<a class="jxr_linenumber" name="240" href="#240">240</a> <em class="jxr_javadoccomment"> * use non null to indicate that we don't go there again.</em>
<a class="jxr_linenumber" name="241" href="#241">241</a> <em class="jxr_javadoccomment"> * @param searchResult What the search yielded. </em>
<a class="jxr_linenumber" name="242" href="#242">242</a> <em class="jxr_javadoccomment"> * @param idpList The set of Idps which are currently considered as potential hints. </em>
<a class="jxr_linenumber" name="243" href="#243">243</a> <em class="jxr_javadoccomment"> * @return a context to hand to subsequent calls.</em>
<a class="jxr_linenumber" name="244" href="#244">244</a> <em class="jxr_javadoccomment"> * @see edu.internet2.middleware.shibboleth.wayf.plugins.Plugin#search</em>
<a class="jxr_linenumber" name="245" href="#245">245</a> <em class="jxr_javadoccomment"> * @throws WayfRequestHandled if the plugin has handled the request.</em>
<a class="jxr_linenumber" name="246" href="#246">246</a> <em class="jxr_javadoccomment"> * </em>
<a class="jxr_linenumber" name="247" href="#247">247</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="248" href="#248">248</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/PluginContext.html">PluginContext</a> search(HttpServletRequest req,
<a class="jxr_linenumber" name="249" href="#249">249</a> HttpServletResponse res,
<a class="jxr_linenumber" name="250" href="#250">250</a> <a href="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/PluginMetadataParameter.html">PluginMetadataParameter</a> parameter,
<a class="jxr_linenumber" name="251" href="#251">251</a> String pattern,
<a class="jxr_linenumber" name="252" href="#252">252</a> Map<String, IdPSite> validIdps,
<a class="jxr_linenumber" name="253" href="#253">253</a> <a href="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/PluginContext.html">PluginContext</a> context,
<a class="jxr_linenumber" name="254" href="#254">254</a> Collection<IdPSite> searchResult,
<a class="jxr_linenumber" name="255" href="#255">255</a> List<IdPSite> idpList) <strong class="jxr_keyword">throws</strong> WayfRequestHandled {
<a class="jxr_linenumber" name="256" href="#256">256</a> <em class="jxr_comment">//</em>
<a class="jxr_linenumber" name="257" href="#257">257</a> <em class="jxr_comment">// Don't distinguish between lookup and search</em>
<a class="jxr_linenumber" name="258" href="#258">258</a> <em class="jxr_comment">//</em>
<a class="jxr_linenumber" name="259" href="#259">259</a> <strong class="jxr_keyword">return</strong> lookup(req, res, parameter, validIdps, context, idpList);
<a class="jxr_linenumber" name="260" href="#260">260</a> }
<a class="jxr_linenumber" name="261" href="#261">261</a>
<a class="jxr_linenumber" name="262" href="#262">262</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="263" href="#263">263</a> <em class="jxr_javadoccomment"> * Plugin point for selection.</em>
<a class="jxr_linenumber" name="264" href="#264">264</a> <em class="jxr_javadoccomment"> * </em>
<a class="jxr_linenumber" name="265" href="#265">265</a> <em class="jxr_javadoccomment"> * @see edu.internet2.middleware.shibboleth.wayf.plugins.Plugin#selected(javax.servlet.http.HttpServletRequest.</em>
<a class="jxr_linenumber" name="266" href="#266">266</a> <em class="jxr_javadoccomment"> * javax.servlet.http.HttpServletResponse, </em>
<a class="jxr_linenumber" name="267" href="#267">267</a> <em class="jxr_javadoccomment"> * edu.internet2.middleware.shibboleth.wayf.plugins.PluginMetadataParameter, </em>
<a class="jxr_linenumber" name="268" href="#268">268</a> <em class="jxr_javadoccomment"> * java.lang.String)</em>
<a class="jxr_linenumber" name="269" href="#269">269</a> <em class="jxr_javadoccomment"> * @param req Describes the current request. </em>
<a class="jxr_linenumber" name="270" href="#270">270</a> <em class="jxr_javadoccomment"> * @param res Describes the current response.</em>
<a class="jxr_linenumber" name="271" href="#271">271</a> <em class="jxr_javadoccomment"> * @param parameter Describes the metadata.</em>
<a class="jxr_linenumber" name="272" href="#272">272</a> <em class="jxr_javadoccomment"> * @param idP Describes the idp.</em>
<a class="jxr_linenumber" name="273" href="#273">273</a> <em class="jxr_javadoccomment"> * </em>
<a class="jxr_linenumber" name="274" href="#274">274</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="275" href="#275">275</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> selected(HttpServletRequest req, HttpServletResponse res,
<a class="jxr_linenumber" name="276" href="#276">276</a> <a href="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/PluginMetadataParameter.html">PluginMetadataParameter</a> parameter, String idP) {
<a class="jxr_linenumber" name="277" href="#277">277</a>
<a class="jxr_linenumber" name="278" href="#278">278</a> <a href="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/provider/SamlCookiePlugin.html">SamlIdPCookie</a> cookie = getIdPCookie(req, res, cacheDomain);
<a class="jxr_linenumber" name="279" href="#279">279</a> String param = req.getParameter(PARAMETER_NAME);
<a class="jxr_linenumber" name="280" href="#280">280</a>
<a class="jxr_linenumber" name="281" href="#281">281</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">null</strong> == param || param.equals(<span class="jxr_string">""</span>)) {
<a class="jxr_linenumber" name="282" href="#282">282</a> <strong class="jxr_keyword">return</strong>;
<a class="jxr_linenumber" name="283" href="#283">283</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (param.equalsIgnoreCase(PARAMETER_SESSION)) {
<a class="jxr_linenumber" name="284" href="#284">284</a> cookie.addIdPName(idP, -1);
<a class="jxr_linenumber" name="285" href="#285">285</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (param.equalsIgnoreCase(PARAMETER_PERM)) {
<a class="jxr_linenumber" name="286" href="#286">286</a> cookie.addIdPName(idP, cacheExpiration);
<a class="jxr_linenumber" name="287" href="#287">287</a> }
<a class="jxr_linenumber" name="288" href="#288">288</a> }
<a class="jxr_linenumber" name="289" href="#289">289</a>
<a class="jxr_linenumber" name="290" href="#290">290</a> <em class="jxr_comment">//</em>
<a class="jxr_linenumber" name="291" href="#291">291</a> <em class="jxr_comment">// Private classes for internal use</em>
<a class="jxr_linenumber" name="292" href="#292">292</a> <em class="jxr_comment">//</em>
<a class="jxr_linenumber" name="293" href="#293">293</a>
<a class="jxr_linenumber" name="294" href="#294">294</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="295" href="#295">295</a> <em class="jxr_javadoccomment"> * This is just a marker tag.</em>
<a class="jxr_linenumber" name="296" href="#296">296</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="297" href="#297">297</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/provider/SamlCookiePlugin.html">Context</a> <strong class="jxr_keyword">implements</strong> <a href="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/PluginContext.html">PluginContext</a> {}
<a class="jxr_linenumber" name="298" href="#298">298</a>
<a class="jxr_linenumber" name="299" href="#299">299</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> </em>
<a class="jxr_linenumber" name="300" href="#300">300</a> <em class="jxr_javadoccomment"> * Class to abstract away the saml cookie for us.</em>
<a class="jxr_linenumber" name="301" href="#301">301</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="302" href="#302">302</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/provider/SamlCookiePlugin.html">SamlIdPCookie</a> {
<a class="jxr_linenumber" name="303" href="#303">303</a>
<a class="jxr_linenumber" name="304" href="#304">304</a>
<a class="jxr_linenumber" name="305" href="#305">305</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="306" href="#306">306</a> <em class="jxr_javadoccomment"> * The associated request.</em>
<a class="jxr_linenumber" name="307" href="#307">307</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="308" href="#308">308</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> HttpServletRequest req;
<a class="jxr_linenumber" name="309" href="#309">309</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="310" href="#310">310</a> <em class="jxr_javadoccomment"> * The associated response.</em>
<a class="jxr_linenumber" name="311" href="#311">311</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="312" href="#312">312</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> HttpServletResponse res;
<a class="jxr_linenumber" name="313" href="#313">313</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="314" href="#314">314</a> <em class="jxr_javadoccomment"> * The associated domain.</em>
<a class="jxr_linenumber" name="315" href="#315">315</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="316" href="#316">316</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> String domain;
<a class="jxr_linenumber" name="317" href="#317">317</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="318" href="#318">318</a> <em class="jxr_javadoccomment"> * The IdPs.</em>
<a class="jxr_linenumber" name="319" href="#319">319</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="320" href="#320">320</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> List <String> idPList = <strong class="jxr_keyword">new</strong> ArrayList<String>();
<a class="jxr_linenumber" name="321" href="#321">321</a>
<a class="jxr_linenumber" name="322" href="#322">322</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="323" href="#323">323</a> <em class="jxr_javadoccomment"> * Constructs a <code>SamlIdPCookie</code> from the provided string (which is the raw data. </em>
<a class="jxr_linenumber" name="324" href="#324">324</a> <em class="jxr_javadoccomment"> * </em>
<a class="jxr_linenumber" name="325" href="#325">325</a> <em class="jxr_javadoccomment"> * @param codedData</em>
<a class="jxr_linenumber" name="326" href="#326">326</a> <em class="jxr_javadoccomment"> * the information read from the cookie</em>
<a class="jxr_linenumber" name="327" href="#327">327</a> <em class="jxr_javadoccomment"> * @param request Describes the current request. </em>
<a class="jxr_linenumber" name="328" href="#328">328</a> <em class="jxr_javadoccomment"> * @param response Describes the current response.</em>
<a class="jxr_linenumber" name="329" href="#329">329</a> <em class="jxr_javadoccomment"> * @param domainName - if non null the domain for any *created* cookie.</em>
<a class="jxr_linenumber" name="330" href="#330">330</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="331" href="#331">331</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/provider/SamlCookiePlugin.html">SamlIdPCookie</a>(String codedData,
<a class="jxr_linenumber" name="332" href="#332">332</a> HttpServletRequest request,
<a class="jxr_linenumber" name="333" href="#333">333</a> HttpServletResponse response,
<a class="jxr_linenumber" name="334" href="#334">334</a> String domainName) {
<a class="jxr_linenumber" name="335" href="#335">335</a>
<a class="jxr_linenumber" name="336" href="#336">336</a> <strong class="jxr_keyword">this</strong>.req = request;
<a class="jxr_linenumber" name="337" href="#337">337</a> <strong class="jxr_keyword">this</strong>.res = response;
<a class="jxr_linenumber" name="338" href="#338">338</a> <strong class="jxr_keyword">this</strong>.domain = domainName;
<a class="jxr_linenumber" name="339" href="#339">339</a>
<a class="jxr_linenumber" name="340" href="#340">340</a> <strong class="jxr_keyword">int</strong> start;
<a class="jxr_linenumber" name="341" href="#341">341</a> <strong class="jxr_keyword">int</strong> end;
<a class="jxr_linenumber" name="342" href="#342">342</a>
<a class="jxr_linenumber" name="343" href="#343">343</a> <strong class="jxr_keyword">if</strong> (codedData == <strong class="jxr_keyword">null</strong> || codedData.equals(<span class="jxr_string">""</span>)) {
<a class="jxr_linenumber" name="344" href="#344">344</a> log.info(<span class="jxr_string">"Empty cookie"</span>);
<a class="jxr_linenumber" name="345" href="#345">345</a> <strong class="jxr_keyword">return</strong>;
<a class="jxr_linenumber" name="346" href="#346">346</a> }
<a class="jxr_linenumber" name="347" href="#347">347</a> <em class="jxr_comment">//</em>
<a class="jxr_linenumber" name="348" href="#348">348</a> <em class="jxr_comment">// An earlier version saved the cookie without URL encoding it, hence there may be </em>
<a class="jxr_linenumber" name="349" href="#349">349</a> <em class="jxr_comment">// spaces which in turn means we may be quoted. Strip any quotes.</em>
<a class="jxr_linenumber" name="350" href="#350">350</a> <em class="jxr_comment">//</em>
<a class="jxr_linenumber" name="351" href="#351">351</a> <strong class="jxr_keyword">if</strong> (codedData.charAt(0) == '"' && codedData.charAt(codedData.length()-1) == '"') {
<a class="jxr_linenumber" name="352" href="#352">352</a> codedData = codedData.substring(1,codedData.length()-1);
<a class="jxr_linenumber" name="353" href="#353">353</a> }
<a class="jxr_linenumber" name="354" href="#354">354</a>
<a class="jxr_linenumber" name="355" href="#355">355</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="356" href="#356">356</a> codedData = URLDecoder.decode(codedData, <span class="jxr_string">"UTF-8"</span>);
<a class="jxr_linenumber" name="357" href="#357">357</a> } <strong class="jxr_keyword">catch</strong> (UnsupportedEncodingException e) {
<a class="jxr_linenumber" name="358" href="#358">358</a> log.error(<span class="jxr_string">"could not decode cookie"</span>);
<a class="jxr_linenumber" name="359" href="#359">359</a> <strong class="jxr_keyword">return</strong>;
<a class="jxr_linenumber" name="360" href="#360">360</a> }
<a class="jxr_linenumber" name="361" href="#361">361</a>
<a class="jxr_linenumber" name="362" href="#362">362</a> start = 0;
<a class="jxr_linenumber" name="363" href="#363">363</a> end = codedData.indexOf(' ', start);
<a class="jxr_linenumber" name="364" href="#364">364</a> <strong class="jxr_keyword">while</strong> (end > 0) {
<a class="jxr_linenumber" name="365" href="#365">365</a> String value = codedData.substring(start, end);
<a class="jxr_linenumber" name="366" href="#366">366</a> start = end + 1;
<a class="jxr_linenumber" name="367" href="#367">367</a> end = codedData.indexOf(' ', start);
<a class="jxr_linenumber" name="368" href="#368">368</a> <strong class="jxr_keyword">if</strong> (!value.equals(<span class="jxr_string">""</span>)) {
<a class="jxr_linenumber" name="369" href="#369">369</a> idPList.add(<strong class="jxr_keyword">new</strong> String(Base64.decode(value)));
<a class="jxr_linenumber" name="370" href="#370">370</a> }
<a class="jxr_linenumber" name="371" href="#371">371</a> }
<a class="jxr_linenumber" name="372" href="#372">372</a> <strong class="jxr_keyword">if</strong> (start < codedData.length()) {
<a class="jxr_linenumber" name="373" href="#373">373</a> String value = codedData.substring(start);
<a class="jxr_linenumber" name="374" href="#374">374</a> <strong class="jxr_keyword">if</strong> (!value.equals(<span class="jxr_string">""</span>)) {
<a class="jxr_linenumber" name="375" href="#375">375</a> idPList.add(<strong class="jxr_keyword">new</strong> String(Base64.decode(value)));
<a class="jxr_linenumber" name="376" href="#376">376</a> }
<a class="jxr_linenumber" name="377" href="#377">377</a> }
<a class="jxr_linenumber" name="378" href="#378">378</a> }
<a class="jxr_linenumber" name="379" href="#379">379</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="380" href="#380">380</a> <em class="jxr_javadoccomment"> * Create a SamlCookie with no data inside.</em>
<a class="jxr_linenumber" name="381" href="#381">381</a> <em class="jxr_javadoccomment"> * @param domainName - if non null, the domain of the new cookie </em>
<a class="jxr_linenumber" name="382" href="#382">382</a> <em class="jxr_javadoccomment"> * @param request Describes the current request. </em>
<a class="jxr_linenumber" name="383" href="#383">383</a> <em class="jxr_javadoccomment"> * @param response Describes the current response.</em>
<a class="jxr_linenumber" name="384" href="#384">384</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="385" href="#385">385</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="386" href="#386">386</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/provider/SamlCookiePlugin.html">SamlIdPCookie</a>(HttpServletRequest request, HttpServletResponse response, String domainName) {
<a class="jxr_linenumber" name="387" href="#387">387</a> <strong class="jxr_keyword">this</strong>.req = request;
<a class="jxr_linenumber" name="388" href="#388">388</a> <strong class="jxr_keyword">this</strong>.res = response;
<a class="jxr_linenumber" name="389" href="#389">389</a> <strong class="jxr_keyword">this</strong>.domain = domainName;
<a class="jxr_linenumber" name="390" href="#390">390</a> }
<a class="jxr_linenumber" name="391" href="#391">391</a>
<a class="jxr_linenumber" name="392" href="#392">392</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="393" href="#393">393</a> <em class="jxr_javadoccomment"> * Add the specified Shibboleth IdP Name to the cookie list or move to </em>
<a class="jxr_linenumber" name="394" href="#394">394</a> <em class="jxr_javadoccomment"> * the front and then write it back.</em>
<a class="jxr_linenumber" name="395" href="#395">395</a> <em class="jxr_javadoccomment"> * </em>
<a class="jxr_linenumber" name="396" href="#396">396</a> <em class="jxr_javadoccomment"> * We always add to the front (and remove from wherever it was)</em>
<a class="jxr_linenumber" name="397" href="#397">397</a> <em class="jxr_javadoccomment"> * </em>
<a class="jxr_linenumber" name="398" href="#398">398</a> <em class="jxr_javadoccomment"> * @param idPName - The name to be added</em>
<a class="jxr_linenumber" name="399" href="#399">399</a> <em class="jxr_javadoccomment"> * @param expiration - The expiration of the cookie or zero if it is to be unchanged</em>
<a class="jxr_linenumber" name="400" href="#400">400</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="401" href="#401">401</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> addIdPName(String idPName, <strong class="jxr_keyword">int</strong> expiration) {
<a class="jxr_linenumber" name="402" href="#402">402</a>
<a class="jxr_linenumber" name="403" href="#403">403</a> idPList.remove(idPName);
<a class="jxr_linenumber" name="404" href="#404">404</a> idPList.add(0, idPName);
<a class="jxr_linenumber" name="405" href="#405">405</a>
<a class="jxr_linenumber" name="406" href="#406">406</a> writeCookie(expiration);
<a class="jxr_linenumber" name="407" href="#407">407</a> }
<a class="jxr_linenumber" name="408" href="#408">408</a>
<a class="jxr_linenumber" name="409" href="#409">409</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="410" href="#410">410</a> <em class="jxr_javadoccomment"> * Delete the <b>entire<\b> cookie contents</em>
<a class="jxr_linenumber" name="411" href="#411">411</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="412" href="#412">412</a>
<a class="jxr_linenumber" name="413" href="#413">413</a>
<a class="jxr_linenumber" name="414" href="#414">414</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="415" href="#415">415</a> <em class="jxr_javadoccomment"> * Remove origin from the cachedata and write it back.</em>
<a class="jxr_linenumber" name="416" href="#416">416</a> <em class="jxr_javadoccomment"> * </em>
<a class="jxr_linenumber" name="417" href="#417">417</a> <em class="jxr_javadoccomment"> * @param origin what to remove.</em>
<a class="jxr_linenumber" name="418" href="#418">418</a> <em class="jxr_javadoccomment"> * @param expiration How long it will live.</em>
<a class="jxr_linenumber" name="419" href="#419">419</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="420" href="#420">420</a>
<a class="jxr_linenumber" name="421" href="#421">421</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> deleteIdPName(String origin, <strong class="jxr_keyword">int</strong> expiration) {
<a class="jxr_linenumber" name="422" href="#422">422</a> idPList.remove(origin);
<a class="jxr_linenumber" name="423" href="#423">423</a> writeCookie(expiration);
<a class="jxr_linenumber" name="424" href="#424">424</a> }
<a class="jxr_linenumber" name="425" href="#425">425</a>
<a class="jxr_linenumber" name="426" href="#426">426</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="427" href="#427">427</a> <em class="jxr_javadoccomment"> * Write back the cookie.</em>
<a class="jxr_linenumber" name="428" href="#428">428</a> <em class="jxr_javadoccomment"> * </em>
<a class="jxr_linenumber" name="429" href="#429">429</a> <em class="jxr_javadoccomment"> * @param expiration How long it will live</em>
<a class="jxr_linenumber" name="430" href="#430">430</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="431" href="#431">431</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> writeCookie(<strong class="jxr_keyword">int</strong> expiration) {
<a class="jxr_linenumber" name="432" href="#432">432</a> Cookie cookie = getCookie(req);
<a class="jxr_linenumber" name="433" href="#433">433</a>
<a class="jxr_linenumber" name="434" href="#434">434</a> <strong class="jxr_keyword">if</strong> (idPList.size() == 0) {
<a class="jxr_linenumber" name="435" href="#435">435</a> <em class="jxr_comment">//</em>
<a class="jxr_linenumber" name="436" href="#436">436</a> <em class="jxr_comment">// Nothing to write, so delete the cookie</em>
<a class="jxr_linenumber" name="437" href="#437">437</a> <em class="jxr_comment">//</em>
<a class="jxr_linenumber" name="438" href="#438">438</a> cookie.setPath(<span class="jxr_string">"/"</span>);
<a class="jxr_linenumber" name="439" href="#439">439</a> cookie.setMaxAge(0);
<a class="jxr_linenumber" name="440" href="#440">440</a> res.addCookie(cookie);
<a class="jxr_linenumber" name="441" href="#441">441</a> <strong class="jxr_keyword">return</strong>;
<a class="jxr_linenumber" name="442" href="#442">442</a> }
<a class="jxr_linenumber" name="443" href="#443">443</a>
<a class="jxr_linenumber" name="444" href="#444">444</a> <em class="jxr_comment">//</em>
<a class="jxr_linenumber" name="445" href="#445">445</a> <em class="jxr_comment">// Otherwise encode up the cookie</em>
<a class="jxr_linenumber" name="446" href="#446">446</a> <em class="jxr_comment">//</em>
<a class="jxr_linenumber" name="447" href="#447">447</a> StringBuffer buffer = <strong class="jxr_keyword">new</strong> StringBuffer();
<a class="jxr_linenumber" name="448" href="#448">448</a> Iterator <String> it = idPList.iterator();
<a class="jxr_linenumber" name="449" href="#449">449</a>
<a class="jxr_linenumber" name="450" href="#450">450</a> <strong class="jxr_keyword">while</strong> (it.hasNext()) {
<a class="jxr_linenumber" name="451" href="#451">451</a> String next = it.next();
<a class="jxr_linenumber" name="452" href="#452">452</a> String what = <strong class="jxr_keyword">new</strong> String(Base64.encodeBytes(next.getBytes()));
<a class="jxr_linenumber" name="453" href="#453">453</a> buffer.append(what).append(' ');
<a class="jxr_linenumber" name="454" href="#454">454</a> }
<a class="jxr_linenumber" name="455" href="#455">455</a>
<a class="jxr_linenumber" name="456" href="#456">456</a> String value;
<a class="jxr_linenumber" name="457" href="#457">457</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="458" href="#458">458</a> value = URLEncoder.encode(buffer.toString(), <span class="jxr_string">"UTF-8"</span>);
<a class="jxr_linenumber" name="459" href="#459">459</a> } <strong class="jxr_keyword">catch</strong> (UnsupportedEncodingException e) {
<a class="jxr_linenumber" name="460" href="#460">460</a> log.error(<span class="jxr_string">"Could not encode cookie"</span>);
<a class="jxr_linenumber" name="461" href="#461">461</a> <strong class="jxr_keyword">return</strong>;
<a class="jxr_linenumber" name="462" href="#462">462</a> }
<a class="jxr_linenumber" name="463" href="#463">463</a>
<a class="jxr_linenumber" name="464" href="#464">464</a> <strong class="jxr_keyword">if</strong> (cookie == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="465" href="#465">465</a> cookie = <strong class="jxr_keyword">new</strong> Cookie(COOKIE_NAME, value);
<a class="jxr_linenumber" name="466" href="#466">466</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="467" href="#467">467</a> cookie.setValue(value);
<a class="jxr_linenumber" name="468" href="#468">468</a> }
<a class="jxr_linenumber" name="469" href="#469">469</a> cookie.setComment(<span class="jxr_string">"Used to cache selection of a user's Shibboleth IdP"</span>);
<a class="jxr_linenumber" name="470" href="#470">470</a> cookie.setPath(<span class="jxr_string">"/"</span>);
<a class="jxr_linenumber" name="471" href="#471">471</a>
<a class="jxr_linenumber" name="472" href="#472">472</a>
<a class="jxr_linenumber" name="473" href="#473">473</a> cookie.setMaxAge(expiration);
<a class="jxr_linenumber" name="474" href="#474">474</a>
<a class="jxr_linenumber" name="475" href="#475">475</a> <strong class="jxr_keyword">if</strong> (domain != <strong class="jxr_keyword">null</strong> && domain != <span class="jxr_string">""</span>) {
<a class="jxr_linenumber" name="476" href="#476">476</a> cookie.setDomain(domain);
<a class="jxr_linenumber" name="477" href="#477">477</a> }
<a class="jxr_linenumber" name="478" href="#478">478</a> res.addCookie(cookie);
<a class="jxr_linenumber" name="479" href="#479">479</a>
<a class="jxr_linenumber" name="480" href="#480">480</a> }
<a class="jxr_linenumber" name="481" href="#481">481</a>
<a class="jxr_linenumber" name="482" href="#482">482</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="483" href="#483">483</a> <em class="jxr_javadoccomment"> * Return the list of Idps for this cookie.</em>
<a class="jxr_linenumber" name="484" href="#484">484</a> <em class="jxr_javadoccomment"> * @return The list.</em>
<a class="jxr_linenumber" name="485" href="#485">485</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="486" href="#486">486</a> <strong class="jxr_keyword">public</strong> List <String> getIdPList() {
<a class="jxr_linenumber" name="487" href="#487">487</a> <strong class="jxr_keyword">return</strong> idPList;
<a class="jxr_linenumber" name="488" href="#488">488</a> }
<a class="jxr_linenumber" name="489" href="#489">489</a> }
<a class="jxr_linenumber" name="490" href="#490">490</a>
<a class="jxr_linenumber" name="491" href="#491">491</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="492" href="#492">492</a> <em class="jxr_javadoccomment"> * Extract the cookie from a request.</em>
<a class="jxr_linenumber" name="493" href="#493">493</a> <em class="jxr_javadoccomment"> * @param req the request.</em>
<a class="jxr_linenumber" name="494" href="#494">494</a> <em class="jxr_javadoccomment"> * @return the cookie.</em>
<a class="jxr_linenumber" name="495" href="#495">495</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="496" href="#496">496</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> Cookie getCookie(HttpServletRequest req) {
<a class="jxr_linenumber" name="497" href="#497">497</a>
<a class="jxr_linenumber" name="498" href="#498">498</a> Cookie[] cookies = req.getCookies();
<a class="jxr_linenumber" name="499" href="#499">499</a> <strong class="jxr_keyword">if</strong> (cookies != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="500" href="#500">500</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i < cookies.length; i++) {
<a class="jxr_linenumber" name="501" href="#501">501</a> <strong class="jxr_keyword">if</strong> (cookies[i].getName().equals(COOKIE_NAME)) {
<a class="jxr_linenumber" name="502" href="#502">502</a> <strong class="jxr_keyword">return</strong> cookies[i];
<a class="jxr_linenumber" name="503" href="#503">503</a> }
<a class="jxr_linenumber" name="504" href="#504">504</a> }
<a class="jxr_linenumber" name="505" href="#505">505</a> }
<a class="jxr_linenumber" name="506" href="#506">506</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="507" href="#507">507</a> }
<a class="jxr_linenumber" name="508" href="#508">508</a>
<a class="jxr_linenumber" name="509" href="#509">509</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="510" href="#510">510</a> <em class="jxr_javadoccomment"> * Delete the cookie from the response.</em>
<a class="jxr_linenumber" name="511" href="#511">511</a> <em class="jxr_javadoccomment"> * @param req The request.</em>
<a class="jxr_linenumber" name="512" href="#512">512</a> <em class="jxr_javadoccomment"> * @param res The response.</em>
<a class="jxr_linenumber" name="513" href="#513">513</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="514" href="#514">514</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> deleteCookie(HttpServletRequest req, HttpServletResponse res) {
<a class="jxr_linenumber" name="515" href="#515">515</a> Cookie cookie = getCookie(req);
<a class="jxr_linenumber" name="516" href="#516">516</a>
<a class="jxr_linenumber" name="517" href="#517">517</a> <strong class="jxr_keyword">if</strong> (cookie == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="518" href="#518">518</a> <strong class="jxr_keyword">return</strong>;
<a class="jxr_linenumber" name="519" href="#519">519</a> }
<a class="jxr_linenumber" name="520" href="#520">520</a>
<a class="jxr_linenumber" name="521" href="#521">521</a> cookie.setPath(<span class="jxr_string">"/"</span>);
<a class="jxr_linenumber" name="522" href="#522">522</a> cookie.setMaxAge(0);
<a class="jxr_linenumber" name="523" href="#523">523</a> res.addCookie(cookie);
<a class="jxr_linenumber" name="524" href="#524">524</a> }
<a class="jxr_linenumber" name="525" href="#525">525</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="526" href="#526">526</a> <em class="jxr_javadoccomment"> * Load up the cookie and convert it into a SamlIdPCookie. If there is no</em>
<a class="jxr_linenumber" name="527" href="#527">527</a> <em class="jxr_javadoccomment"> * underlying cookie return a null one.</em>
<a class="jxr_linenumber" name="528" href="#528">528</a> <em class="jxr_javadoccomment"> * @param req The request.</em>
<a class="jxr_linenumber" name="529" href="#529">529</a> <em class="jxr_javadoccomment"> * @param res The response.</em>
<a class="jxr_linenumber" name="530" href="#530">530</a> <em class="jxr_javadoccomment"> * @param domain - if this is set then any <b>created</b> cookies are set to this domain</em>
<a class="jxr_linenumber" name="531" href="#531">531</a> <em class="jxr_javadoccomment"> * @return the new object. </em>
<a class="jxr_linenumber" name="532" href="#532">532</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="533" href="#533">533</a>
<a class="jxr_linenumber" name="534" href="#534">534</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/provider/SamlCookiePlugin.html">SamlIdPCookie</a> getIdPCookie(HttpServletRequest req, HttpServletResponse res, String domain) {
<a class="jxr_linenumber" name="535" href="#535">535</a> Cookie cookie = getCookie(req);
<a class="jxr_linenumber" name="536" href="#536">536</a>
<a class="jxr_linenumber" name="537" href="#537">537</a> <strong class="jxr_keyword">if</strong> (cookie == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="538" href="#538">538</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/provider/SamlCookiePlugin.html">SamlIdPCookie</a>(req, res, domain);
<a class="jxr_linenumber" name="539" href="#539">539</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="540" href="#540">540</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/provider/SamlCookiePlugin.html">SamlIdPCookie</a>(cookie.getValue(), req, res, domain);
<a class="jxr_linenumber" name="541" href="#541">541</a> }
<a class="jxr_linenumber" name="542" href="#542">542</a> }
<a class="jxr_linenumber" name="543" href="#543">543</a> }
<a class="jxr_linenumber" name="544" href="#544">544</a>
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>