diff options
Diffstat (limited to 'doc/src-xref/edu/internet2/middleware/shibboleth/wayf/HandlerConfig.html')
| -rw-r--r-- | doc/src-xref/edu/internet2/middleware/shibboleth/wayf/HandlerConfig.html | 236 |
1 files changed, 236 insertions, 0 deletions
diff --git a/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/HandlerConfig.html b/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/HandlerConfig.html new file mode 100644 index 0000000..3e688b3 --- /dev/null +++ b/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/HandlerConfig.html @@ -0,0 +1,236 @@ +<!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>HandlerConfig xref</title> +<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> +</head> +<body> +<div id="overview"><a href="../../../../../../apidocs/edu/internet2/middleware/shibboleth/wayf/HandlerConfig.html">View Javadoc</a></div><pre> + +<a name="1" href="#1">1</a> <em class="jxr_comment">/*</em> +<a name="2" href="#2">2</a> <em class="jxr_comment"> * Copyright [2005] [University Corporation for Advanced Internet Development, Inc.]</em> +<a name="3" href="#3">3</a> <em class="jxr_comment"> *</em> +<a name="4" href="#4">4</a> <em class="jxr_comment"> * Licensed under the Apache License, Version 2.0 (the "License");</em> +<a name="5" href="#5">5</a> <em class="jxr_comment"> * you may not use this file except in compliance with the License.</em> +<a name="6" href="#6">6</a> <em class="jxr_comment"> * You may obtain a copy of the License at</em> +<a name="7" href="#7">7</a> <em class="jxr_comment"> *</em> +<a name="8" href="#8">8</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em> +<a name="9" href="#9">9</a> <em class="jxr_comment"> *</em> +<a name="10" href="#10">10</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, software</em> +<a name="11" href="#11">11</a> <em class="jxr_comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em> +<a name="12" href="#12">12</a> <em class="jxr_comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em> +<a name="13" href="#13">13</a> <em class="jxr_comment"> * See the License for the specific language governing permissions and</em> +<a name="14" href="#14">14</a> <em class="jxr_comment"> * limitations under the License.</em> +<a name="15" href="#15">15</a> <em class="jxr_comment"> */</em> +<a name="16" href="#16">16</a> +<a name="17" href="#17">17</a> <strong class="jxr_keyword">package</strong> edu.internet2.middleware.shibboleth.wayf; +<a name="18" href="#18">18</a> +<a name="19" href="#19">19</a> <strong class="jxr_keyword">import</strong> java.util.HashSet; +<a name="20" href="#20">20</a> +<a name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> org.slf4j.Logger; +<a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory; +<a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> org.w3c.dom.Element; +<a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> org.w3c.dom.NodeList; +<a name="25" href="#25">25</a> +<a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> edu.internet2.middleware.shibboleth.common.ShibbolethConfigurationException; +<a name="27" href="#27">27</a> +<a name="28" href="#28">28</a> <em class="jxr_javadoccomment">/**</em> +<a name="29" href="#29">29</a> <em class="jxr_javadoccomment"> * Class used by the DiscoveryServiceHandler to handle run time behaviour. </em> +<a name="30" href="#30">30</a> <em class="jxr_javadoccomment"> */</em> +<a name="31" href="#31">31</a> +<a name="32" href="#32">32</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/HandlerConfig.html">HandlerConfig</a> { +<a name="33" href="#33">33</a> +<a name="34" href="#34">34</a> <em class="jxr_javadoccomment">/**</em> +<a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * How to get debug output out.</em> +<a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> */</em> +<a name="37" href="#37">37</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Logger LOG = LoggerFactory.getLogger(HandlerConfig.<strong class="jxr_keyword">class</strong>.getName()); +<a name="38" href="#38">38</a> +<a name="39" href="#39">39</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> A set of names which are ignored when doing a search. */</em> +<a name="40" href="#40">40</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> HashSet <String> ignoredForMatch; +<a name="41" href="#41">41</a> +<a name="42" href="#42">42</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Where to find the GUI description jsp file. */</em> +<a name="43" href="#43">43</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> String jspFile; +<a name="44" href="#44">44</a> +<a name="45" href="#45">45</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Where to find the error jsp file. */</em> +<a name="46" href="#46">46</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> String errorJspFile; +<a name="47" href="#47">47</a> +<a name="48" href="#48">48</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Do we give the jsp file an array of arrays of IdPs? */</em> +<a name="49" href="#49">49</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> provideListOfLists; +<a name="50" href="#50">50</a> +<a name="51" href="#51">51</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Do we give the jsp file a flat list of IdPs? */</em> +<a name="52" href="#52">52</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> provideList; +<a name="53" href="#53">53</a> +<a name="54" href="#54">54</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Do we do a pre-filter by SP name in for each metadata provider. */</em> +<a name="55" href="#55">55</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> lookupSp; +<a name="56" href="#56">56</a> +<a name="57" href="#57">57</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Do we warn on the bad binding. */</em> +<a name="58" href="#58">58</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> warnOnBadBinding; +<a name="59" href="#59">59</a> +<a name="60" href="#60">60</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Build the 'default default' configuation. */</em> +<a name="61" href="#61">61</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/HandlerConfig.html">HandlerConfig</a>() { +<a name="62" href="#62">62</a> <em class="jxr_comment">//</em> +<a name="63" href="#63">63</a> <em class="jxr_comment">// 'Sensible' default values</em> +<a name="64" href="#64">64</a> <em class="jxr_comment">//</em> +<a name="65" href="#65">65</a> jspFile = <span class="jxr_string">"/wayf.jsp"</span>; +<a name="66" href="#66">66</a> errorJspFile = <span class="jxr_string">"/wayfError.jsp"</span>; +<a name="67" href="#67">67</a> provideList = <strong class="jxr_keyword">true</strong>; +<a name="68" href="#68">68</a> provideListOfLists = false; +<a name="69" href="#69">69</a> lookupSp = <strong class="jxr_keyword">true</strong>; +<a name="70" href="#70">70</a> ignoredForMatch = <strong class="jxr_keyword">new</strong> HashSet <String>(); +<a name="71" href="#71">71</a> warnOnBadBinding = false; +<a name="72" href="#72">72</a> } +<a name="73" href="#73">73</a> +<a name="74" href="#74">74</a> +<a name="75" href="#75">75</a> <em class="jxr_javadoccomment">/**</em> +<a name="76" href="#76">76</a> <em class="jxr_javadoccomment"> * </em> +<a name="77" href="#77">77</a> <em class="jxr_javadoccomment"> * Parse the Supplied XML element into a new WayfConfig Object.</em> +<a name="78" href="#78">78</a> <em class="jxr_javadoccomment"> * @param config - The XML with the configuration info.</em> +<a name="79" href="#79">79</a> <em class="jxr_javadoccomment"> * @param defaultValue - The default if nothing is specified.</em> +<a name="80" href="#80">80</a> <em class="jxr_javadoccomment"> * @throws ShibbolethConfigurationException - if we see somethin wrong.</em> +<a name="81" href="#81">81</a> <em class="jxr_javadoccomment"> */</em> +<a name="82" href="#82">82</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/HandlerConfig.html">HandlerConfig</a>(Element config, <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/HandlerConfig.html">HandlerConfig</a> defaultValue) <strong class="jxr_keyword">throws</strong> ShibbolethConfigurationException { +<a name="83" href="#83">83</a> +<a name="84" href="#84">84</a> String attribute; +<a name="85" href="#85">85</a> LOG.debug(<span class="jxr_string">"Loading global configuration properties."</span>); +<a name="86" href="#86">86</a> +<a name="87" href="#87">87</a> NodeList list = config.getElementsByTagName(<span class="jxr_string">"SearchIgnore"</span>); +<a name="88" href="#88">88</a> +<a name="89" href="#89">89</a> <strong class="jxr_keyword">if</strong> (list.getLength() == 0) { +<a name="90" href="#90">90</a> +<a name="91" href="#91">91</a> ignoredForMatch = defaultValue.ignoredForMatch; +<a name="92" href="#92">92</a> +<a name="93" href="#93">93</a> } <strong class="jxr_keyword">else</strong> { +<a name="94" href="#94">94</a> +<a name="95" href="#95">95</a> ignoredForMatch = <strong class="jxr_keyword">new</strong> HashSet<String>(); +<a name="96" href="#96">96</a> +<a name="97" href="#97">97</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i < list.getLength(); i++ ) { +<a name="98" href="#98">98</a> +<a name="99" href="#99">99</a> NodeList <strong class="jxr_keyword">inner</strong> = ((Element) list.item(i)).getElementsByTagName(<span class="jxr_string">"IgnoreText"</span>); +<a name="100" href="#100">100</a> +<a name="101" href="#101">101</a> <strong class="jxr_keyword">for</strong>(<strong class="jxr_keyword">int</strong> j = 0; j < <strong class="jxr_keyword">inner</strong>.getLength(); j++) { +<a name="102" href="#102">102</a> +<a name="103" href="#103">103</a> addIgnoredForMatch(<strong class="jxr_keyword">inner</strong>.item(j).getTextContent()); +<a name="104" href="#104">104</a> } +<a name="105" href="#105">105</a> } +<a name="106" href="#106">106</a> } +<a name="107" href="#107">107</a> +<a name="108" href="#108">108</a> attribute = config.getAttribute(<span class="jxr_string">"jspFile"</span>); +<a name="109" href="#109">109</a> <strong class="jxr_keyword">if</strong> (attribute != <strong class="jxr_keyword">null</strong> && !attribute.equals(<span class="jxr_string">""</span>)) { +<a name="110" href="#110">110</a> jspFile = attribute; +<a name="111" href="#111">111</a> } <strong class="jxr_keyword">else</strong> { +<a name="112" href="#112">112</a> jspFile = defaultValue.jspFile; +<a name="113" href="#113">113</a> } +<a name="114" href="#114">114</a> +<a name="115" href="#115">115</a> attribute = config.getAttribute(<span class="jxr_string">"errorJspFile"</span>); +<a name="116" href="#116">116</a> <strong class="jxr_keyword">if</strong> (attribute != <strong class="jxr_keyword">null</strong> && !attribute.equals(<span class="jxr_string">""</span>)) { +<a name="117" href="#117">117</a> errorJspFile = attribute; +<a name="118" href="#118">118</a> } <strong class="jxr_keyword">else</strong> { +<a name="119" href="#119">119</a> errorJspFile = defaultValue.errorJspFile; +<a name="120" href="#120">120</a> } +<a name="121" href="#121">121</a> +<a name="122" href="#122">122</a> attribute = config.getAttribute(<span class="jxr_string">"provideList"</span>); +<a name="123" href="#123">123</a> <strong class="jxr_keyword">if</strong> (attribute != <strong class="jxr_keyword">null</strong> && !attribute.equals(<span class="jxr_string">""</span>)) { +<a name="124" href="#124">124</a> provideList = Boolean.valueOf(attribute).booleanValue(); +<a name="125" href="#125">125</a> } <strong class="jxr_keyword">else</strong> { +<a name="126" href="#126">126</a> provideList = defaultValue.provideList; +<a name="127" href="#127">127</a> } +<a name="128" href="#128">128</a> +<a name="129" href="#129">129</a> attribute = config.getAttribute(<span class="jxr_string">"provideListOfList"</span>); +<a name="130" href="#130">130</a> <strong class="jxr_keyword">if</strong> (attribute != <strong class="jxr_keyword">null</strong> && !attribute.equals(<span class="jxr_string">""</span>)) { +<a name="131" href="#131">131</a> provideListOfLists = Boolean.valueOf(attribute).booleanValue(); +<a name="132" href="#132">132</a> } <strong class="jxr_keyword">else</strong> { +<a name="133" href="#133">133</a> provideListOfLists = defaultValue.provideListOfLists; +<a name="134" href="#134">134</a> } +<a name="135" href="#135">135</a> +<a name="136" href="#136">136</a> attribute = config.getAttribute(<span class="jxr_string">"showUnusableIdPs"</span>); +<a name="137" href="#137">137</a> <strong class="jxr_keyword">if</strong> (attribute != <strong class="jxr_keyword">null</strong> && !attribute.equals(<span class="jxr_string">""</span>)) { +<a name="138" href="#138">138</a> lookupSp = !Boolean.valueOf(attribute).booleanValue(); +<a name="139" href="#139">139</a> } <strong class="jxr_keyword">else</strong> { +<a name="140" href="#140">140</a> lookupSp = defaultValue.lookupSp; +<a name="141" href="#141">141</a> } +<a name="142" href="#142">142</a> +<a name="143" href="#143">143</a> attribute = config.getAttribute(<span class="jxr_string">"warnOnBadBinding"</span>); +<a name="144" href="#144">144</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">null</strong> != attribute && !attribute.equals(<span class="jxr_string">""</span>)) { +<a name="145" href="#145">145</a> warnOnBadBinding = Boolean.valueOf(attribute).booleanValue(); +<a name="146" href="#146">146</a> } <strong class="jxr_keyword">else</strong> { +<a name="147" href="#147">147</a> warnOnBadBinding = false; +<a name="148" href="#148">148</a> } +<a name="149" href="#149">149</a> } +<a name="150" href="#150">150</a> +<a name="151" href="#151">151</a> +<a name="152" href="#152">152</a> <em class="jxr_javadoccomment">/**</em> +<a name="153" href="#153">153</a> <em class="jxr_javadoccomment"> * Determines if a particular string token should be used for matching when a user searches for origins.</em> +<a name="154" href="#154">154</a> <em class="jxr_javadoccomment"> * </em> +<a name="155" href="#155">155</a> <em class="jxr_javadoccomment"> * @param str - The string to lookup.</em> +<a name="156" href="#156">156</a> <em class="jxr_javadoccomment"> * @return whether it is or not.</em> +<a name="157" href="#157">157</a> <em class="jxr_javadoccomment"> */</em> +<a name="158" href="#158">158</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isIgnoredForMatch(String str) { +<a name="159" href="#159">159</a> +<a name="160" href="#160">160</a> <strong class="jxr_keyword">return</strong> ignoredForMatch.contains(str.toLowerCase()); +<a name="161" href="#161">161</a> } +<a name="162" href="#162">162</a> +<a name="163" href="#163">163</a> <em class="jxr_javadoccomment">/**</em> +<a name="164" href="#164">164</a> <em class="jxr_javadoccomment"> * Sets the tokens that should be ignored when a user searches for an origin site.</em> +<a name="165" href="#165">165</a> <em class="jxr_javadoccomment"> * </em> +<a name="166" href="#166">166</a> <em class="jxr_javadoccomment"> * @param s</em> +<a name="167" href="#167">167</a> <em class="jxr_javadoccomment"> * The ignored tokens are passed as a single string, each separated by whitespace</em> +<a name="168" href="#168">168</a> <em class="jxr_javadoccomment"> */</em> +<a name="169" href="#169">169</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> addIgnoredForMatch(String s) { +<a name="170" href="#170">170</a> +<a name="171" href="#171">171</a> ignoredForMatch.add(s.toLowerCase()); +<a name="172" href="#172">172</a> } +<a name="173" href="#173">173</a> +<a name="174" href="#174">174</a> <em class="jxr_javadoccomment">/**</em> +<a name="175" href="#175">175</a> <em class="jxr_javadoccomment"> * Get the name of the jsp File this instance uses.</em> +<a name="176" href="#176">176</a> <em class="jxr_javadoccomment"> * @return the name.</em> +<a name="177" href="#177">177</a> <em class="jxr_javadoccomment"> */</em> +<a name="178" href="#178">178</a> <strong class="jxr_keyword">public</strong> String getJspFile() { +<a name="179" href="#179">179</a> <strong class="jxr_keyword">return</strong> jspFile; +<a name="180" href="#180">180</a> } +<a name="181" href="#181">181</a> +<a name="182" href="#182">182</a> <em class="jxr_javadoccomment">/**</em> +<a name="183" href="#183">183</a> <em class="jxr_javadoccomment"> * Get the name of the error jsp File this instance uses.</em> +<a name="184" href="#184">184</a> <em class="jxr_javadoccomment"> * @return the name.</em> +<a name="185" href="#185">185</a> <em class="jxr_javadoccomment"> */</em> +<a name="186" href="#186">186</a> <strong class="jxr_keyword">public</strong> String getErrorJspFile() { +<a name="187" href="#187">187</a> <strong class="jxr_keyword">return</strong> errorJspFile; +<a name="188" href="#188">188</a> } +<a name="189" href="#189">189</a> +<a name="190" href="#190">190</a> <em class="jxr_javadoccomment">/**</em> +<a name="191" href="#191">191</a> <em class="jxr_javadoccomment"> * Do we provide a list of lists of IdPs?.</em> +<a name="192" href="#192">192</a> <em class="jxr_javadoccomment"> * @return whether we do or not.</em> +<a name="193" href="#193">193</a> <em class="jxr_javadoccomment"> */</em> +<a name="194" href="#194">194</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> getProvideListOfLists() { +<a name="195" href="#195">195</a> <strong class="jxr_keyword">return</strong> provideListOfLists; +<a name="196" href="#196">196</a> } +<a name="197" href="#197">197</a> +<a name="198" href="#198">198</a> <em class="jxr_javadoccomment">/**</em> +<a name="199" href="#199">199</a> <em class="jxr_javadoccomment"> * Do we provide a list of IdPs?.</em> +<a name="200" href="#200">200</a> <em class="jxr_javadoccomment"> * @return whether we provide a list of IdPs?.</em> +<a name="201" href="#201">201</a> <em class="jxr_javadoccomment"> */</em> +<a name="202" href="#202">202</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> getProvideList() { +<a name="203" href="#203">203</a> <strong class="jxr_keyword">return</strong> provideList; +<a name="204" href="#204">204</a> } +<a name="205" href="#205">205</a> +<a name="206" href="#206">206</a> <em class="jxr_javadoccomment">/**</em> +<a name="207" href="#207">207</a> <em class="jxr_javadoccomment"> * Do we lookup the SP or just return all the IdPs?.</em> +<a name="208" href="#208">208</a> <em class="jxr_javadoccomment"> * @return whether or not we lookup the SP</em> +<a name="209" href="#209">209</a> <em class="jxr_javadoccomment"> */</em> +<a name="210" href="#210">210</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> getLookupSp() { +<a name="211" href="#211">211</a> <strong class="jxr_keyword">return</strong> lookupSp; +<a name="212" href="#212">212</a> } +<a name="213" href="#213">213</a> +<a name="214" href="#214">214</a> <em class="jxr_javadoccomment">/**</em> +<a name="215" href="#215">215</a> <em class="jxr_javadoccomment"> * Do ignore badly formed bindings or just warn</em> +<a name="216" href="#216">216</a> <em class="jxr_javadoccomment"> * @return whether we warn.</em> +<a name="217" href="#217">217</a> <em class="jxr_javadoccomment"> */</em> +<a name="218" href="#218">218</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> getWarnOnBadBinding() { +<a name="219" href="#219">219</a> <strong class="jxr_keyword">return</strong> warnOnBadBinding; +<a name="220" href="#220">220</a> } +<a name="221" href="#221">221</a> +<a name="222" href="#222">222</a> } +</pre> +<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> +</html> + |