diff options
Diffstat (limited to 'doc/src-xref/edu/internet2/middleware/shibboleth/wayf/IdPSite.html')
| -rw-r--r-- | doc/src-xref/edu/internet2/middleware/shibboleth/wayf/IdPSite.html | 231 |
1 files changed, 231 insertions, 0 deletions
diff --git a/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/IdPSite.html b/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/IdPSite.html new file mode 100644 index 0000000..a139c6d --- /dev/null +++ b/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/IdPSite.html @@ -0,0 +1,231 @@ +<!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>IdPSite xref</title> +<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> +</head> +<body> +<div id="overview"><a href="../../../../../../apidocs/edu/internet2/middleware/shibboleth/wayf/IdPSite.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.Comparator; +<a name="20" href="#20">20</a> <strong class="jxr_keyword">import</strong> java.util.List; +<a name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> java.util.Locale; +<a name="22" href="#22">22</a> +<a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> javax.servlet.http.HttpServletRequest; +<a name="24" href="#24">24</a> +<a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> org.opensaml.saml2.metadata.EntityDescriptor; +<a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> org.opensaml.saml2.metadata.Organization; +<a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> org.opensaml.saml2.metadata.OrganizationDisplayName; +<a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> org.opensaml.saml2.metadata.SingleSignOnService; +<a name="29" href="#29">29</a> +<a name="30" href="#30">30</a> <em class="jxr_javadoccomment">/**</em> +<a name="31" href="#31">31</a> <em class="jxr_javadoccomment"> * A class which abstracts an IdP for the sake of the WAYF display. Given an {@link EntityDescriptor} as</em> +<a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * input it provides bean style get functions for the name (EntityId), the display name </em> +<a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * (a hybrid of Organization name or EntityId and the IdP's SSO connection point.</em> +<a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * </em> +<a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> */</em> +<a 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/IdPSite.html">IdPSite</a> { +<a name="37" href="#37">37</a> +<a name="38" href="#38">38</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> The OpenSaml element that this stands for. */</em> +<a name="39" href="#39">39</a> <strong class="jxr_keyword">private</strong> EntityDescriptor entity; +<a name="40" href="#40">40</a> +<a name="41" href="#41">41</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> The language we set up */</em> +<a name="42" href="#42">42</a> <strong class="jxr_keyword">private</strong> String displayLanguage; +<a name="43" href="#43">43</a> +<a name="44" href="#44">44</a> <em class="jxr_javadoccomment">/**</em> +<a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * Create a new element from the provided Entity.</em> +<a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * @param entityParam - What to create from</em> +<a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> */</em> +<a name="48" href="#48">48</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/IdPSite.html">IdPSite</a>(EntityDescriptor entityParam) { +<a name="49" href="#49">49</a> entity = entityParam; +<a name="50" href="#50">50</a> } +<a name="51" href="#51">51</a> +<a name="52" href="#52">52</a> <em class="jxr_javadoccomment">/**</em> +<a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> * Get the name for the enclosed entity. </em> +<a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * @return the name for the enclosed entity.</em> +<a name="55" href="#55">55</a> <em class="jxr_javadoccomment"> */</em> +<a name="56" href="#56">56</a> <strong class="jxr_keyword">public</strong> String getName() { +<a name="57" href="#57">57</a> <strong class="jxr_keyword">return</strong> entity.getEntityID(); +<a name="58" href="#58">58</a> } +<a name="59" href="#59">59</a> +<a name="60" href="#60">60</a> <em class="jxr_javadoccomment">/**</em> +<a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * Get the user friendly name for the entity, collecting the locale from the </em> +<a name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * browser if possible</em> +<a name="63" href="#63">63</a> <em class="jxr_javadoccomment"> * @param req the request</em> +<a name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * @return a user friendly name.</em> +<a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> */</em> +<a name="66" href="#66">66</a> <strong class="jxr_keyword">public</strong> String getDisplayName(HttpServletRequest req) { +<a name="67" href="#67">67</a> <em class="jxr_comment">//</em> +<a name="68" href="#68">68</a> <em class="jxr_comment">// Get the browser locale, failing that the server one</em> +<a name="69" href="#69">69</a> <em class="jxr_comment">//</em> +<a name="70" href="#70">70</a> Locale locale = req.getLocale(); +<a name="71" href="#71">71</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">null</strong> == locale) { +<a name="72" href="#72">72</a> Locale.getDefault(); +<a name="73" href="#73">73</a> } +<a name="74" href="#74">74</a> String lang = locale.getLanguage(); +<a name="75" href="#75">75</a> +<a name="76" href="#76">76</a> <strong class="jxr_keyword">return</strong> getDisplayName(lang); +<a name="77" href="#77">77</a> } +<a name="78" href="#78">78</a> <em class="jxr_javadoccomment">/**</em> +<a name="79" href="#79">79</a> <em class="jxr_javadoccomment"> * Get the user friendly name for the entity, using provided language</em> +<a name="80" href="#80">80</a> <em class="jxr_javadoccomment"> * @param lang the language.</em> +<a name="81" href="#81">81</a> <em class="jxr_javadoccomment"> * </em> +<a name="82" href="#82">82</a> <em class="jxr_javadoccomment"> * @return a user friendly name.</em> +<a name="83" href="#83">83</a> <em class="jxr_javadoccomment"> */</em> +<a name="84" href="#84">84</a> <strong class="jxr_keyword">private</strong> String getDisplayName(String lang) { +<a name="85" href="#85">85</a> Organization org = entity.getOrganization(); +<a name="86" href="#86">86</a> +<a name="87" href="#87">87</a> <strong class="jxr_keyword">if</strong> (org == <strong class="jxr_keyword">null</strong>) { +<a name="88" href="#88">88</a> <strong class="jxr_keyword">return</strong> entity.getEntityID(); +<a name="89" href="#89">89</a> } +<a name="90" href="#90">90</a> +<a name="91" href="#91">91</a> List<OrganizationDisplayName> list = org.getDisplayNames(); +<a name="92" href="#92">92</a> +<a name="93" href="#93">93</a> <em class="jxr_comment">//</em> +<a name="94" href="#94">94</a> <em class="jxr_comment">// Lookup first by locale</em> +<a name="95" href="#95">95</a> <em class="jxr_comment">//</em> +<a name="96" href="#96">96</a> +<a name="97" href="#97">97</a> <strong class="jxr_keyword">for</strong> (OrganizationDisplayName name:list) { +<a name="98" href="#98">98</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">null</strong> !=name && lang.equals(name.getName().getLanguage())) { +<a name="99" href="#99">99</a> <strong class="jxr_keyword">return</strong> name.getName().getLocalString(); +<a name="100" href="#100">100</a> } +<a name="101" href="#101">101</a> } +<a name="102" href="#102">102</a> +<a name="103" href="#103">103</a> <em class="jxr_comment">//</em> +<a name="104" href="#104">104</a> <em class="jxr_comment">// If that doesn't work then anything goes</em> +<a name="105" href="#105">105</a> <em class="jxr_comment">//</em> +<a name="106" href="#106">106</a> +<a name="107" href="#107">107</a> <strong class="jxr_keyword">for</strong> (OrganizationDisplayName name:list) { +<a name="108" href="#108">108</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">null</strong> !=name && <strong class="jxr_keyword">null</strong> != name.getName().getLocalString()) { +<a name="109" href="#109">109</a> <strong class="jxr_keyword">return</strong> name.getName().getLocalString(); +<a name="110" href="#110">110</a> } +<a name="111" href="#111">111</a> } +<a name="112" href="#112">112</a> +<a name="113" href="#113">113</a> <em class="jxr_comment">//</em> +<a name="114" href="#114">114</a> <em class="jxr_comment">// If there is still nothing then use the entity Id</em> +<a name="115" href="#115">115</a> <em class="jxr_comment">//</em> +<a name="116" href="#116">116</a> <strong class="jxr_keyword">return</strong> entity.getEntityID(); +<a name="117" href="#117">117</a> } +<a name="118" href="#118">118</a> <em class="jxr_javadoccomment">/**</em> +<a name="119" href="#119">119</a> <em class="jxr_javadoccomment"> * Get the user friendly name for the entity, the language we previouslt set up</em> +<a name="120" href="#120">120</a> <em class="jxr_javadoccomment"> * @param lang the language.</em> +<a name="121" href="#121">121</a> <em class="jxr_javadoccomment"> * </em> +<a name="122" href="#122">122</a> <em class="jxr_javadoccomment"> * @return a user friendly name.</em> +<a name="123" href="#123">123</a> <em class="jxr_javadoccomment"> */</em> +<a name="124" href="#124">124</a> <strong class="jxr_keyword">public</strong> String getDisplayName() { +<a name="125" href="#125">125</a> <strong class="jxr_keyword">return</strong> getDisplayName(displayLanguage); +<a name="126" href="#126">126</a> } +<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"> * Comparison so we can sort the output for jsp.</em> +<a name="130" href="#130">130</a> <em class="jxr_javadoccomment"> * @param o What to compare against</em> +<a name="131" href="#131">131</a> <em class="jxr_javadoccomment"> * @return numeric encoding of comparison </em> +<a name="132" href="#132">132</a> <em class="jxr_javadoccomment"> * @see java.lang.Comparator</em> +<a name="133" href="#133">133</a> <em class="jxr_javadoccomment"> */</em> +<a name="134" href="#134">134</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">int</strong> compareTo(Object o, HttpServletRequest req) { +<a name="135" href="#135">135</a> +<a name="136" href="#136">136</a> +<a name="137" href="#137">137</a> String myDisplayName; +<a name="138" href="#138">138</a> String otherDisplayName; +<a name="139" href="#139">139</a> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/IdPSite.html">IdPSite</a> other; +<a name="140" href="#140">140</a> +<a name="141" href="#141">141</a> <strong class="jxr_keyword">if</strong> (equals(o)) { +<a name="142" href="#142">142</a> <strong class="jxr_keyword">return</strong> 0; +<a name="143" href="#143">143</a> } +<a name="144" href="#144">144</a> +<a name="145" href="#145">145</a> myDisplayName = getDisplayName(req); +<a name="146" href="#146">146</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">null</strong> == myDisplayName) { +<a name="147" href="#147">147</a> myDisplayName = <span class="jxr_string">""</span>; +<a name="148" href="#148">148</a> } +<a name="149" href="#149">149</a> +<a name="150" href="#150">150</a> other = (IdPSite) o; +<a name="151" href="#151">151</a> otherDisplayName = other.getDisplayName(req); +<a name="152" href="#152">152</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">null</strong> == otherDisplayName) { +<a name="153" href="#153">153</a> otherDisplayName = <span class="jxr_string">""</span>; +<a name="154" href="#154">154</a> } +<a name="155" href="#155">155</a> +<a name="156" href="#156">156</a> <strong class="jxr_keyword">int</strong> result = myDisplayName.toLowerCase().compareTo(otherDisplayName.toLowerCase()); +<a name="157" href="#157">157</a> <strong class="jxr_keyword">if</strong> (result == 0) { +<a name="158" href="#158">158</a> result = myDisplayName.compareTo(otherDisplayName); +<a name="159" href="#159">159</a> } +<a name="160" href="#160">160</a> <strong class="jxr_keyword">return</strong> result; +<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"> * When a user has selected an IdP, this provides the address to which we redirect.</em> +<a name="165" href="#165">165</a> <em class="jxr_javadoccomment"> * @return http address for the IdP this represents. </em> +<a name="166" href="#166">166</a> <em class="jxr_javadoccomment"> */</em> +<a name="167" href="#167">167</a> <strong class="jxr_keyword">public</strong> String getAddressForWAYF() { +<a name="168" href="#168">168</a> List<SingleSignOnService> ssoList; +<a name="169" href="#169">169</a> +<a name="170" href="#170">170</a> ssoList = entity.getIDPSSODescriptor(XMLConstants.SHIB_NS).getSingleSignOnServices(); +<a name="171" href="#171">171</a> +<a name="172" href="#172">172</a> <strong class="jxr_keyword">for</strong> (SingleSignOnService signOnService: ssoList) { +<a name="173" href="#173">173</a> <strong class="jxr_keyword">if</strong> (XMLConstants.IDP_SSO_BINDING.equals(signOnService.getBinding())) { +<a name="174" href="#174">174</a> <strong class="jxr_keyword">return</strong> signOnService.getLocation(); +<a name="175" href="#175">175</a> } +<a name="176" href="#176">176</a> } +<a name="177" href="#177">177</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>; +<a name="178" href="#178">178</a> } +<a name="179" href="#179">179</a> +<a name="180" href="#180">180</a> <em class="jxr_javadoccomment">/**</em> +<a name="181" href="#181">181</a> <em class="jxr_javadoccomment"> * Prior to display we set the display language from the</em> +<a name="182" href="#182">182</a> <em class="jxr_javadoccomment"> * browser. There is probably a proper way to do this using</em> +<a name="183" href="#183">183</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="184" href="#184">184</a> <em class="jxr_javadoccomment"> * @param lang the language to set</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> <strong class="jxr_keyword">void</strong> setDisplayLanguage(String lang) { +<a name="187" href="#187">187</a> <strong class="jxr_keyword">this</strong>.displayLanguage = lang; +<a name="188" href="#188">188</a> } +<a name="189" href="#189">189</a> +<a name="190" href="#190">190</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/IdPSite.html">Compare</a> implements Comparator<IdPSite> { +<a name="191" href="#191">191</a> +<a name="192" href="#192">192</a> <em class="jxr_javadoccomment">/**</em> +<a name="193" href="#193">193</a> <em class="jxr_javadoccomment"> * This allows us to set up sorted lists of entities with respect to</em> +<a name="194" href="#194">194</a> <em class="jxr_javadoccomment"> * the browser request.</em> +<a name="195" href="#195">195</a> <em class="jxr_javadoccomment"> * </em> +<a name="196" href="#196">196</a> <em class="jxr_javadoccomment"> * @see java.util.Comparator#compare(java.lang.Object, java.lang.Object)</em> +<a name="197" href="#197">197</a> <em class="jxr_javadoccomment"> */</em> +<a name="198" href="#198">198</a> <strong class="jxr_keyword">private</strong> HttpServletRequest req = <strong class="jxr_keyword">null</strong>; +<a name="199" href="#199">199</a> +<a name="200" href="#200">200</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/IdPSite.html">Compare</a>() { +<a name="201" href="#201">201</a> <em class="jxr_comment">//</em> +<a name="202" href="#202">202</a> <em class="jxr_comment">// No public method</em> +<a name="203" href="#203">203</a> } +<a name="204" href="#204">204</a> +<a name="205" href="#205">205</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/IdPSite.html">Compare</a>(HttpServletRequest req) { +<a name="206" href="#206">206</a> <strong class="jxr_keyword">this</strong>.req = req; +<a name="207" href="#207">207</a> } +<a name="208" href="#208">208</a> +<a name="209" href="#209">209</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> compare(<a href="../../../../../edu/internet2/middleware/shibboleth/wayf/IdPSite.html">IdPSite</a> o1, <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/IdPSite.html">IdPSite</a> o2) { +<a name="210" href="#210">210</a> <em class="jxr_comment">// TODO Auto-generated method stub</em> +<a name="211" href="#211">211</a> <strong class="jxr_keyword">return</strong> o1.compareTo(o2, req); +<a name="212" href="#212">212</a> } +<a name="213" href="#213">213</a> +<a name="214" href="#214">214</a> } +<a name="215" href="#215">215</a> +<a name="216" href="#216">216</a> } +<a name="217" href="#217">217</a> +</pre> +<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> +</html> + |