diff options
Diffstat (limited to 'doc/src-xref/edu/internet2/middleware/shibboleth/wayf')
27 files changed, 4635 insertions, 0 deletions
diff --git a/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/DiscoveryResponseBuilder.html b/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/DiscoveryResponseBuilder.html new file mode 100644 index 0000000..07ceb25 --- /dev/null +++ b/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/DiscoveryResponseBuilder.html @@ -0,0 +1,61 @@ +<!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>DiscoveryResponseBuilder xref</title> +<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> +</head> +<body> +<div id="overview"><a href="../../../../../../apidocs/edu/internet2/middleware/shibboleth/wayf/DiscoveryResponseBuilder.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 [2006] [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> <em class="jxr_javadoccomment">/**</em> +<a name="18" href="#18">18</a> <em class="jxr_javadoccomment"> * </em> +<a name="19" href="#19">19</a> <em class="jxr_javadoccomment"> */</em> +<a name="20" href="#20">20</a> +<a name="21" href="#21">21</a> <strong class="jxr_keyword">package</strong> edu.internet2.middleware.shibboleth.wayf; +<a name="22" href="#22">22</a> +<a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> org.opensaml.common.impl.AbstractSAMLObjectBuilder; +<a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> org.opensaml.common.xml.SAMLConstants; +<a name="25" href="#25">25</a> +<a name="26" href="#26">26</a> <em class="jxr_javadoccomment">/**</em> +<a name="27" href="#27">27</a> <em class="jxr_javadoccomment"> * Builder of {@link org.opensaml.saml2.metadata.impl.SingleLogoutServiceImpl}.</em> +<a name="28" href="#28">28</a> <em class="jxr_javadoccomment"> */</em> +<a name="29" href="#29">29</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/DiscoveryResponseBuilder.html">DiscoveryResponseBuilder</a> <strong class="jxr_keyword">extends</strong> AbstractSAMLObjectBuilder<DiscoveryResponseImpl> { +<a name="30" href="#30">30</a> +<a name="31" href="#31">31</a> <em class="jxr_javadoccomment">/**</em> +<a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * Constructor</em> +<a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> */</em> +<a name="34" href="#34">34</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/DiscoveryResponseBuilder.html">DiscoveryResponseBuilder</a>() { +<a name="35" href="#35">35</a> +<a name="36" href="#36">36</a> } +<a name="37" href="#37">37</a> +<a name="38" href="#38">38</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> {@inheritDoc} */</em> +<a name="39" href="#39">39</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/DiscoveryResponseImpl.html">DiscoveryResponseImpl</a> buildObject() { +<a name="40" href="#40">40</a> <strong class="jxr_keyword">return</strong> buildObject(SAMLConstants.SAML20MD_NS, DiscoveryResponseImpl.DEFAULT_ELEMENT_LOCAL_NAME, SAMLConstants.SAML20MD_PREFIX); +<a name="41" href="#41">41</a> } +<a name="42" href="#42">42</a> +<a name="43" href="#43">43</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> {@inheritDoc} */</em> +<a name="44" href="#44">44</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/DiscoveryResponseImpl.html">DiscoveryResponseImpl</a> buildObject(String namespaceURI, String localName, String namespacePrefix) { +<a name="45" href="#45">45</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/DiscoveryResponseImpl.html">DiscoveryResponseImpl</a>(namespaceURI, localName, namespacePrefix); +<a name="46" href="#46">46</a> } +<a name="47" href="#47">47</a> } +</pre> +<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> +</html> + diff --git a/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/DiscoveryResponseImpl.html b/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/DiscoveryResponseImpl.html new file mode 100644 index 0000000..92c9612 --- /dev/null +++ b/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/DiscoveryResponseImpl.html @@ -0,0 +1,63 @@ +<!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>DiscoveryResponseImpl xref</title> +<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> +</head> +<body> +<div id="overview"><a href="../../../../../../apidocs/edu/internet2/middleware/shibboleth/wayf/DiscoveryResponseImpl.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 [2006] [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> <em class="jxr_javadoccomment">/**</em> +<a name="18" href="#18">18</a> <em class="jxr_javadoccomment"> * </em> +<a name="19" href="#19">19</a> <em class="jxr_javadoccomment"> */</em> +<a name="20" href="#20">20</a> +<a name="21" href="#21">21</a> <strong class="jxr_keyword">package</strong> edu.internet2.middleware.shibboleth.wayf; +<a name="22" href="#22">22</a> +<a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> org.opensaml.saml2.metadata.IndexedEndpoint; +<a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> org.opensaml.saml2.metadata.impl.IndexedEndpointImpl; +<a name="25" href="#25">25</a> +<a name="26" href="#26">26</a> <em class="jxr_javadoccomment">/**</em> +<a name="27" href="#27">27</a> <em class="jxr_javadoccomment"> * This plugs into the standard opensaml2 parser framework to allow us to get use <code> DiscoverResponse </code></em> +<a name="28" href="#28">28</a> <em class="jxr_javadoccomment"> * elements in our extensions.</em> +<a name="29" href="#29">29</a> <em class="jxr_javadoccomment"> */</em> +<a name="30" href="#30">30</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/DiscoveryResponseImpl.html">DiscoveryResponseImpl</a> <strong class="jxr_keyword">extends</strong> IndexedEndpointImpl implements IndexedEndpoint { +<a name="31" href="#31">31</a> +<a name="32" href="#32">32</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Namespace for Discovery Service metadata extensions. */</em> +<a name="33" href="#33">33</a> +<a name="34" href="#34">34</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String METADATA_NS = <span class="jxr_string">"urn:oasis:names:tc:SAML:profiles:SSO:idp-discovery-protocol"</span>; +<a name="35" href="#35">35</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Name of the element inside the Extensions. */</em> +<a name="36" href="#36">36</a> +<a name="37" href="#37">37</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String DEFAULT_ELEMENT_LOCAL_NAME = <span class="jxr_string">"DiscoveryResponse"</span>; +<a name="38" href="#38">38</a> +<a name="39" href="#39">39</a> <em class="jxr_javadoccomment">/**</em> +<a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * Constructor.</em> +<a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * </em> +<a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * @param namespaceURI the Uri</em> +<a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * @param elementLocalName the local name</em> +<a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * @param namespacePrefix the prefix</em> +<a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> */</em> +<a name="46" href="#46">46</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/DiscoveryResponseImpl.html">DiscoveryResponseImpl</a>(String namespaceURI, String elementLocalName, String namespacePrefix) { +<a name="47" href="#47">47</a> <strong class="jxr_keyword">super</strong>(namespaceURI, elementLocalName, namespacePrefix); +<a name="48" href="#48">48</a> } +<a name="49" href="#49">49</a> } +</pre> +<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> +</html> + diff --git a/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/DiscoveryResponseUnmarshaller.html b/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/DiscoveryResponseUnmarshaller.html new file mode 100644 index 0000000..45cb6f2 --- /dev/null +++ b/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/DiscoveryResponseUnmarshaller.html @@ -0,0 +1,51 @@ +<!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>DiscoveryResponseUnmarshaller xref</title> +<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> +</head> +<body> +<div id="overview"><a href="../../../../../../apidocs/edu/internet2/middleware/shibboleth/wayf/DiscoveryResponseUnmarshaller.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 [2006] [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> <em class="jxr_javadoccomment">/**</em> +<a name="18" href="#18">18</a> <em class="jxr_javadoccomment"> * </em> +<a name="19" href="#19">19</a> <em class="jxr_javadoccomment"> */</em> +<a name="20" href="#20">20</a> +<a name="21" href="#21">21</a> <strong class="jxr_keyword">package</strong> edu.internet2.middleware.shibboleth.wayf; +<a name="22" href="#22">22</a> +<a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> org.opensaml.saml2.metadata.impl.IndexedEndpointUnmarshaller; +<a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> org.opensaml.xml.XMLObject; +<a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> org.opensaml.xml.io.UnmarshallingException; +<a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> org.w3c.dom.Attr; +<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"> * A thread safe Unmarshaller for {@link org.opensaml.saml2.metadata.SingleLogoutService} objects.</em> +<a name="30" href="#30">30</a> <em class="jxr_javadoccomment"> */</em> +<a name="31" href="#31">31</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/DiscoveryResponseUnmarshaller.html">DiscoveryResponseUnmarshaller</a> <strong class="jxr_keyword">extends</strong> IndexedEndpointUnmarshaller { +<a name="32" href="#32">32</a> +<a name="33" href="#33">33</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> {@inheritDoc} */</em> +<a name="34" href="#34">34</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> processAttribute(XMLObject samlObject, Attr attribute) <strong class="jxr_keyword">throws</strong> UnmarshallingException { +<a name="35" href="#35">35</a> <strong class="jxr_keyword">super</strong>.processAttribute(samlObject, attribute); +<a name="36" href="#36">36</a> } +<a name="37" href="#37">37</a> } +</pre> +<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> +</html> + diff --git a/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/DiscoveryServiceHandler.html b/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/DiscoveryServiceHandler.html new file mode 100644 index 0000000..9f4e4ed --- /dev/null +++ b/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/DiscoveryServiceHandler.html @@ -0,0 +1,1016 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US"> +<head> +<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /> +<title>DiscoveryServiceHandler xref</title> +<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> +</head> +<body> +<div id="overview"><a href="../../../../../../apidocs/edu/internet2/middleware/shibboleth/wayf/DiscoveryServiceHandler.html">View Javadoc</a></div><pre> + +<a name="1" href="#1">1</a> <em class="jxr_javadoccomment">/**</em> +<a name="2" href="#2">2</a> <em class="jxr_javadoccomment"> * Copyright [2006] [University Corporation for Advanced Internet Development, Inc.]</em> +<a name="3" href="#3">3</a> <em class="jxr_javadoccomment"> *</em> +<a name="4" href="#4">4</a> <em class="jxr_javadoccomment"> * Licensed under the Apache License, Version 2.0 (the "License");</em> +<a name="5" href="#5">5</a> <em class="jxr_javadoccomment"> * you may not use this file except in compliance with the License.</em> +<a name="6" href="#6">6</a> <em class="jxr_javadoccomment"> * You may obtain a copy of the License at</em> +<a name="7" href="#7">7</a> <em class="jxr_javadoccomment"> *</em> +<a name="8" href="#8">8</a> <em class="jxr_javadoccomment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em> +<a name="9" href="#9">9</a> <em class="jxr_javadoccomment"> *</em> +<a name="10" href="#10">10</a> <em class="jxr_javadoccomment"> * Unless required by applicable law or agreed to in writing, software</em> +<a name="11" href="#11">11</a> <em class="jxr_javadoccomment"> * distributed under the License is distributed on an "AS IS" BASIS,</em> +<a name="12" href="#12">12</a> <em class="jxr_javadoccomment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em> +<a name="13" href="#13">13</a> <em class="jxr_javadoccomment"> * See the License for the specific language governing permissions and</em> +<a name="14" href="#14">14</a> <em class="jxr_javadoccomment"> * limitations under the License.</em> +<a name="15" href="#15">15</a> <em class="jxr_javadoccomment"> */</em> +<a name="16" href="#16">16</a> <strong class="jxr_keyword">package</strong> edu.internet2.middleware.shibboleth.wayf; +<a name="17" href="#17">17</a> +<a name="18" href="#18">18</a> <strong class="jxr_keyword">import</strong> java.io.IOException; +<a name="19" href="#19">19</a> <strong class="jxr_keyword">import</strong> java.io.UnsupportedEncodingException; +<a name="20" href="#20">20</a> <strong class="jxr_keyword">import</strong> java.net.MalformedURLException; +<a name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> java.net.URL; +<a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> java.net.URLDecoder; +<a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> java.net.URLEncoder; +<a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> java.util.ArrayList; +<a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> java.util.Collection; +<a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> java.util.Comparator; +<a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> java.util.Date; +<a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> java.util.HashSet; +<a name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> java.util.Hashtable; +<a name="30" href="#30">30</a> <strong class="jxr_keyword">import</strong> java.util.List; +<a name="31" href="#31">31</a> <strong class="jxr_keyword">import</strong> java.util.Locale; +<a name="32" href="#32">32</a> <strong class="jxr_keyword">import</strong> java.util.Map; +<a name="33" href="#33">33</a> <strong class="jxr_keyword">import</strong> java.util.Set; +<a name="34" href="#34">34</a> <strong class="jxr_keyword">import</strong> java.util.TreeSet; +<a name="35" href="#35">35</a> +<a name="36" href="#36">36</a> <strong class="jxr_keyword">import</strong> javax.servlet.RequestDispatcher; +<a name="37" href="#37">37</a> <strong class="jxr_keyword">import</strong> javax.servlet.ServletException; +<a name="38" href="#38">38</a> <strong class="jxr_keyword">import</strong> javax.servlet.http.HttpServletRequest; +<a name="39" href="#39">39</a> <strong class="jxr_keyword">import</strong> javax.servlet.http.HttpServletResponse; +<a name="40" href="#40">40</a> +<a name="41" href="#41">41</a> <strong class="jxr_keyword">import</strong> org.opensaml.saml2.common.Extensions; +<a name="42" href="#42">42</a> <strong class="jxr_keyword">import</strong> org.opensaml.saml2.metadata.EntityDescriptor; +<a name="43" href="#43">43</a> <strong class="jxr_keyword">import</strong> org.opensaml.saml2.metadata.RoleDescriptor; +<a name="44" href="#44">44</a> <strong class="jxr_keyword">import</strong> org.opensaml.saml2.metadata.SPSSODescriptor; +<a name="45" href="#45">45</a> <strong class="jxr_keyword">import</strong> org.opensaml.xml.XMLObject; +<a name="46" href="#46">46</a> <strong class="jxr_keyword">import</strong> org.slf4j.Logger; +<a name="47" href="#47">47</a> <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory; +<a name="48" href="#48">48</a> <strong class="jxr_keyword">import</strong> org.w3c.dom.Element; +<a name="49" href="#49">49</a> <strong class="jxr_keyword">import</strong> org.w3c.dom.NodeList; +<a name="50" href="#50">50</a> +<a name="51" href="#51">51</a> <strong class="jxr_keyword">import</strong> edu.internet2.middleware.shibboleth.common.ShibbolethConfigurationException; +<a name="52" href="#52">52</a> <strong class="jxr_keyword">import</strong> edu.internet2.middleware.shibboleth.wayf.plugins.Plugin; +<a name="53" href="#53">53</a> <strong class="jxr_keyword">import</strong> edu.internet2.middleware.shibboleth.wayf.plugins.PluginContext; +<a name="54" href="#54">54</a> <strong class="jxr_keyword">import</strong> edu.internet2.middleware.shibboleth.wayf.plugins.PluginMetadataParameter; +<a name="55" href="#55">55</a> <strong class="jxr_keyword">import</strong> edu.internet2.middleware.shibboleth.wayf.plugins.WayfRequestHandled; +<a name="56" href="#56">56</a> +<a name="57" href="#57">57</a> <em class="jxr_javadoccomment">/**</em> +<a name="58" href="#58">58</a> <em class="jxr_javadoccomment"> * Specific handler for each version of the Discovery Service. </em> +<a name="59" href="#59">59</a> <em class="jxr_javadoccomment"> */</em> +<a name="60" href="#60">60</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/DiscoveryServiceHandler.html">DiscoveryServiceHandler</a> { +<a name="61" href="#61">61</a> +<a name="62" href="#62">62</a> <em class="jxr_comment">/*</em> +<a name="63" href="#63">63</a> <em class="jxr_comment"> * Protcol parameters - Old.</em> +<a name="64" href="#64">64</a> <em class="jxr_comment"> */</em> +<a name="65" href="#65">65</a> <em class="jxr_javadoccomment">/**</em> +<a name="66" href="#66">66</a> <em class="jxr_javadoccomment"> * Shire is the SP Assertion Consumer endpoint.</em> +<a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> */</em> +<a name="68" href="#68">68</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String SHIRE_PARAM_NAME = <span class="jxr_string">"shire"</span>; +<a name="69" href="#69">69</a> <em class="jxr_javadoccomment">/**</em> +<a name="70" href="#70">70</a> <em class="jxr_javadoccomment"> * TargetName is where we are trying to get to.</em> +<a name="71" href="#71">71</a> <em class="jxr_javadoccomment"> */</em> +<a name="72" href="#72">72</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String TARGET_PARAM_NAME = <span class="jxr_string">"target"</span>; +<a name="73" href="#73">73</a> <em class="jxr_javadoccomment">/**</em> +<a name="74" href="#74">74</a> <em class="jxr_javadoccomment"> * time is to do with replay attack.</em> +<a name="75" href="#75">75</a> <em class="jxr_javadoccomment"> */</em> +<a name="76" href="#76">76</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String TIME_PARAM_NAME = <span class="jxr_string">"time"</span>; +<a name="77" href="#77">77</a> <em class="jxr_javadoccomment">/**</em> +<a name="78" href="#78">78</a> <em class="jxr_javadoccomment"> * This is the ID (in the metadata) of the SP.</em> +<a name="79" href="#79">79</a> <em class="jxr_javadoccomment"> */</em> +<a name="80" href="#80">80</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String PROVIDERID_PARAM_NAME = <span class="jxr_string">"providerId"</span>; +<a name="81" href="#81">81</a> +<a name="82" href="#82">82</a> <em class="jxr_comment">/*</em> +<a name="83" href="#83">83</a> <em class="jxr_comment"> * Protocol parameters - New</em> +<a name="84" href="#84">84</a> <em class="jxr_comment"> */</em> +<a name="85" href="#85">85</a> <em class="jxr_javadoccomment">/**</em> +<a name="86" href="#86">86</a> <em class="jxr_javadoccomment"> * The SP id.</em> +<a name="87" href="#87">87</a> <em class="jxr_javadoccomment"> */</em> +<a name="88" href="#88">88</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String ENTITYID_PARAM_NAME = <span class="jxr_string">"entityID"</span>; +<a name="89" href="#89">89</a> <em class="jxr_javadoccomment">/**</em> +<a name="90" href="#90">90</a> <em class="jxr_javadoccomment"> * Where to send the request back to.</em> +<a name="91" href="#91">91</a> <em class="jxr_javadoccomment"> */</em> +<a name="92" href="#92">92</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String RETURN_PARAM_NAME = <span class="jxr_string">"return"</span>; +<a name="93" href="#93">93</a> <em class="jxr_javadoccomment">/**</em> +<a name="94" href="#94">94</a> <em class="jxr_javadoccomment"> * "return" is an invalid attribute, so we use returnX.</em> +<a name="95" href="#95">95</a> <em class="jxr_javadoccomment"> */</em> +<a name="96" href="#96">96</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String RETURN_ATTRIBUTE_NAME = <span class="jxr_string">"returnX"</span>; +<a name="97" href="#97">97</a> <em class="jxr_javadoccomment">/**</em> +<a name="98" href="#98">98</a> <em class="jxr_javadoccomment"> * Alternatively the index of where to send the address back to.</em> +<a name="99" href="#99">99</a> <em class="jxr_javadoccomment"> */</em> +<a name="100" href="#100">100</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String RETURN_INDEX_NAME = <span class="jxr_string">"returnIndex"</span>; +<a name="101" href="#101">101</a> +<a name="102" href="#102">102</a> <em class="jxr_javadoccomment">/**</em> +<a name="103" href="#103">103</a> <em class="jxr_javadoccomment"> * What value to put the ID of the selected metadata into.</em> +<a name="104" href="#104">104</a> <em class="jxr_javadoccomment"> */</em> +<a name="105" href="#105">105</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String RETURNID_PARAM_NAME = <span class="jxr_string">"returnIDParam"</span>; +<a name="106" href="#106">106</a> +<a name="107" href="#107">107</a> <em class="jxr_javadoccomment">/**</em> +<a name="108" href="#108">108</a> <em class="jxr_javadoccomment"> * What returnIDParam defaults to.</em> +<a name="109" href="#109">109</a> <em class="jxr_javadoccomment"> */</em> +<a name="110" href="#110">110</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String RETURNID_DEFAULT_VALUE = <span class="jxr_string">"entityID"</span>; +<a name="111" href="#111">111</a> <em class="jxr_javadoccomment">/**</em> +<a name="112" href="#112">112</a> <em class="jxr_javadoccomment"> * Whether we are allowed to interact.</em> +<a name="113" href="#113">113</a> <em class="jxr_javadoccomment"> */</em> +<a name="114" href="#114">114</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String ISPASSIVE_PARAM_NAME = <span class="jxr_string">"isPassive"</span>; +<a name="115" href="#115">115</a> +<a name="116" href="#116">116</a> <em class="jxr_javadoccomment">/**</em> +<a name="117" href="#117">117</a> <em class="jxr_javadoccomment"> * Whether we understand this or not.</em> +<a name="118" href="#118">118</a> <em class="jxr_javadoccomment"> */</em> +<a name="119" href="#119">119</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String POLICY_PARAM_NAME = <span class="jxr_string">"policy"</span>; +<a name="120" href="#120">120</a> +<a name="121" href="#121">121</a> <em class="jxr_javadoccomment">/**</em> +<a name="122" href="#122">122</a> <em class="jxr_javadoccomment"> * The only policy we know about.</em> +<a name="123" href="#123">123</a> <em class="jxr_javadoccomment"> */</em> +<a name="124" href="#124">124</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String KNOWN_POLICY_NAME +<a name="125" href="#125">125</a> = <span class="jxr_string">"urn:oasis:names:tc:SAML:profiles:SSO:idp-discoveryprotocol:single"</span>; +<a name="126" href="#126">126</a> +<a name="127" href="#127">127</a> <em class="jxr_javadoccomment">/**</em> +<a name="128" href="#128">128</a> <em class="jxr_javadoccomment"> * Mandatory Serialization constant.</em> +<a name="129" href="#129">129</a> <em class="jxr_javadoccomment"> */</em> +<a name="130" href="#130">130</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Logger LOG = LoggerFactory.getLogger(DiscoveryServiceHandler.<strong class="jxr_keyword">class</strong>.getName()); +<a name="131" href="#131">131</a> +<a name="132" href="#132">132</a> <em class="jxr_javadoccomment">/**</em> +<a name="133" href="#133">133</a> <em class="jxr_javadoccomment"> * The location defines the last part of the URL which distinguished this handler. </em> +<a name="134" href="#134">134</a> <em class="jxr_javadoccomment"> */</em> +<a name="135" href="#135">135</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> String location; +<a name="136" href="#136">136</a> +<a name="137" href="#137">137</a> <em class="jxr_javadoccomment">/**</em> +<a name="138" href="#138">138</a> <em class="jxr_javadoccomment"> * If isDefault is true then if there is a mismatch then this handler is used. </em> +<a name="139" href="#139">139</a> <em class="jxr_javadoccomment"> */</em> +<a name="140" href="#140">140</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> isDefault; +<a name="141" href="#141">141</a> +<a name="142" href="#142">142</a> <em class="jxr_javadoccomment">/**</em> +<a name="143" href="#143">143</a> <em class="jxr_javadoccomment"> * Config handles detailed behavior.</em> +<a name="144" href="#144">144</a> <em class="jxr_javadoccomment"> */</em> +<a name="145" href="#145">145</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/HandlerConfig.html">HandlerConfig</a> config; +<a name="146" href="#146">146</a> +<a name="147" href="#147">147</a> <em class="jxr_javadoccomment">/**</em> +<a name="148" href="#148">148</a> <em class="jxr_javadoccomment"> * The list of all the metadata providers that this discovery handler believes in.</em> +<a name="149" href="#149">149</a> <em class="jxr_javadoccomment"> */</em> +<a name="150" href="#150">150</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> List <IdPSiteSet> siteSets; +<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"> * The list of all the plugins that this hanlder has had configured.</em> +<a name="154" href="#154">154</a> <em class="jxr_javadoccomment"> */</em> +<a name="155" href="#155">155</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> List <Plugin> plugins; +<a name="156" href="#156">156</a> +<a name="157" href="#157">157</a> <em class="jxr_javadoccomment">/**</em> +<a name="158" href="#158">158</a> <em class="jxr_javadoccomment"> * Constructor to create and configure the handler.</em> +<a name="159" href="#159">159</a> <em class="jxr_javadoccomment"> * @param config - DOM Element with configuration information.</em> +<a name="160" href="#160">160</a> <em class="jxr_javadoccomment"> * @param federations - Supplies all known providers which will be included if so configured.</em> +<a name="161" href="#161">161</a> <em class="jxr_javadoccomment"> * @param plugins - Supplies all known plugins which will be included if configured in. </em> +<a name="162" href="#162">162</a> <em class="jxr_javadoccomment"> * @param defaultConfig - The default configurations.</em> +<a name="163" href="#163">163</a> <em class="jxr_javadoccomment"> * @throws ShibbolethConfigurationException - if we find something odd in the config file. </em> +<a name="164" href="#164">164</a> <em class="jxr_javadoccomment"> */</em> +<a name="165" href="#165">165</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/DiscoveryServiceHandler.html">DiscoveryServiceHandler</a>(Element config, +<a name="166" href="#166">166</a> Hashtable <String, IdPSiteSet> federations, +<a name="167" href="#167">167</a> Hashtable <String, Plugin> plugins, +<a name="168" href="#168">168</a> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/HandlerConfig.html">HandlerConfig</a> defaultConfig) <strong class="jxr_keyword">throws</strong> ShibbolethConfigurationException +<a name="169" href="#169">169</a> { +<a name="170" href="#170">170</a> siteSets = <strong class="jxr_keyword">new</strong> ArrayList <IdPSiteSet>(federations.size()); +<a name="171" href="#171">171</a> <strong class="jxr_keyword">this</strong>.plugins = <strong class="jxr_keyword">new</strong> ArrayList <Plugin>(plugins.size()); +<a name="172" href="#172">172</a> +<a name="173" href="#173">173</a> <em class="jxr_comment">//</em> +<a name="174" href="#174">174</a> <em class="jxr_comment">// Collect the Configuration from the XML</em> +<a name="175" href="#175">175</a> <em class="jxr_comment">//</em> +<a name="176" href="#176">176</a> +<a name="177" href="#177">177</a> <strong class="jxr_keyword">this</strong>.config = <strong class="jxr_keyword">new</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/HandlerConfig.html">HandlerConfig</a>(config, defaultConfig); +<a name="178" href="#178">178</a> +<a name="179" href="#179">179</a> location = config.getAttribute(<span class="jxr_string">"location"</span>); +<a name="180" href="#180">180</a> +<a name="181" href="#181">181</a> <strong class="jxr_keyword">if</strong> (location == <strong class="jxr_keyword">null</strong> || location.equals(<span class="jxr_string">""</span>)) { +<a name="182" href="#182">182</a> +<a name="183" href="#183">183</a> LOG.error(<span class="jxr_string">"DiscoveryService must have a location specified"</span>); +<a name="184" href="#184">184</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/common/ShibbolethConfigurationException.html">ShibbolethConfigurationException</a>(<span class="jxr_string">"DiscoveryService must have a location specified"</span>); +<a name="185" href="#185">185</a> } +<a name="186" href="#186">186</a> +<a name="187" href="#187">187</a> <em class="jxr_comment">//</em> +<a name="188" href="#188">188</a> <em class="jxr_comment">// Is this the default WAYF?</em> +<a name="189" href="#189">189</a> <em class="jxr_comment">//</em> +<a name="190" href="#190">190</a> +<a name="191" href="#191">191</a> String attribute = config.getAttribute(<span class="jxr_string">"default"</span>); +<a name="192" href="#192">192</a> <strong class="jxr_keyword">if</strong> (attribute != <strong class="jxr_keyword">null</strong> && !attribute.equals(<span class="jxr_string">""</span>)) { +<a name="193" href="#193">193</a> isDefault = Boolean.valueOf(attribute).booleanValue(); +<a name="194" href="#194">194</a> } <strong class="jxr_keyword">else</strong> { +<a name="195" href="#195">195</a> isDefault = <strong class="jxr_keyword">true</strong>; +<a name="196" href="#196">196</a> } +<a name="197" href="#197">197</a> +<a name="198" href="#198">198</a> <em class="jxr_comment">//</em> +<a name="199" href="#199">199</a> <em class="jxr_comment">// Which federations (sitesets) do we care about?</em> +<a name="200" href="#200">200</a> <em class="jxr_comment">//</em> +<a name="201" href="#201">201</a> +<a name="202" href="#202">202</a> NodeList list = config.getElementsByTagName(<span class="jxr_string">"Federation"</span>); +<a name="203" href="#203">203</a> +<a name="204" href="#204">204</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i < list.getLength(); i++ ) { +<a name="205" href="#205">205</a> +<a name="206" href="#206">206</a> attribute = ((Element) list.item(i)).getAttribute(<span class="jxr_string">"identifier"</span>); +<a name="207" href="#207">207</a> +<a name="208" href="#208">208</a> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/IdPSiteSet.html">IdPSiteSet</a> siteset = federations.get(attribute); +<a name="209" href="#209">209</a> +<a name="210" href="#210">210</a> <strong class="jxr_keyword">if</strong> (siteset == <strong class="jxr_keyword">null</strong>) { +<a name="211" href="#211">211</a> LOG.error(<span class="jxr_string">"Handler "</span> + location + <span class="jxr_string">": could not find metadata for <Federation> with identifier "</span> + attribute + <span class="jxr_string">"."</span>); +<a name="212" href="#212">212</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/common/ShibbolethConfigurationException.html">ShibbolethConfigurationException</a>( +<a name="213" href="#213">213</a> <span class="jxr_string">"Handler "</span> + location + <span class="jxr_string">": could not find metadata for <Federation> identifier "</span> + attribute + <span class="jxr_string">"."</span>); +<a name="214" href="#214">214</a> } +<a name="215" href="#215">215</a> +<a name="216" href="#216">216</a> siteSets.add(siteset); +<a name="217" href="#217">217</a> } +<a name="218" href="#218">218</a> +<a name="219" href="#219">219</a> <strong class="jxr_keyword">if</strong> (siteSets.size() == 0) { +<a name="220" href="#220">220</a> <em class="jxr_comment">//</em> +<a name="221" href="#221">221</a> <em class="jxr_comment">// No Federations explicitly named pick em all</em> +<a name="222" href="#222">222</a> <em class="jxr_comment">//</em> +<a name="223" href="#223">223</a> siteSets.addAll(federations.values()); +<a name="224" href="#224">224</a> } +<a name="225" href="#225">225</a> +<a name="226" href="#226">226</a> <em class="jxr_comment">//</em> +<a name="227" href="#227">227</a> <em class="jxr_comment">// Now, which plugins?</em> +<a name="228" href="#228">228</a> <em class="jxr_comment">//</em> +<a name="229" href="#229">229</a> +<a name="230" href="#230">230</a> list = config.getElementsByTagName(<span class="jxr_string">"PluginInstance"</span>); +<a name="231" href="#231">231</a> +<a name="232" href="#232">232</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i < list.getLength(); i++ ) { +<a name="233" href="#233">233</a> +<a name="234" href="#234">234</a> attribute = ((Element) list.item(i)).getAttribute(<span class="jxr_string">"identifier"</span>); +<a name="235" href="#235">235</a> +<a name="236" href="#236">236</a> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/Plugin.html">Plugin</a> plugin = plugins.get(attribute); +<a name="237" href="#237">237</a> +<a name="238" href="#238">238</a> <strong class="jxr_keyword">if</strong> (plugin == <strong class="jxr_keyword">null</strong>) { +<a name="239" href="#239">239</a> LOG.error(<span class="jxr_string">"Handler "</span> + location + <span class="jxr_string">": could not find plugin for identifier "</span> + attribute); +<a name="240" href="#240">240</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/common/ShibbolethConfigurationException.html">ShibbolethConfigurationException</a>( +<a name="241" href="#241">241</a> <span class="jxr_string">"Handler "</span> + location + <span class="jxr_string">": could not find plugin for identifier "</span> + attribute); +<a name="242" href="#242">242</a> } +<a name="243" href="#243">243</a> +<a name="244" href="#244">244</a> <strong class="jxr_keyword">this</strong>.plugins.add(plugin); +<a name="245" href="#245">245</a> } +<a name="246" href="#246">246</a> +<a name="247" href="#247">247</a> <em class="jxr_comment">//</em> +<a name="248" href="#248">248</a> <em class="jxr_comment">// So now tell every IdPSite about every plugin.</em> +<a name="249" href="#249">249</a> <em class="jxr_comment">//</em> +<a name="250" href="#250">250</a> <em class="jxr_comment">// Note that there is only one idpsite per metadatafile per WAYF and that the discovery </em> +<a name="251" href="#251">251</a> <em class="jxr_comment">// services share them, so the data explosion is only number(IdpSites) * number(Plugins) not</em> +<a name="252" href="#252">252</a> <em class="jxr_comment">// number(IdpSites) * number(Plugins) * number(DiscoverHandlers)</em> +<a name="253" href="#253">253</a> +<a name="254" href="#254">254</a> <strong class="jxr_keyword">for</strong> (IdPSiteSet site: siteSets) { +<a name="255" href="#255">255</a> <strong class="jxr_keyword">for</strong> (Plugin plugin: <strong class="jxr_keyword">this</strong>.plugins) { +<a name="256" href="#256">256</a> site.addPlugin(plugin); +<a name="257" href="#257">257</a> } +<a name="258" href="#258">258</a> } +<a name="259" href="#259">259</a> } +<a name="260" href="#260">260</a> +<a name="261" href="#261">261</a> +<a name="262" href="#262">262</a> <em class="jxr_comment">//</em> +<a name="263" href="#263">263</a> <em class="jxr_comment">// Standard Beany Methods</em> +<a name="264" href="#264">264</a> <em class="jxr_comment">//</em> +<a name="265" href="#265">265</a> <em class="jxr_javadoccomment">/**</em> +<a name="266" href="#266">266</a> <em class="jxr_javadoccomment"> * The 'Name' of the service. the path used to identify the ServiceHandler.</em> +<a name="267" href="#267">267</a> <em class="jxr_javadoccomment"> * @return the path used to identify the ServiceHandler.</em> +<a name="268" href="#268">268</a> <em class="jxr_javadoccomment"> */</em> +<a name="269" href="#269">269</a> +<a name="270" href="#270">270</a> <strong class="jxr_keyword">protected</strong> String getLocation() { +<a name="271" href="#271">271</a> <strong class="jxr_keyword">return</strong> location; +<a name="272" href="#272">272</a> } +<a name="273" href="#273">273</a> +<a name="274" href="#274">274</a> <em class="jxr_javadoccomment">/**</em> +<a name="275" href="#275">275</a> <em class="jxr_javadoccomment"> * Whether this is the default service.</em> +<a name="276" href="#276">276</a> <em class="jxr_javadoccomment"> * @return is it?</em> +<a name="277" href="#277">277</a> <em class="jxr_javadoccomment"> */</em> +<a name="278" href="#278">278</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> isDefault() { +<a name="279" href="#279">279</a> <strong class="jxr_keyword">return</strong> isDefault; +<a name="280" href="#280">280</a> } +<a name="281" href="#281">281</a> +<a name="282" href="#282">282</a> <em class="jxr_comment">//</em> +<a name="283" href="#283">283</a> <em class="jxr_comment">// Now the bits that deal with the user request</em> +<a name="284" href="#284">284</a> <em class="jxr_comment">//</em> +<a name="285" href="#285">285</a> +<a name="286" href="#286">286</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> doGet(HttpServletRequest req, HttpServletResponse res) { +<a name="287" href="#287">287</a> +<a name="288" href="#288">288</a> String policy = req.getParameter(POLICY_PARAM_NAME); +<a name="289" href="#289">289</a> +<a name="290" href="#290">290</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">null</strong> != policy && !KNOWN_POLICY_NAME.equals(policy)) { +<a name="291" href="#291">291</a> <em class="jxr_comment">//</em> +<a name="292" href="#292">292</a> <em class="jxr_comment">// unknown policy</em> +<a name="293" href="#293">293</a> <em class="jxr_comment">//</em> +<a name="294" href="#294">294</a> LOG.error(<span class="jxr_string">"Unknown policy "</span> + policy); +<a name="295" href="#295">295</a> handleError(req, res, <span class="jxr_string">"Unknown policy "</span> + policy); +<a name="296" href="#296">296</a> <strong class="jxr_keyword">return</strong>; +<a name="297" href="#297">297</a> } +<a name="298" href="#298">298</a> +<a name="299" href="#299">299</a> <em class="jxr_comment">//</em> +<a name="300" href="#300">300</a> <em class="jxr_comment">// Decide how to route the request based on query string</em> +<a name="301" href="#301">301</a> <em class="jxr_comment">//</em> +<a name="302" href="#302">302</a> String requestType = req.getParameter(<span class="jxr_string">"action"</span>); +<a name="303" href="#303">303</a> +<a name="304" href="#304">304</a> <strong class="jxr_keyword">if</strong> (requestType == <strong class="jxr_keyword">null</strong> || requestType.equals(<span class="jxr_string">""</span>)) { +<a name="305" href="#305">305</a> requestType = <span class="jxr_string">"lookup"</span>; +<a name="306" href="#306">306</a> } +<a name="307" href="#307">307</a> +<a name="308" href="#308">308</a> <strong class="jxr_keyword">try</strong> { +<a name="309" href="#309">309</a> +<a name="310" href="#310">310</a> <strong class="jxr_keyword">if</strong> (requestType.equals(<span class="jxr_string">"search"</span>)) { +<a name="311" href="#311">311</a> +<a name="312" href="#312">312</a> String parameter = req.getParameter(<span class="jxr_string">"string"</span>); +<a name="313" href="#313">313</a> <strong class="jxr_keyword">if</strong> (parameter != <strong class="jxr_keyword">null</strong> && parameter.equals(<span class="jxr_string">""</span>)) { +<a name="314" href="#314">314</a> parameter = <strong class="jxr_keyword">null</strong>; +<a name="315" href="#315">315</a> } +<a name="316" href="#316">316</a> handleLookup(req, res, parameter); +<a name="317" href="#317">317</a> +<a name="318" href="#318">318</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (requestType.equals(<span class="jxr_string">"selection"</span>)) { +<a name="319" href="#319">319</a> +<a name="320" href="#320">320</a> handleSelection(req, res); +<a name="321" href="#321">321</a> } <strong class="jxr_keyword">else</strong> { +<a name="322" href="#322">322</a> handleLookup(req, res, <strong class="jxr_keyword">null</strong>); +<a name="323" href="#323">323</a> } +<a name="324" href="#324">324</a> } <strong class="jxr_keyword">catch</strong> (WayfException we) { +<a name="325" href="#325">325</a> LOG.error(<span class="jxr_string">"Error processing DS request:"</span>, we); +<a name="326" href="#326">326</a> handleError(req, res, we.getLocalizedMessage()); +<a name="327" href="#327">327</a> } <strong class="jxr_keyword">catch</strong> (WayfRequestHandled we) { +<a name="328" href="#328">328</a> <em class="jxr_comment">//</em> +<a name="329" href="#329">329</a> <em class="jxr_comment">// Yuck - a sucess path involving an exception</em> +<a name="330" href="#330">330</a> <em class="jxr_comment">//</em> +<a name="331" href="#331">331</a> } +<a name="332" href="#332">332</a> +<a name="333" href="#333">333</a> } +<a name="334" href="#334">334</a> +<a name="335" href="#335">335</a> <em class="jxr_javadoccomment">/**</em> +<a name="336" href="#336">336</a> <em class="jxr_javadoccomment"> * When the WAYF user has selected something we look it up, tell the plugins and then dispatch to the Idp.</em> +<a name="337" href="#337">337</a> <em class="jxr_javadoccomment"> * </em> +<a name="338" href="#338">338</a> <em class="jxr_javadoccomment"> * @param req - standard J2EE stuff</em> +<a name="339" href="#339">339</a> <em class="jxr_javadoccomment"> * @param res - standard J2EE stuff</em> +<a name="340" href="#340">340</a> <em class="jxr_javadoccomment"> * @throws WayfRequestHandled - if one of the plugins has done the dispatch</em> +<a name="341" href="#341">341</a> <em class="jxr_javadoccomment"> * @throws WayfException - if we had an errors</em> +<a name="342" href="#342">342</a> <em class="jxr_javadoccomment"> */</em> +<a name="343" href="#343">343</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> handleSelection(HttpServletRequest req, +<a name="344" href="#344">344</a> HttpServletResponse res) <strong class="jxr_keyword">throws</strong> WayfRequestHandled, WayfException +<a name="345" href="#345">345</a> { +<a name="346" href="#346">346</a> +<a name="347" href="#347">347</a> String idpName = req.getParameter(<span class="jxr_string">"origin"</span>); +<a name="348" href="#348">348</a> LOG.debug(<span class="jxr_string">"Processing handle selection: "</span> + idpName); +<a name="349" href="#349">349</a> +<a name="350" href="#350">350</a> String sPName = getSPId(req); +<a name="351" href="#351">351</a> +<a name="352" href="#352">352</a> <strong class="jxr_keyword">if</strong> (idpName == <strong class="jxr_keyword">null</strong> || idpName.equals(<span class="jxr_string">""</span>)) { +<a name="353" href="#353">353</a> handleLookup(req, res, <strong class="jxr_keyword">null</strong>); +<a name="354" href="#354">354</a> <strong class="jxr_keyword">return</strong>; +<a name="355" href="#355">355</a> } +<a name="356" href="#356">356</a> +<a name="357" href="#357">357</a> <strong class="jxr_keyword">if</strong> (getValue(req, SHIRE_PARAM_NAME) == <strong class="jxr_keyword">null</strong>) { +<a name="358" href="#358">358</a> <em class="jxr_comment">//</em> +<a name="359" href="#359">359</a> <em class="jxr_comment">// 2.0 protocol</em> +<a name="360" href="#360">360</a> <em class="jxr_comment">//</em> +<a name="361" href="#361">361</a> setupReturnAddress(sPName, req); +<a name="362" href="#362">362</a> } +<a name="363" href="#363">363</a> <em class="jxr_comment">//</em> +<a name="364" href="#364">364</a> <em class="jxr_comment">// Notify plugins</em> +<a name="365" href="#365">365</a> <em class="jxr_comment">//</em> +<a name="366" href="#366">366</a> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/IdPSite.html">IdPSite</a> site = <strong class="jxr_keyword">null</strong>; +<a name="367" href="#367">367</a> +<a name="368" href="#368">368</a> <strong class="jxr_keyword">for</strong> (Plugin plugin:plugins) { +<a name="369" href="#369">369</a> <strong class="jxr_keyword">for</strong> (IdPSiteSet idPSiteSet: siteSets) { +<a name="370" href="#370">370</a> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/PluginMetadataParameter.html">PluginMetadataParameter</a> param = idPSiteSet.paramFor(plugin); +<a name="371" href="#371">371</a> plugin.selected(req, res, param, idpName); +<a name="372" href="#372">372</a> <strong class="jxr_keyword">if</strong> (site == <strong class="jxr_keyword">null</strong> && idPSiteSet.containsIdP(idpName)) { +<a name="373" href="#373">373</a> site = idPSiteSet.getSite(idpName); +<a name="374" href="#374">374</a> } +<a name="375" href="#375">375</a> } +<a name="376" href="#376">376</a> } +<a name="377" href="#377">377</a> +<a name="378" href="#378">378</a> <strong class="jxr_keyword">if</strong> (site == <strong class="jxr_keyword">null</strong>) { +<a name="379" href="#379">379</a> handleLookup(req, res, <strong class="jxr_keyword">null</strong>); +<a name="380" href="#380">380</a> } <strong class="jxr_keyword">else</strong> { +<a name="381" href="#381">381</a> forwardRequest(req, res, site); +<a name="382" href="#382">382</a> } +<a name="383" href="#383">383</a> } +<a name="384" href="#384">384</a> +<a name="385" href="#385">385</a> +<a name="386" href="#386">386</a> <em class="jxr_javadoccomment">/**</em> +<a name="387" href="#387">387</a> <em class="jxr_javadoccomment"> * This sets up the parameter RETURN_ATTRIBUTE_NAME with the return address </em> +<a name="388" href="#388">388</a> <em class="jxr_javadoccomment"> * harvested from the reqest.</em> +<a name="389" href="#389">389</a> <em class="jxr_javadoccomment"> * <ul><le>If a "return" parameter is present we check in the metadata for spoofing </em> +<a name="390" href="#390">390</a> <em class="jxr_javadoccomment"> * and then set up from there </le></em> +<a name="391" href="#391">391</a> <em class="jxr_javadoccomment"> * <le>If "returnID" is specified we get this from the metadata</le></em> +<a name="392" href="#392">392</a> <em class="jxr_javadoccomment"> * <le>If nothing is provided we get the default from the metadata (if provided)</le></em> +<a name="393" href="#393">393</a> <em class="jxr_javadoccomment"> * <le>Otherwise we whine</le></em> +<a name="394" href="#394">394</a> <em class="jxr_javadoccomment"> * </ul> </em> +<a name="395" href="#395">395</a> <em class="jxr_javadoccomment"> * @param spName - the name of the Service provider.</em> +<a name="396" href="#396">396</a> <em class="jxr_javadoccomment"> * @param req - The request.</em> +<a name="397" href="#397">397</a> <em class="jxr_javadoccomment"> * @throws WayfException - if we spot spoofing or there is no defaumlt </em> +<a name="398" href="#398">398</a> <em class="jxr_javadoccomment"> */</em> +<a name="399" href="#399">399</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> setupReturnAddress(String spName, HttpServletRequest req) <strong class="jxr_keyword">throws</strong> WayfException{ +<a name="400" href="#400">400</a> +<a name="401" href="#401">401</a> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/DiscoveryResponseImpl.html">DiscoveryResponseImpl</a>[] discoveryServices; +<a name="402" href="#402">402</a> Set<XMLObject> objects = <strong class="jxr_keyword">new</strong> HashSet<XMLObject>(); +<a name="403" href="#403">403</a> String defaultName = <strong class="jxr_keyword">null</strong>; +<a name="404" href="#404">404</a> +<a name="405" href="#405">405</a> <strong class="jxr_keyword">for</strong> (IdPSiteSet metadataProvider:siteSets) { +<a name="406" href="#406">406</a> +<a name="407" href="#407">407</a> <em class="jxr_comment">//</em> +<a name="408" href="#408">408</a> <em class="jxr_comment">// Only do work if the SP makes sense</em> +<a name="409" href="#409">409</a> <em class="jxr_comment">//</em> +<a name="410" href="#410">410</a> +<a name="411" href="#411">411</a> <strong class="jxr_keyword">if</strong> (metadataProvider.containsSP(spName)) { +<a name="412" href="#412">412</a> +<a name="413" href="#413">413</a> <em class="jxr_comment">//</em> +<a name="414" href="#414">414</a> <em class="jxr_comment">// The name makes sense so let's get the entity and from that</em> +<a name="415" href="#415">415</a> <em class="jxr_comment">// all of its roles</em> +<a name="416" href="#416">416</a> <em class="jxr_comment">//</em> +<a name="417" href="#417">417</a> +<a name="418" href="#418">418</a> EntityDescriptor entity = metadataProvider.getEntity(spName); +<a name="419" href="#419">419</a> List<RoleDescriptor> roles = entity.getRoleDescriptors(); +<a name="420" href="#420">420</a> +<a name="421" href="#421">421</a> <strong class="jxr_keyword">for</strong> (RoleDescriptor role:roles) { +<a name="422" href="#422">422</a> +<a name="423" href="#423">423</a> <em class="jxr_comment">//</em> +<a name="424" href="#424">424</a> <em class="jxr_comment">// Check every role</em> +<a name="425" href="#425">425</a> <em class="jxr_comment">//</em> +<a name="426" href="#426">426</a> +<a name="427" href="#427">427</a> <strong class="jxr_keyword">if</strong> (role instanceof SPSSODescriptor) { +<a name="428" href="#428">428</a> +<a name="429" href="#429">429</a> <em class="jxr_comment">//</em> +<a name="430" href="#430">430</a> <em class="jxr_comment">// And grab hold of all the extensions for SPSSO descriptors</em> +<a name="431" href="#431">431</a> <em class="jxr_comment">//</em> +<a name="432" href="#432">432</a> +<a name="433" href="#433">433</a> Extensions exts = role.getExtensions(); +<a name="434" href="#434">434</a> <strong class="jxr_keyword">if</strong> (exts != <strong class="jxr_keyword">null</strong>) { +<a name="435" href="#435">435</a> objects.addAll(exts.getOrderedChildren()); +<a name="436" href="#436">436</a> } +<a name="437" href="#437">437</a> } +<a name="438" href="#438">438</a> } +<a name="439" href="#439">439</a> } +<a name="440" href="#440">440</a> } +<a name="441" href="#441">441</a> +<a name="442" href="#442">442</a> <em class="jxr_comment">//</em> +<a name="443" href="#443">443</a> <em class="jxr_comment">// Now, let's strip out everything which isn't a DiscoveryService</em> +<a name="444" href="#444">444</a> <em class="jxr_comment">//</em> +<a name="445" href="#445">445</a> +<a name="446" href="#446">446</a> discoveryServices = <strong class="jxr_keyword">new</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/DiscoveryResponseImpl.html">DiscoveryResponseImpl</a>[objects.size()]; +<a name="447" href="#447">447</a> <strong class="jxr_keyword">int</strong> dsCount = 0; +<a name="448" href="#448">448</a> +<a name="449" href="#449">449</a> <strong class="jxr_keyword">for</strong> (XMLObject obj:objects) { +<a name="450" href="#450">450</a> <strong class="jxr_keyword">if</strong> (obj instanceof DiscoveryResponseImpl) { +<a name="451" href="#451">451</a> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/DiscoveryResponseImpl.html">DiscoveryResponseImpl</a> ds = (DiscoveryResponseImpl) obj; +<a name="452" href="#452">452</a> discoveryServices[dsCount++] = ds; +<a name="453" href="#453">453</a> <strong class="jxr_keyword">if</strong> (ds.isDefault() || <strong class="jxr_keyword">null</strong> == defaultName) { +<a name="454" href="#454">454</a> defaultName = ds.getLocation(); +<a name="455" href="#455">455</a> } +<a name="456" href="#456">456</a> } +<a name="457" href="#457">457</a> } +<a name="458" href="#458">458</a> +<a name="459" href="#459">459</a> <em class="jxr_comment">//</em> +<a name="460" href="#460">460</a> <em class="jxr_comment">// Now process the return parameters. The name is either a parameter</em> +<a name="461" href="#461">461</a> <em class="jxr_comment">// called RETURN_PARAM_NAME or an attributes called RETURN_ATTRIBUTE_NAME</em> +<a name="462" href="#462">462</a> <em class="jxr_comment">//</em> +<a name="463" href="#463">463</a> String returnName = req.getParameter(RETURN_PARAM_NAME); +<a name="464" href="#464">464</a> +<a name="465" href="#465">465</a> <strong class="jxr_keyword">if</strong> (returnName == <strong class="jxr_keyword">null</strong> || returnName.length() == 0) { +<a name="466" href="#466">466</a> returnName = getValue(req, RETURN_ATTRIBUTE_NAME); +<a name="467" href="#467">467</a> } +<a name="468" href="#468">468</a> +<a name="469" href="#469">469</a> <em class="jxr_comment">//</em> +<a name="470" href="#470">470</a> <em class="jxr_comment">// Return index is only ever a parameter</em> +<a name="471" href="#471">471</a> <em class="jxr_comment">//</em> +<a name="472" href="#472">472</a> +<a name="473" href="#473">473</a> String returnIndex = req.getParameter(RETURN_INDEX_NAME); +<a name="474" href="#474">474</a> +<a name="475" href="#475">475</a> <strong class="jxr_keyword">if</strong> (returnName != <strong class="jxr_keyword">null</strong> && returnName.length() != 0) { +<a name="476" href="#476">476</a> <em class="jxr_comment">//</em> +<a name="477" href="#477">477</a> <em class="jxr_comment">// Given something so we have to police it.</em> +<a name="478" href="#478">478</a> <em class="jxr_comment">//</em> +<a name="479" href="#479">479</a> String nameNoParam = returnName; +<a name="480" href="#480">480</a> URL providedReturnURL; +<a name="481" href="#481">481</a> <strong class="jxr_keyword">int</strong> index = nameNoParam.indexOf('?'); +<a name="482" href="#482">482</a> <strong class="jxr_keyword">boolean</strong> found = false; +<a name="483" href="#483">483</a> +<a name="484" href="#484">484</a> <strong class="jxr_keyword">if</strong> (index >= 0) { +<a name="485" href="#485">485</a> nameNoParam = nameNoParam.substring(0,index); +<a name="486" href="#486">486</a> } +<a name="487" href="#487">487</a> +<a name="488" href="#488">488</a> <strong class="jxr_keyword">try</strong> { +<a name="489" href="#489">489</a> providedReturnURL = <strong class="jxr_keyword">new</strong> URL(nameNoParam); +<a name="490" href="#490">490</a> } <strong class="jxr_keyword">catch</strong> (MalformedURLException e) { +<a name="491" href="#491">491</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/WayfException.html">WayfException</a>(<span class="jxr_string">"Couldn't parse provided return name "</span> + nameNoParam, e); +<a name="492" href="#492">492</a> } +<a name="493" href="#493">493</a> +<a name="494" href="#494">494</a> +<a name="495" href="#495">495</a> <strong class="jxr_keyword">for</strong> (DiscoveryResponseImpl disc: discoveryServices) { +<a name="496" href="#496">496</a> <strong class="jxr_keyword">if</strong> (equalsURL(disc, providedReturnURL)) { +<a name="497" href="#497">497</a> found = <strong class="jxr_keyword">true</strong>; +<a name="498" href="#498">498</a> <strong class="jxr_keyword">break</strong>; +<a name="499" href="#499">499</a> } +<a name="500" href="#500">500</a> } +<a name="501" href="#501">501</a> <strong class="jxr_keyword">if</strong> (!found) { +<a name="502" href="#502">502</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/WayfException.html">WayfException</a>(<span class="jxr_string">"Couldn't find endpoint "</span> + nameNoParam + <span class="jxr_string">" in metadata"</span>); +<a name="503" href="#503">503</a> } +<a name="504" href="#504">504</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (returnIndex != <strong class="jxr_keyword">null</strong> && returnIndex.length() != 0) { +<a name="505" href="#505">505</a> +<a name="506" href="#506">506</a> <strong class="jxr_keyword">int</strong> index; +<a name="507" href="#507">507</a> <strong class="jxr_keyword">try</strong> { +<a name="508" href="#508">508</a> index = Integer.parseInt(returnIndex); +<a name="509" href="#509">509</a> } <strong class="jxr_keyword">catch</strong> (NumberFormatException e) { +<a name="510" href="#510">510</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/WayfException.html">WayfException</a>(<span class="jxr_string">"Couldn't convert "</span> + returnIndex + <span class="jxr_string">" into an index"</span>); +<a name="511" href="#511">511</a> } +<a name="512" href="#512">512</a> <em class="jxr_comment">//</em> +<a name="513" href="#513">513</a> <em class="jxr_comment">// So look throught to find the endpoint with the correct index</em> +<a name="514" href="#514">514</a> <em class="jxr_comment">//</em> +<a name="515" href="#515">515</a> +<a name="516" href="#516">516</a> <strong class="jxr_keyword">boolean</strong> found = false; +<a name="517" href="#517">517</a> +<a name="518" href="#518">518</a> <strong class="jxr_keyword">for</strong> (DiscoveryResponseImpl disc: discoveryServices) { +<a name="519" href="#519">519</a> <strong class="jxr_keyword">if</strong> (index == disc.getIndex()) { +<a name="520" href="#520">520</a> found = <strong class="jxr_keyword">true</strong>; +<a name="521" href="#521">521</a> returnName = disc.getLocation(); +<a name="522" href="#522">522</a> <strong class="jxr_keyword">break</strong>; +<a name="523" href="#523">523</a> } +<a name="524" href="#524">524</a> } +<a name="525" href="#525">525</a> <strong class="jxr_keyword">if</strong> (!found) { +<a name="526" href="#526">526</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/WayfException.html">WayfException</a>(<span class="jxr_string">"Couldn't not find endpoint "</span> + returnIndex + <span class="jxr_string">"in metadata"</span>); +<a name="527" href="#527">527</a> } +<a name="528" href="#528">528</a> } <strong class="jxr_keyword">else</strong> { +<a name="529" href="#529">529</a> <em class="jxr_comment">//</em> +<a name="530" href="#530">530</a> <em class="jxr_comment">// No name, not index, so we want the default</em> +<a name="531" href="#531">531</a> <em class="jxr_comment">//</em> +<a name="532" href="#532">532</a> returnName = defaultName; +<a name="533" href="#533">533</a> } +<a name="534" href="#534">534</a> <em class="jxr_comment">//</em> +<a name="535" href="#535">535</a> <em class="jxr_comment">// So by now returnName has the correct value, either harvested from or</em> +<a name="536" href="#536">536</a> <em class="jxr_comment">// policed against the metadata</em> +<a name="537" href="#537">537</a> <em class="jxr_comment">//</em> +<a name="538" href="#538">538</a> req.setAttribute(RETURN_ATTRIBUTE_NAME, returnName); +<a name="539" href="#539">539</a> } +<a name="540" href="#540">540</a> +<a name="541" href="#541">541</a> <em class="jxr_javadoccomment">/**</em> +<a name="542" href="#542">542</a> <em class="jxr_javadoccomment"> * Helper function to see whather the provided endpoint in the metadata matches the </em> +<a name="543" href="#543">543</a> <em class="jxr_javadoccomment"> * provided return URL in the request.</em> +<a name="544" href="#544">544</a> <em class="jxr_javadoccomment"> * </em> +<a name="545" href="#545">545</a> <em class="jxr_javadoccomment"> * @param discovery</em> +<a name="546" href="#546">546</a> <em class="jxr_javadoccomment"> * @param providedName</em> +<a name="547" href="#547">547</a> <em class="jxr_javadoccomment"> * @return</em> +<a name="548" href="#548">548</a> <em class="jxr_javadoccomment"> */</em> +<a name="549" href="#549">549</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">boolean</strong> equalsURL(<a href="../../../../../edu/internet2/middleware/shibboleth/wayf/DiscoveryResponseImpl.html">DiscoveryResponseImpl</a> discovery, URL providedName) { +<a name="550" href="#550">550</a> +<a name="551" href="#551">551</a> <em class="jxr_comment">//</em> +<a name="552" href="#552">552</a> <em class="jxr_comment">// Nothing provided - no match</em> +<a name="553" href="#553">553</a> <em class="jxr_comment">//</em> +<a name="554" href="#554">554</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">null</strong> == discovery) { +<a name="555" href="#555">555</a> <strong class="jxr_keyword">return</strong> false; +<a name="556" href="#556">556</a> } +<a name="557" href="#557">557</a> +<a name="558" href="#558">558</a> URL discoveryName; +<a name="559" href="#559">559</a> <strong class="jxr_keyword">try</strong> { +<a name="560" href="#560">560</a> discoveryName = <strong class="jxr_keyword">new</strong> URL(discovery.getLocation()); +<a name="561" href="#561">561</a> } <strong class="jxr_keyword">catch</strong> (MalformedURLException e) { +<a name="562" href="#562">562</a> <em class="jxr_comment">//</em> +<a name="563" href="#563">563</a> <em class="jxr_comment">// Something bad happened. Log it (it is only of interest to the sysadmin, not to the user)</em> +<a name="564" href="#564">564</a> <em class="jxr_comment">//</em> +<a name="565" href="#565">565</a> LOG.warn(<span class="jxr_string">"Found invalid discovery end point : "</span> + discovery.getLocation(), e); +<a name="566" href="#566">566</a> <strong class="jxr_keyword">return</strong> false; +<a name="567" href="#567">567</a> } +<a name="568" href="#568">568</a> +<a name="569" href="#569">569</a> <strong class="jxr_keyword">return</strong> providedName.equals(discoveryName); +<a name="570" href="#570">570</a> +<a name="571" href="#571">571</a> } +<a name="572" href="#572">572</a> +<a name="573" href="#573">573</a> <em class="jxr_javadoccomment">/**</em> +<a name="574" href="#574">574</a> <em class="jxr_javadoccomment"> * Displays a Discovery Service selection page, having first consulted the plugins as needed.</em> +<a name="575" href="#575">575</a> <em class="jxr_javadoccomment"> * @param req Describes the request</em> +<a name="576" href="#576">576</a> <em class="jxr_javadoccomment"> * @param res Describes the response</em> +<a name="577" href="#577">577</a> <em class="jxr_javadoccomment"> * @param searchName What are we looking for?</em> +<a name="578" href="#578">578</a> <em class="jxr_javadoccomment"> * </em> +<a name="579" href="#579">579</a> <em class="jxr_javadoccomment"> * @throws WayfRequestHandled if a plugin has dealt with the request</em> +<a name="580" href="#580">580</a> <em class="jxr_javadoccomment"> * @throws WayfException in case of an error.</em> +<a name="581" href="#581">581</a> <em class="jxr_javadoccomment"> */</em> +<a name="582" href="#582">582</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> handleLookup(HttpServletRequest req, +<a name="583" href="#583">583</a> HttpServletResponse res, +<a name="584" href="#584">584</a> String searchName) <strong class="jxr_keyword">throws</strong> WayfException, WayfRequestHandled { +<a name="585" href="#585">585</a> +<a name="586" href="#586">586</a> String shire = getValue(req, SHIRE_PARAM_NAME); +<a name="587" href="#587">587</a> String providerId = getSPId(req); +<a name="588" href="#588">588</a> <strong class="jxr_keyword">boolean</strong> twoZeroProtocol = (shire == <strong class="jxr_keyword">null</strong>); +<a name="589" href="#589">589</a> <strong class="jxr_keyword">boolean</strong> isPassive = (twoZeroProtocol && +<a name="590" href="#590">590</a> <span class="jxr_string">"true"</span>.equalsIgnoreCase(getValue(req, ISPASSIVE_PARAM_NAME))); +<a name="591" href="#591">591</a> +<a name="592" href="#592">592</a> Collection <IdPSiteSetEntry> siteLists = <strong class="jxr_keyword">null</strong>; +<a name="593" href="#593">593</a> Collection<IdPSite> searchResults = <strong class="jxr_keyword">null</strong>; +<a name="594" href="#594">594</a> +<a name="595" href="#595">595</a> <strong class="jxr_keyword">if</strong> (config.getProvideListOfLists()) { +<a name="596" href="#596">596</a> siteLists = <strong class="jxr_keyword">new</strong> ArrayList <IdPSiteSetEntry>(siteSets.size()); +<a name="597" href="#597">597</a> } +<a name="598" href="#598">598</a> +<a name="599" href="#599">599</a> Collection <IdPSite> sites = <strong class="jxr_keyword">null</strong>; +<a name="600" href="#600">600</a> Comparator<IdPSite> comparator = <strong class="jxr_keyword">new</strong> IdPSite.Compare(req); +<a name="601" href="#601">601</a> +<a name="602" href="#602">602</a> <strong class="jxr_keyword">if</strong> (config.getProvideList()) { +<a name="603" href="#603">603</a> sites = <strong class="jxr_keyword">new</strong> TreeSet<IdPSite>(comparator); +<a name="604" href="#604">604</a> } +<a name="605" href="#605">605</a> +<a name="606" href="#606">606</a> <strong class="jxr_keyword">if</strong> (searchName != <strong class="jxr_keyword">null</strong> && !searchName.equals(<span class="jxr_string">""</span>)) { +<a name="607" href="#607">607</a> searchResults = <strong class="jxr_keyword">new</strong> TreeSet<IdPSite>(comparator); +<a name="608" href="#608">608</a> } +<a name="609" href="#609">609</a> +<a name="610" href="#610">610</a> LOG.debug(<span class="jxr_string">"Processing Idp Lookup for : "</span> + providerId); +<a name="611" href="#611">611</a> +<a name="612" href="#612">612</a> <em class="jxr_comment">//</em> +<a name="613" href="#613">613</a> <em class="jxr_comment">// Iterate over all the sitesets and if they know about the SP pass them to the plugins</em> +<a name="614" href="#614">614</a> <em class="jxr_comment">// and then add them too the list</em> +<a name="615" href="#615">615</a> <em class="jxr_comment">//</em> +<a name="616" href="#616">616</a> +<a name="617" href="#617">617</a> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/PluginContext.html">PluginContext</a>[] ctx = <strong class="jxr_keyword">new</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/PluginContext.html">PluginContext</a>[plugins.size()]; +<a name="618" href="#618">618</a> List<IdPSite> hintList = <strong class="jxr_keyword">new</strong> ArrayList<IdPSite>(); +<a name="619" href="#619">619</a> +<a name="620" href="#620">620</a> <strong class="jxr_keyword">if</strong> (twoZeroProtocol) { +<a name="621" href="#621">621</a> setupReturnAddress(providerId, req); +<a name="622" href="#622">622</a> } +<a name="623" href="#623">623</a> <em class="jxr_comment">//</em> +<a name="624" href="#624">624</a> <em class="jxr_comment">// By having siteLists and sites as parameters we only iterate over </em> +<a name="625" href="#625">625</a> <em class="jxr_comment">// the metadata arrays once.</em> +<a name="626" href="#626">626</a> <em class="jxr_comment">//</em> +<a name="627" href="#627">627</a> <strong class="jxr_keyword">try</strong> { +<a name="628" href="#628">628</a> <strong class="jxr_keyword">for</strong> (IdPSiteSet metadataProvider:siteSets) { +<a name="629" href="#629">629</a> +<a name="630" href="#630">630</a> <em class="jxr_comment">//</em> +<a name="631" href="#631">631</a> <em class="jxr_comment">// Only do work if the SP makes sense</em> +<a name="632" href="#632">632</a> <em class="jxr_comment">//</em> +<a name="633" href="#633">633</a> +<a name="634" href="#634">634</a> <strong class="jxr_keyword">if</strong> (metadataProvider.containsSP(providerId) || !config.getLookupSp()) { +<a name="635" href="#635">635</a> +<a name="636" href="#636">636</a> Collection <IdPSite> search = <strong class="jxr_keyword">null</strong>; +<a name="637" href="#637">637</a> +<a name="638" href="#638">638</a> <strong class="jxr_keyword">if</strong> (searchResults != <strong class="jxr_keyword">null</strong>) { +<a name="639" href="#639">639</a> search = <strong class="jxr_keyword">new</strong> TreeSet<IdPSite>(comparator); +<a name="640" href="#640">640</a> } +<a name="641" href="#641">641</a> +<a name="642" href="#642">642</a> Map <String, IdPSite> theseSites = metadataProvider.getIdPSites(searchName, config, search); +<a name="643" href="#643">643</a> +<a name="644" href="#644">644</a> <em class="jxr_comment">//</em> +<a name="645" href="#645">645</a> <em class="jxr_comment">// Consult the plugins</em> +<a name="646" href="#646">646</a> <em class="jxr_comment">//</em> +<a name="647" href="#647">647</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i < plugins.size(); i++) { +<a name="648" href="#648">648</a> +<a name="649" href="#649">649</a> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/Plugin.html">Plugin</a> plugin = plugins.get(i); +<a name="650" href="#650">650</a> +<a name="651" href="#651">651</a> <strong class="jxr_keyword">if</strong> (searchResults == <strong class="jxr_keyword">null</strong>) { +<a name="652" href="#652">652</a> <em class="jxr_comment">//</em> +<a name="653" href="#653">653</a> <em class="jxr_comment">// This was a search</em> +<a name="654" href="#654">654</a> <em class="jxr_comment">//</em> +<a name="655" href="#655">655</a> ctx[i] = plugin.lookup(req, +<a name="656" href="#656">656</a> res, +<a name="657" href="#657">657</a> metadataProvider.paramFor(plugin), +<a name="658" href="#658">658</a> theseSites, +<a name="659" href="#659">659</a> ctx[i], +<a name="660" href="#660">660</a> hintList); +<a name="661" href="#661">661</a> } <strong class="jxr_keyword">else</strong> { +<a name="662" href="#662">662</a> ctx[i] = plugin.search(req, +<a name="663" href="#663">663</a> res, +<a name="664" href="#664">664</a> metadataProvider.paramFor(plugin), +<a name="665" href="#665">665</a> searchName, +<a name="666" href="#666">666</a> theseSites, +<a name="667" href="#667">667</a> ctx[i], +<a name="668" href="#668">668</a> searchResults, +<a name="669" href="#669">669</a> hintList); +<a name="670" href="#670">670</a> } +<a name="671" href="#671">671</a> } +<a name="672" href="#672">672</a> +<a name="673" href="#673">673</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">null</strong> == theseSites || theseSites.isEmpty()) { +<a name="674" href="#674">674</a> <strong class="jxr_keyword">continue</strong>; +<a name="675" href="#675">675</a> } +<a name="676" href="#676">676</a> +<a name="677" href="#677">677</a> <em class="jxr_comment">//</em> +<a name="678" href="#678">678</a> +<a name="679" href="#679">679</a> <em class="jxr_comment">// Accumulate any per-metadata provider information</em> +<a name="680" href="#680">680</a> <em class="jxr_comment">// </em> +<a name="681" href="#681">681</a> +<a name="682" href="#682">682</a> Collection<IdPSite> values = <strong class="jxr_keyword">new</strong> TreeSet<IdPSite>(comparator); +<a name="683" href="#683">683</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">null</strong> != theseSites) { +<a name="684" href="#684">684</a> values.addAll(theseSites.values()); +<a name="685" href="#685">685</a> } +<a name="686" href="#686">686</a> +<a name="687" href="#687">687</a> <strong class="jxr_keyword">if</strong> (siteLists != <strong class="jxr_keyword">null</strong>) { +<a name="688" href="#688">688</a> siteLists.add(<strong class="jxr_keyword">new</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/IdPSiteSetEntry.html">IdPSiteSetEntry</a>(metadataProvider,values)); +<a name="689" href="#689">689</a> } +<a name="690" href="#690">690</a> +<a name="691" href="#691">691</a> <strong class="jxr_keyword">if</strong> (sites != <strong class="jxr_keyword">null</strong>) { +<a name="692" href="#692">692</a> sites.addAll(values); +<a name="693" href="#693">693</a> } +<a name="694" href="#694">694</a> +<a name="695" href="#695">695</a> <strong class="jxr_keyword">if</strong> (searchResults != <strong class="jxr_keyword">null</strong>) { +<a name="696" href="#696">696</a> searchResults.addAll(search); +<a name="697" href="#697">697</a> } +<a name="698" href="#698">698</a> } +<a name="699" href="#699">699</a> } +<a name="700" href="#700">700</a> +<a name="701" href="#701">701</a> <strong class="jxr_keyword">if</strong> (isPassive) { +<a name="702" href="#702">702</a> <em class="jxr_comment">//</em> +<a name="703" href="#703">703</a> <em class="jxr_comment">// No GUI intervention.</em> +<a name="704" href="#704">704</a> <em class="jxr_comment">//</em> +<a name="705" href="#705">705</a> <strong class="jxr_keyword">if</strong> (0 != hintList.size()) { +<a name="706" href="#706">706</a> <em class="jxr_comment">//</em> +<a name="707" href="#707">707</a> <em class="jxr_comment">// We found a candidate, hand it back</em> +<a name="708" href="#708">708</a> <em class="jxr_comment">//</em> +<a name="709" href="#709">709</a> forwardRequest(req, res, hintList.get(0)); +<a name="710" href="#710">710</a> } <strong class="jxr_keyword">else</strong> { +<a name="711" href="#711">711</a> forwardRequest(req, res, <strong class="jxr_keyword">null</strong>); +<a name="712" href="#712">712</a> } +<a name="713" href="#713">713</a> <strong class="jxr_keyword">return</strong>; +<a name="714" href="#714">714</a> } +<a name="715" href="#715">715</a> +<a name="716" href="#716">716</a> <em class="jxr_comment">//</em> +<a name="717" href="#717">717</a> <em class="jxr_comment">// Now set up all the funky stuff that the JSP needs. Firstly the protocol</em> +<a name="718" href="#718">718</a> <em class="jxr_comment">// specific parameters which will come back to us</em> +<a name="719" href="#719">719</a> <em class="jxr_comment">//</em> +<a name="720" href="#720">720</a> +<a name="721" href="#721">721</a> <strong class="jxr_keyword">if</strong> (twoZeroProtocol) { +<a name="722" href="#722">722</a> <em class="jxr_comment">//</em> +<a name="723" href="#723">723</a> <em class="jxr_comment">// The return address was set up in setupReturnAddress</em> +<a name="724" href="#724">724</a> <em class="jxr_comment">//</em> +<a name="725" href="#725">725</a> String returnString = (String) req.getAttribute(RETURN_ATTRIBUTE_NAME); +<a name="726" href="#726">726</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">null</strong> == returnString || 0 == returnString.length()) { +<a name="727" href="#727">727</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/WayfException.html">WayfException</a>(<span class="jxr_string">"Parameter "</span> + RETURN_PARAM_NAME + <span class="jxr_string">" not supplied"</span>); +<a name="728" href="#728">728</a> } +<a name="729" href="#729">729</a> +<a name="730" href="#730">730</a> String returnId = getValue(req, RETURNID_PARAM_NAME); +<a name="731" href="#731">731</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">null</strong> == returnId || 0 == returnId.length()) { +<a name="732" href="#732">732</a> returnId = RETURNID_DEFAULT_VALUE; +<a name="733" href="#733">733</a> } +<a name="734" href="#734">734</a> <em class="jxr_comment">//</em> +<a name="735" href="#735">735</a> <em class="jxr_comment">// Return *means* something so we cannot use it as an attribute</em> +<a name="736" href="#736">736</a> <em class="jxr_comment">//</em> +<a name="737" href="#737">737</a> req.setAttribute(RETURN_ATTRIBUTE_NAME, returnString); +<a name="738" href="#738">738</a> req.setAttribute(RETURNID_PARAM_NAME, returnId); +<a name="739" href="#739">739</a> req.setAttribute(ENTITYID_PARAM_NAME, providerId); +<a name="740" href="#740">740</a> +<a name="741" href="#741">741</a> } <strong class="jxr_keyword">else</strong> { +<a name="742" href="#742">742</a> String target = getValue(req, TARGET_PARAM_NAME); +<a name="743" href="#743">743</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">null</strong> == target || 0 == target.length()) { +<a name="744" href="#744">744</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/WayfException.html">WayfException</a>(<span class="jxr_string">"Could not extract target from provided parameters"</span>); +<a name="745" href="#745">745</a> } +<a name="746" href="#746">746</a> req.setAttribute(SHIRE_PARAM_NAME, shire); +<a name="747" href="#747">747</a> req.setAttribute(TARGET_PARAM_NAME, target); +<a name="748" href="#748">748</a> req.setAttribute(PROVIDERID_PARAM_NAME, providerId); +<a name="749" href="#749">749</a> <em class="jxr_comment">//</em> +<a name="750" href="#750">750</a> <em class="jxr_comment">// Time is in unix format</em> +<a name="751" href="#751">751</a> <em class="jxr_comment">//</em> +<a name="752" href="#752">752</a> req.setAttribute(<span class="jxr_string">"time"</span>, <strong class="jxr_keyword">new</strong> Long(<strong class="jxr_keyword">new</strong> Date().getTime() / 1000).toString()); +<a name="753" href="#753">753</a> +<a name="754" href="#754">754</a> } +<a name="755" href="#755">755</a> +<a name="756" href="#756">756</a> <em class="jxr_comment">//</em> +<a name="757" href="#757">757</a> <em class="jxr_comment">// Setup the stuff that the GUI wants. </em> +<a name="758" href="#758">758</a> <em class="jxr_comment">//</em> +<a name="759" href="#759">759</a> +<a name="760" href="#760">760</a> setDisplayLanguage(sites, req); +<a name="761" href="#761">761</a> req.setAttribute(<span class="jxr_string">"sites"</span>, sites); +<a name="762" href="#762">762</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">null</strong> != siteLists) { +<a name="763" href="#763">763</a> <strong class="jxr_keyword">for</strong> (IdPSiteSetEntry siteSetEntry:siteLists) { +<a name="764" href="#764">764</a> setDisplayLanguage(siteSetEntry.getSites(), req); +<a name="765" href="#765">765</a> } +<a name="766" href="#766">766</a> } +<a name="767" href="#767">767</a> +<a name="768" href="#768">768</a> req.setAttribute(<span class="jxr_string">"siteLists"</span>, siteLists); +<a name="769" href="#769">769</a> req.setAttribute(<span class="jxr_string">"requestURL"</span>, req.getRequestURI().toString()); +<a name="770" href="#770">770</a> +<a name="771" href="#771">771</a> <strong class="jxr_keyword">if</strong> (searchResults != <strong class="jxr_keyword">null</strong>) { +<a name="772" href="#772">772</a> <strong class="jxr_keyword">if</strong> (searchResults.size() != 0) { +<a name="773" href="#773">773</a> setDisplayLanguage(searchResults, req); +<a name="774" href="#774">774</a> req.setAttribute(<span class="jxr_string">"searchresults"</span>, searchResults); +<a name="775" href="#775">775</a> } <strong class="jxr_keyword">else</strong> { +<a name="776" href="#776">776</a> req.setAttribute(<span class="jxr_string">"searchResultsEmpty"</span>, <span class="jxr_string">"true"</span>); +<a name="777" href="#777">777</a> } +<a name="778" href="#778">778</a> } +<a name="779" href="#779">779</a> +<a name="780" href="#780">780</a> <strong class="jxr_keyword">if</strong> (hintList.size() > 0) { +<a name="781" href="#781">781</a> setDisplayLanguage(hintList, req); +<a name="782" href="#782">782</a> req.setAttribute(<span class="jxr_string">"cookieList"</span>, hintList); +<a name="783" href="#783">783</a> } +<a name="784" href="#784">784</a> +<a name="785" href="#785">785</a> LOG.debug(<span class="jxr_string">"Displaying WAYF selection page."</span>); +<a name="786" href="#786">786</a> RequestDispatcher rd = req.getRequestDispatcher(config.getJspFile()); +<a name="787" href="#787">787</a> +<a name="788" href="#788">788</a> <em class="jxr_comment">//</em> +<a name="789" href="#789">789</a> <em class="jxr_comment">// And off to the jsp</em> +<a name="790" href="#790">790</a> <em class="jxr_comment">//</em> +<a name="791" href="#791">791</a> rd.forward(req, res); +<a name="792" href="#792">792</a> } <strong class="jxr_keyword">catch</strong> (IOException ioe) { +<a name="793" href="#793">793</a> LOG.error(<span class="jxr_string">"Problem displaying WAYF UI.\n"</span> + ioe.getMessage()); +<a name="794" href="#794">794</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/WayfException.html">WayfException</a>(<span class="jxr_string">"Problem displaying WAYF UI"</span>, ioe); +<a name="795" href="#795">795</a> } <strong class="jxr_keyword">catch</strong> (ServletException se) { +<a name="796" href="#796">796</a> LOG.error(<span class="jxr_string">"Problem displaying WAYF UI.\n"</span> + se.getMessage()); +<a name="797" href="#797">797</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/WayfException.html">WayfException</a>(<span class="jxr_string">"Problem displaying WAYF UI"</span>, se); +<a name="798" href="#798">798</a> } +<a name="799" href="#799">799</a> } +<a name="800" href="#800">800</a> +<a name="801" href="#801">801</a> <em class="jxr_javadoccomment">/**</em> +<a name="802" href="#802">802</a> <em class="jxr_javadoccomment"> * Prior to display we set the display language from the</em> +<a name="803" href="#803">803</a> <em class="jxr_javadoccomment"> * browser. There is probably a proper way to do this using</em> +<a name="804" href="#804">804</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="805" href="#805">805</a> <em class="jxr_javadoccomment"> * @param sites - the sites we need to impact</em> +<a name="806" href="#806">806</a> <em class="jxr_javadoccomment"> * @param req - from whiuch we get the locale</em> +<a name="807" href="#807">807</a> <em class="jxr_javadoccomment"> */</em> +<a name="808" href="#808">808</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> setDisplayLanguage(Collection<IdPSite> sites, HttpServletRequest req) { +<a name="809" href="#809">809</a> +<a name="810" href="#810">810</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">null</strong> == sites) { +<a name="811" href="#811">811</a> <strong class="jxr_keyword">return</strong>; +<a name="812" href="#812">812</a> } +<a name="813" href="#813">813</a> Locale locale = req.getLocale(); +<a name="814" href="#814">814</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">null</strong> == locale) { +<a name="815" href="#815">815</a> Locale.getDefault(); +<a name="816" href="#816">816</a> } +<a name="817" href="#817">817</a> String lang = locale.getLanguage(); +<a name="818" href="#818">818</a> +<a name="819" href="#819">819</a> <strong class="jxr_keyword">for</strong> (IdPSite site : sites) { +<a name="820" href="#820">820</a> site.setDisplayLanguage(lang); +<a name="821" href="#821">821</a> } +<a name="822" href="#822">822</a> } +<a name="823" href="#823">823</a> +<a name="824" href="#824">824</a> +<a name="825" href="#825">825</a> <em class="jxr_javadoccomment">/**</em> +<a name="826" href="#826">826</a> <em class="jxr_javadoccomment"> * Uses an HTTP Status 307 redirect to forward the user to the IdP or the SP.</em> +<a name="827" href="#827">827</a> <em class="jxr_javadoccomment"> * </em> +<a name="828" href="#828">828</a> <em class="jxr_javadoccomment"> * @param req request under consideration</em> +<a name="829" href="#829">829</a> <em class="jxr_javadoccomment"> * @param res response under construction</em> +<a name="830" href="#830">830</a> <em class="jxr_javadoccomment"> * @param site The Idp</em> +<a name="831" href="#831">831</a> <em class="jxr_javadoccomment"> * @throws WayfException if bad things happen.</em> +<a name="832" href="#832">832</a> <em class="jxr_javadoccomment"> */</em> +<a name="833" href="#833">833</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> forwardRequest(HttpServletRequest req, HttpServletResponse res, <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/IdPSite.html">IdPSite</a> site) +<a name="834" href="#834">834</a> <strong class="jxr_keyword">throws</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/WayfException.html">WayfException</a> { +<a name="835" href="#835">835</a> +<a name="836" href="#836">836</a> String shire = getValue(req, SHIRE_PARAM_NAME); +<a name="837" href="#837">837</a> String providerId = getSPId(req); +<a name="838" href="#838">838</a> <strong class="jxr_keyword">boolean</strong> twoZeroProtocol = (shire == <strong class="jxr_keyword">null</strong>); +<a name="839" href="#839">839</a> +<a name="840" href="#840">840</a> <strong class="jxr_keyword">if</strong> (!twoZeroProtocol) { +<a name="841" href="#841">841</a> String handleService = site.getAddressForWAYF(); +<a name="842" href="#842">842</a> <strong class="jxr_keyword">if</strong> (handleService != <strong class="jxr_keyword">null</strong> ) { +<a name="843" href="#843">843</a> +<a name="844" href="#844">844</a> String target = getValue(req, TARGET_PARAM_NAME); +<a name="845" href="#845">845</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">null</strong> == target || 0 == target.length()) { +<a name="846" href="#846">846</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/WayfException.html">WayfException</a>(<span class="jxr_string">"Could not extract target from provided parameters"</span>); +<a name="847" href="#847">847</a> } +<a name="848" href="#848">848</a> +<a name="849" href="#849">849</a> LOG.info(<span class="jxr_string">"Redirecting to selected Handle Service: "</span> + handleService); +<a name="850" href="#850">850</a> <strong class="jxr_keyword">try</strong> { +<a name="851" href="#851">851</a> StringBuffer buffer = <strong class="jxr_keyword">new</strong> StringBuffer(handleService + +<a name="852" href="#852">852</a> <span class="jxr_string">"?"</span> + TARGET_PARAM_NAME + <span class="jxr_string">"="</span>); +<a name="853" href="#853">853</a> buffer.append(URLEncoder.encode(target, <span class="jxr_string">"UTF-8"</span>)); +<a name="854" href="#854">854</a> buffer.append(<span class="jxr_string">"&"</span> + SHIRE_PARAM_NAME + <span class="jxr_string">"="</span>); +<a name="855" href="#855">855</a> buffer.append(URLEncoder.encode(shire, <span class="jxr_string">"UTF-8"</span>)); +<a name="856" href="#856">856</a> buffer.append(<span class="jxr_string">"&"</span> + PROVIDERID_PARAM_NAME + <span class="jxr_string">"="</span>); +<a name="857" href="#857">857</a> buffer.append(URLEncoder.encode(providerId, <span class="jxr_string">"UTF-8"</span>)); +<a name="858" href="#858">858</a> +<a name="859" href="#859">859</a> <em class="jxr_comment">//</em> +<a name="860" href="#860">860</a> <em class="jxr_comment">// Time is as per U**X</em> +<a name="861" href="#861">861</a> <em class="jxr_comment">//</em> +<a name="862" href="#862">862</a> buffer.append(<span class="jxr_string">"&"</span> + TIME_PARAM_NAME + <span class="jxr_string">"="</span>); +<a name="863" href="#863">863</a> buffer.append(<strong class="jxr_keyword">new</strong> Long(<strong class="jxr_keyword">new</strong> Date().getTime() / 1000).toString()); +<a name="864" href="#864">864</a> res.sendRedirect(buffer.toString()); +<a name="865" href="#865">865</a> } <strong class="jxr_keyword">catch</strong> (IOException ioe) { +<a name="866" href="#866">866</a> <em class="jxr_comment">//</em> +<a name="867" href="#867">867</a> <em class="jxr_comment">// That failed. </em> +<a name="868" href="#868">868</a> <em class="jxr_comment">//</em> +<a name="869" href="#869">869</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/WayfException.html">WayfException</a>(<span class="jxr_string">"Error forwarding to IdP: \n"</span> + ioe.getMessage()); +<a name="870" href="#870">870</a> } +<a name="871" href="#871">871</a> } <strong class="jxr_keyword">else</strong> { +<a name="872" href="#872">872</a> String s = <span class="jxr_string">"Error finding to IdP: "</span> + site.getDisplayName(req); +<a name="873" href="#873">873</a> LOG.error(s); +<a name="874" href="#874">874</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/WayfException.html">WayfException</a>(s); +<a name="875" href="#875">875</a> } +<a name="876" href="#876">876</a> } <strong class="jxr_keyword">else</strong> { +<a name="877" href="#877">877</a> String returnUrl = (String) req.getAttribute(RETURN_ATTRIBUTE_NAME); +<a name="878" href="#878">878</a> +<a name="879" href="#879">879</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">null</strong> == returnUrl || 0 == returnUrl.length()) { +<a name="880" href="#880">880</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/WayfException.html">WayfException</a>(<span class="jxr_string">"Could not find return parameter"</span>); +<a name="881" href="#881">881</a> } +<a name="882" href="#882">882</a> <strong class="jxr_keyword">try</strong> { +<a name="883" href="#883">883</a> returnUrl = URLDecoder.decode(returnUrl, <span class="jxr_string">"UTF-8"</span>); +<a name="884" href="#884">884</a> } <strong class="jxr_keyword">catch</strong> (UnsupportedEncodingException e) { +<a name="885" href="#885">885</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/WayfException.html">WayfException</a>(<span class="jxr_string">"Did not understand parameter "</span>, e); +<a name="886" href="#886">886</a> } +<a name="887" href="#887">887</a> String redirect; +<a name="888" href="#888">888</a> <strong class="jxr_keyword">if</strong> (site != <strong class="jxr_keyword">null</strong>) { +<a name="889" href="#889">889</a> StringBuffer buffer = <strong class="jxr_keyword">new</strong> StringBuffer(returnUrl); +<a name="890" href="#890">890</a> <em class="jxr_comment">//</em> +<a name="891" href="#891">891</a> <em class="jxr_comment">// If we were given anybody to lookup, construct the URL</em> +<a name="892" href="#892">892</a> <em class="jxr_comment">//</em> +<a name="893" href="#893">893</a> String returnParam = getValue(req, RETURNID_PARAM_NAME); +<a name="894" href="#894">894</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">null</strong> == returnParam || 0 == returnParam.length()) { +<a name="895" href="#895">895</a> returnParam = RETURNID_DEFAULT_VALUE; +<a name="896" href="#896">896</a> } +<a name="897" href="#897">897</a> <em class="jxr_comment">//</em> +<a name="898" href="#898">898</a> <em class="jxr_comment">// Do we add a '?' or a '&' for the parameters</em> +<a name="899" href="#899">899</a> <em class="jxr_comment">//</em> +<a name="900" href="#900">900</a> +<a name="901" href="#901">901</a> <strong class="jxr_keyword">if</strong> (returnUrl.indexOf('?') >= 0) { +<a name="902" href="#902">902</a> <em class="jxr_comment">//</em> +<a name="903" href="#903">903</a> <em class="jxr_comment">// there is a parameter already. Add a '&'</em> +<a name="904" href="#904">904</a> <em class="jxr_comment">//</em> +<a name="905" href="#905">905</a> buffer.append(<span class="jxr_string">"&"</span> + returnParam + <span class="jxr_string">"="</span>); +<a name="906" href="#906">906</a> } <strong class="jxr_keyword">else</strong> { +<a name="907" href="#907">907</a> <em class="jxr_comment">//</em> +<a name="908" href="#908">908</a> <em class="jxr_comment">// No parameter. Use ?</em> +<a name="909" href="#909">909</a> <em class="jxr_comment">//</em> +<a name="910" href="#910">910</a> buffer.append(<span class="jxr_string">"?"</span> + returnParam + <span class="jxr_string">"="</span>); +<a name="911" href="#911">911</a> } +<a name="912" href="#912">912</a> buffer.append(site.getName()); +<a name="913" href="#913">913</a> redirect = buffer.toString(); +<a name="914" href="#914">914</a> } <strong class="jxr_keyword">else</strong> { +<a name="915" href="#915">915</a> <em class="jxr_comment">//</em> +<a name="916" href="#916">916</a> <em class="jxr_comment">// Just send it back</em> +<a name="917" href="#917">917</a> <em class="jxr_comment">//</em> +<a name="918" href="#918">918</a> redirect = returnUrl; +<a name="919" href="#919">919</a> } +<a name="920" href="#920">920</a> +<a name="921" href="#921">921</a> LOG.debug(<span class="jxr_string">"Dispatching to "</span> + redirect); +<a name="922" href="#922">922</a> +<a name="923" href="#923">923</a> <strong class="jxr_keyword">try</strong> { +<a name="924" href="#924">924</a> res.sendRedirect(redirect); +<a name="925" href="#925">925</a> } <strong class="jxr_keyword">catch</strong> (IOException ioe) { +<a name="926" href="#926">926</a> <em class="jxr_comment">//</em> +<a name="927" href="#927">927</a> <em class="jxr_comment">// That failed. </em> +<a name="928" href="#928">928</a> <em class="jxr_comment">//</em> +<a name="929" href="#929">929</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/WayfException.html">WayfException</a>(<span class="jxr_string">"Error forwarding back to Sp: \n"</span> + ioe.getMessage()); +<a name="930" href="#930">930</a> } +<a name="931" href="#931">931</a> } +<a name="932" href="#932">932</a> } +<a name="933" href="#933">933</a> +<a name="934" href="#934">934</a> <em class="jxr_javadoccomment">/**</em> +<a name="935" href="#935">935</a> <em class="jxr_javadoccomment"> * Handles all "recoverable" errors in WAYF processing by logging the error and forwarding the user to an</em> +<a name="936" href="#936">936</a> <em class="jxr_javadoccomment"> * appropriate error page.</em> +<a name="937" href="#937">937</a> <em class="jxr_javadoccomment"> * </em> +<a name="938" href="#938">938</a> <em class="jxr_javadoccomment"> * @param req request under consideration</em> +<a name="939" href="#939">939</a> <em class="jxr_javadoccomment"> * @param res response under construction</em> +<a name="940" href="#940">940</a> <em class="jxr_javadoccomment"> * @param message - what so say</em> +<a name="941" href="#941">941</a> <em class="jxr_javadoccomment"> */</em> +<a name="942" href="#942">942</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> handleError(HttpServletRequest req, HttpServletResponse res, String message) { +<a name="943" href="#943">943</a> +<a name="944" href="#944">944</a> LOG.debug(<span class="jxr_string">"Displaying WAYF error page."</span>); +<a name="945" href="#945">945</a> req.setAttribute(<span class="jxr_string">"errorText"</span>, message); +<a name="946" href="#946">946</a> req.setAttribute(<span class="jxr_string">"requestURL"</span>, req.getRequestURI().toString()); +<a name="947" href="#947">947</a> RequestDispatcher rd = req.getRequestDispatcher(config.getErrorJspFile()); +<a name="948" href="#948">948</a> +<a name="949" href="#949">949</a> <strong class="jxr_keyword">try</strong> { +<a name="950" href="#950">950</a> rd.forward(req, res); +<a name="951" href="#951">951</a> } <strong class="jxr_keyword">catch</strong> (IOException ioe) { +<a name="952" href="#952">952</a> LOG.error(<span class="jxr_string">"Problem trying to display WAYF error page: "</span> + ioe.toString()); +<a name="953" href="#953">953</a> } <strong class="jxr_keyword">catch</strong> (ServletException se) { +<a name="954" href="#954">954</a> LOG.error(<span class="jxr_string">"Problem trying to display WAYF error page: "</span> + se.toString()); +<a name="955" href="#955">955</a> } +<a name="956" href="#956">956</a> } +<a name="957" href="#957">957</a> +<a name="958" href="#958">958</a> <em class="jxr_javadoccomment">/**</em> +<a name="959" href="#959">959</a> <em class="jxr_javadoccomment"> * Gets the value for the parameter either from the parameter or from jsp.</em> +<a name="960" href="#960">960</a> <em class="jxr_javadoccomment"> * @param req - the request.</em> +<a name="961" href="#961">961</a> <em class="jxr_javadoccomment"> * @param name - the name of the parameter.</em> +<a name="962" href="#962">962</a> <em class="jxr_javadoccomment"> * @return - result</em> +<a name="963" href="#963">963</a> <em class="jxr_javadoccomment"> */</em> +<a name="964" href="#964">964</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> String getValue(HttpServletRequest req, String name) { +<a name="965" href="#965">965</a> +<a name="966" href="#966">966</a> +<a name="967" href="#967">967</a> String value = req.getParameter(name); +<a name="968" href="#968">968</a> <strong class="jxr_keyword">if</strong> (value != <strong class="jxr_keyword">null</strong>) { +<a name="969" href="#969">969</a> <strong class="jxr_keyword">return</strong> value; +<a name="970" href="#970">970</a> } +<a name="971" href="#971">971</a> <strong class="jxr_keyword">return</strong> (String) req.getAttribute(name); +<a name="972" href="#972">972</a> } +<a name="973" href="#973">973</a> +<a name="974" href="#974">974</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> String getSPId(HttpServletRequest req) <strong class="jxr_keyword">throws</strong> WayfException { +<a name="975" href="#975">975</a> +<a name="976" href="#976">976</a> <em class="jxr_comment">//</em> +<a name="977" href="#977">977</a> <em class="jxr_comment">// Try first with 2.0 version</em> +<a name="978" href="#978">978</a> <em class="jxr_comment">//</em> +<a name="979" href="#979">979</a> String param = req.getParameter(ENTITYID_PARAM_NAME); +<a name="980" href="#980">980</a> <strong class="jxr_keyword">if</strong> (param != <strong class="jxr_keyword">null</strong> && !(param.length() == 0)) { +<a name="981" href="#981">981</a> <strong class="jxr_keyword">return</strong> param; +<a name="982" href="#982">982</a> } +<a name="983" href="#983">983</a> +<a name="984" href="#984">984</a> param = (String) req.getAttribute(ENTITYID_PARAM_NAME); +<a name="985" href="#985">985</a> <strong class="jxr_keyword">if</strong> (param != <strong class="jxr_keyword">null</strong> && !(param.length() == 0)) { +<a name="986" href="#986">986</a> <strong class="jxr_keyword">return</strong> param; +<a name="987" href="#987">987</a> } +<a name="988" href="#988">988</a> <em class="jxr_comment">//</em> +<a name="989" href="#989">989</a> <em class="jxr_comment">// So Try with 1.3 version</em> +<a name="990" href="#990">990</a> <em class="jxr_comment">//</em> +<a name="991" href="#991">991</a> param = req.getParameter(PROVIDERID_PARAM_NAME); +<a name="992" href="#992">992</a> <strong class="jxr_keyword">if</strong> (param != <strong class="jxr_keyword">null</strong> && !(param.length() == 0)) { +<a name="993" href="#993">993</a> <strong class="jxr_keyword">return</strong> param; +<a name="994" href="#994">994</a> } +<a name="995" href="#995">995</a> +<a name="996" href="#996">996</a> param = (String) req.getAttribute(PROVIDERID_PARAM_NAME); +<a name="997" href="#997">997</a> <strong class="jxr_keyword">if</strong> (param != <strong class="jxr_keyword">null</strong> && !(param.length() == 0)) { +<a name="998" href="#998">998</a> <strong class="jxr_keyword">return</strong> param; +<a name="999" href="#999">999</a> } +<a name="1000" href="#1000">1000</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/WayfException.html">WayfException</a>(<span class="jxr_string">"Could not locate SP identifier in parameters"</span>); +<a name="1001" href="#1001">1001</a> } +<a name="1002" href="#1002">1002</a> } +</pre> +<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> +</html> + 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> + 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> + diff --git a/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/IdPSiteSet.html b/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/IdPSiteSet.html new file mode 100644 index 0000000..af6f827 --- /dev/null +++ b/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/IdPSiteSet.html @@ -0,0 +1,577 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US"> +<head> +<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /> +<title>IdPSiteSet xref</title> +<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> +</head> +<body> +<div id="overview"><a href="../../../../../../apidocs/edu/internet2/middleware/shibboleth/wayf/IdPSiteSet.html">View Javadoc</a></div><pre> + +<a name="1" href="#1">1</a> <em class="jxr_comment">/*</em> +<a name="2" href="#2">2</a> <em class="jxr_comment"> * Copyright [2005] [University Corporation for Advanced Internet Development, Inc.]</em> +<a name="3" href="#3">3</a> <em class="jxr_comment"> *</em> +<a name="4" href="#4">4</a> <em class="jxr_comment"> * Licensed under the Apache License, Version 2.0 (the "License");</em> +<a name="5" href="#5">5</a> <em class="jxr_comment"> * you may not use this file except in compliance with the License.</em> +<a name="6" href="#6">6</a> <em class="jxr_comment"> * You may obtain a copy of the License at</em> +<a name="7" href="#7">7</a> <em class="jxr_comment"> *</em> +<a name="8" href="#8">8</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em> +<a name="9" href="#9">9</a> <em class="jxr_comment"> *</em> +<a name="10" href="#10">10</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, software</em> +<a name="11" href="#11">11</a> <em class="jxr_comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em> +<a name="12" href="#12">12</a> <em class="jxr_comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em> +<a name="13" href="#13">13</a> <em class="jxr_comment"> * See the License for the specific language governing permissions and</em> +<a name="14" href="#14">14</a> <em class="jxr_comment"> * limitations under the License.</em> +<a name="15" href="#15">15</a> <em class="jxr_comment"> */</em> +<a name="16" href="#16">16</a> <strong class="jxr_keyword">package</strong> edu.internet2.middleware.shibboleth.wayf; +<a name="17" href="#17">17</a> +<a name="18" href="#18">18</a> <strong class="jxr_keyword">import</strong> java.io.File; +<a name="19" href="#19">19</a> <strong class="jxr_keyword">import</strong> java.lang.reflect.Constructor; +<a name="20" href="#20">20</a> <strong class="jxr_keyword">import</strong> java.net.MalformedURLException; +<a name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> java.net.URL; +<a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> java.util.ArrayList; +<a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> java.util.Collection; +<a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> java.util.Enumeration; +<a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> java.util.HashMap; +<a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> java.util.HashSet; +<a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> java.util.List; +<a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> java.util.Map; +<a name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> java.util.Set; +<a name="30" href="#30">30</a> <strong class="jxr_keyword">import</strong> java.util.StringTokenizer; +<a name="31" href="#31">31</a> <strong class="jxr_keyword">import</strong> java.util.TreeMap; +<a name="32" href="#32">32</a> +<a name="33" href="#33">33</a> <strong class="jxr_keyword">import</strong> org.opensaml.saml2.metadata.EntitiesDescriptor; +<a name="34" href="#34">34</a> <strong class="jxr_keyword">import</strong> org.opensaml.saml2.metadata.EntityDescriptor; +<a name="35" href="#35">35</a> <strong class="jxr_keyword">import</strong> org.opensaml.saml2.metadata.IDPSSODescriptor; +<a name="36" href="#36">36</a> <strong class="jxr_keyword">import</strong> org.opensaml.saml2.metadata.Organization; +<a name="37" href="#37">37</a> <strong class="jxr_keyword">import</strong> org.opensaml.saml2.metadata.OrganizationDisplayName; +<a name="38" href="#38">38</a> <strong class="jxr_keyword">import</strong> org.opensaml.saml2.metadata.OrganizationName; +<a name="39" href="#39">39</a> <strong class="jxr_keyword">import</strong> org.opensaml.saml2.metadata.RoleDescriptor; +<a name="40" href="#40">40</a> <strong class="jxr_keyword">import</strong> org.opensaml.saml2.metadata.SPSSODescriptor; +<a name="41" href="#41">41</a> <strong class="jxr_keyword">import</strong> org.opensaml.saml2.metadata.provider.FileBackedHTTPMetadataProvider; +<a name="42" href="#42">42</a> <strong class="jxr_keyword">import</strong> org.opensaml.saml2.metadata.provider.FilesystemMetadataProvider; +<a name="43" href="#43">43</a> <strong class="jxr_keyword">import</strong> org.opensaml.saml2.metadata.provider.MetadataFilter; +<a name="44" href="#44">44</a> <strong class="jxr_keyword">import</strong> org.opensaml.saml2.metadata.provider.MetadataFilterChain; +<a name="45" href="#45">45</a> <strong class="jxr_keyword">import</strong> org.opensaml.saml2.metadata.provider.MetadataProvider; +<a name="46" href="#46">46</a> <strong class="jxr_keyword">import</strong> org.opensaml.saml2.metadata.provider.MetadataProviderException; +<a name="47" href="#47">47</a> <strong class="jxr_keyword">import</strong> org.opensaml.saml2.metadata.provider.ObservableMetadataProvider; +<a name="48" href="#48">48</a> <strong class="jxr_keyword">import</strong> org.opensaml.xml.XMLObject; +<a name="49" href="#49">49</a> <strong class="jxr_keyword">import</strong> org.opensaml.xml.parse.ParserPool; +<a name="50" href="#50">50</a> <strong class="jxr_keyword">import</strong> org.slf4j.Logger; +<a name="51" href="#51">51</a> <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory; +<a name="52" href="#52">52</a> <strong class="jxr_keyword">import</strong> org.w3c.dom.Element; +<a name="53" href="#53">53</a> <strong class="jxr_keyword">import</strong> org.w3c.dom.NodeList; +<a name="54" href="#54">54</a> +<a name="55" href="#55">55</a> <strong class="jxr_keyword">import</strong> edu.internet2.middleware.shibboleth.common.ShibbolethConfigurationException; +<a name="56" href="#56">56</a> <strong class="jxr_keyword">import</strong> edu.internet2.middleware.shibboleth.wayf.plugins.Plugin; +<a name="57" href="#57">57</a> <strong class="jxr_keyword">import</strong> edu.internet2.middleware.shibboleth.wayf.plugins.PluginMetadataParameter; +<a name="58" href="#58">58</a> <strong class="jxr_keyword">import</strong> edu.internet2.middleware.shibboleth.wayf.plugins.provider.BindingFilter; +<a name="59" href="#59">59</a> +<a name="60" href="#60">60</a> <em class="jxr_javadoccomment">/**</em> +<a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * </em> +<a name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * Represents a collection of related sites as desribed by a single soirce of metadata. </em> +<a name="63" href="#63">63</a> <em class="jxr_javadoccomment"> * This is usually a federation. When the WAYF looks to see which IdP sites to show, </em> +<a name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * it trims the list so as to not show IdP's which do not trust the SP.</em> +<a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> *</em> +<a name="66" href="#66">66</a> <em class="jxr_javadoccomment"> * This class is opaque outside this file. The three static methods getSitesLists,</em> +<a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> * searchForMatchingOrigins and lookupIdP provide mechansims for accessing </em> +<a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> * collections of IdPSiteSets.</em> +<a name="69" href="#69">69</a> <em class="jxr_javadoccomment"> * </em> +<a name="70" href="#70">70</a> <em class="jxr_javadoccomment"> */</em> +<a name="71" href="#71">71</a> +<a name="72" href="#72">72</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/IdPSiteSet.html">IdPSiteSet</a> implements ObservableMetadataProvider.Observer { +<a name="73" href="#73">73</a> +<a name="74" href="#74">74</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Handle for error output. */</em> +<a name="75" href="#75">75</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Logger LOG = LoggerFactory.getLogger(IdPSiteSet.<strong class="jxr_keyword">class</strong>.getName()); +<a name="76" href="#76">76</a> +<a name="77" href="#77">77</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> The OpenSaml metadat6a source. */</em> +<a name="78" href="#78">78</a> <strong class="jxr_keyword">private</strong> ObservableMetadataProvider metadata; +<a name="79" href="#79">79</a> +<a name="80" href="#80">80</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Is the named SP in the current metadata set? */</em> +<a name="81" href="#81">81</a> <strong class="jxr_keyword">private</strong> Set<String> spNames = <strong class="jxr_keyword">new</strong> HashSet<String>(0); +<a name="82" href="#82">82</a> +<a name="83" href="#83">83</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Is the named IdP in the current metadata set? */</em> +<a name="84" href="#84">84</a> <strong class="jxr_keyword">private</strong> Set<String> idpNames = <strong class="jxr_keyword">new</strong> HashSet<String>(0); +<a name="85" href="#85">85</a> +<a name="86" href="#86">86</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> What does the configuration identify this as? */</em> +<a name="87" href="#87">87</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> String identifier; +<a name="88" href="#88">88</a> +<a name="89" href="#89">89</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> What name should we display for this set of entities? */</em> +<a name="90" href="#90">90</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> String displayName; +<a name="91" href="#91">91</a> +<a name="92" href="#92">92</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Where does the metadata exist? */</em> +<a name="93" href="#93">93</a> <strong class="jxr_keyword">private</strong> String location; +<a name="94" href="#94">94</a> +<a name="95" href="#95">95</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> What parameters do we pass in to which plugin? */</em> +<a name="96" href="#96">96</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> Map<Plugin, PluginMetadataParameter> plugins = <strong class="jxr_keyword">new</strong> HashMap<Plugin, PluginMetadataParameter>(); +<a name="97" href="#97">97</a> +<a name="98" href="#98">98</a> <em class="jxr_javadoccomment">/**</em> +<a name="99" href="#99">99</a> <em class="jxr_javadoccomment"> * Create a new IdPSiteSet as described by the supplied XML segment. </em> +<a name="100" href="#100">100</a> <em class="jxr_javadoccomment"> * @param el - configuration details.</em> +<a name="101" href="#101">101</a> <em class="jxr_javadoccomment"> * @param parserPool - the parsers we initialized above.</em> +<a name="102" href="#102">102</a> <em class="jxr_javadoccomment"> * @param warnOnBadBinding if we just warn or give an error if an SP has bad entry points.</em> +<a name="103" href="#103">103</a> <em class="jxr_javadoccomment"> * @throws ShibbolethConfigurationException - if something goes wrong.</em> +<a name="104" href="#104">104</a> <em class="jxr_javadoccomment"> */</em> +<a name="105" href="#105">105</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/IdPSiteSet.html">IdPSiteSet</a>(Element el, ParserPool parserPool, <strong class="jxr_keyword">boolean</strong> warnOnBadBinding) <strong class="jxr_keyword">throws</strong> ShibbolethConfigurationException { +<a name="106" href="#106">106</a> +<a name="107" href="#107">107</a> String spoolSpace; +<a name="108" href="#108">108</a> String delayString; +<a name="109" href="#109">109</a> +<a name="110" href="#110">110</a> <strong class="jxr_keyword">this</strong>.identifier = el.getAttribute(<span class="jxr_string">"identifier"</span>); +<a name="111" href="#111">111</a> <strong class="jxr_keyword">this</strong>.displayName = el.getAttribute(<span class="jxr_string">"displayName"</span>); +<a name="112" href="#112">112</a> location = el.getAttribute(<span class="jxr_string">"url"</span>); +<a name="113" href="#113">113</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">null</strong> == location || location.length() == 0) { +<a name="114" href="#114">114</a> <em class="jxr_comment">//</em> +<a name="115" href="#115">115</a> <em class="jxr_comment">// Sigh for a few releases this was documented as URI</em> +<a name="116" href="#116">116</a> <em class="jxr_comment">//</em> +<a name="117" href="#117">117</a> location = el.getAttribute(<span class="jxr_string">"url"</span>); +<a name="118" href="#118">118</a> } +<a name="119" href="#119">119</a> spoolSpace = el.getAttribute(<span class="jxr_string">"backingFile"</span>); +<a name="120" href="#120">120</a> delayString = el.getAttribute(<span class="jxr_string">"timeout"</span>); +<a name="121" href="#121">121</a> +<a name="122" href="#122">122</a> <em class="jxr_comment">//</em> +<a name="123" href="#123">123</a> <em class="jxr_comment">// Configure the filters (before the metadata so we can add them before we start reading)</em> +<a name="124" href="#124">124</a> <em class="jxr_comment">//</em> +<a name="125" href="#125">125</a> String ident; +<a name="126" href="#126">126</a> String className; +<a name="127" href="#127">127</a> ident = <span class="jxr_string">"<not specified>"</span>; +<a name="128" href="#128">128</a> className = <span class="jxr_string">"<not specified>"</span>; +<a name="129" href="#129">129</a> MetadataFilterChain filterChain = <strong class="jxr_keyword">null</strong>; +<a name="130" href="#130">130</a> filterChain = <strong class="jxr_keyword">new</strong> MetadataFilterChain(); +<a name="131" href="#131">131</a> <strong class="jxr_keyword">try</strong> { +<a name="132" href="#132">132</a> NodeList itemElements = el.getElementsByTagNameNS(XMLConstants.CONFIG_NS, <span class="jxr_string">"Filter"</span>); +<a name="133" href="#133">133</a> List <MetadataFilter> filters = <strong class="jxr_keyword">new</strong> ArrayList<MetadataFilter>(1 + itemElements.getLength()); +<a name="134" href="#134">134</a> +<a name="135" href="#135">135</a> <em class="jxr_comment">//</em> +<a name="136" href="#136">136</a> <em class="jxr_comment">// We always have a binding filter</em> +<a name="137" href="#137">137</a> <em class="jxr_comment">//</em> +<a name="138" href="#138">138</a> filters.add(<strong class="jxr_keyword">new</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/provider/BindingFilter.html">BindingFilter</a>(warnOnBadBinding)); +<a name="139" href="#139">139</a> +<a name="140" href="#140">140</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i < itemElements.getLength(); i++) { +<a name="141" href="#141">141</a> Element element = (Element) itemElements.item(i); +<a name="142" href="#142">142</a> +<a name="143" href="#143">143</a> ident = <span class="jxr_string">"<not specified>"</span>; +<a name="144" href="#144">144</a> className = <span class="jxr_string">"<not specified>"</span>; +<a name="145" href="#145">145</a> +<a name="146" href="#146">146</a> ident = element.getAttribute(<span class="jxr_string">"identifier"</span>); +<a name="147" href="#147">147</a> +<a name="148" href="#148">148</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">null</strong> == ident || ident.equals(<span class="jxr_string">""</span>)) { +<a name="149" href="#149">149</a> LOG.error(<span class="jxr_string">"Could not load filter with no identifier"</span>); +<a name="150" href="#150">150</a> <strong class="jxr_keyword">continue</strong>; +<a name="151" href="#151">151</a> } +<a name="152" href="#152">152</a> +<a name="153" href="#153">153</a> className = element.getAttribute(<span class="jxr_string">"type"</span>); +<a name="154" href="#154">154</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">null</strong> == className || className.equals(<span class="jxr_string">""</span>)) { +<a name="155" href="#155">155</a> LOG.error(<span class="jxr_string">"Filter "</span> + identifier + <span class="jxr_string">" did not have a valid type"</span>); +<a name="156" href="#156">156</a> } +<a name="157" href="#157">157</a> <em class="jxr_comment">//</em> +<a name="158" href="#158">158</a> <em class="jxr_comment">// So try to get hold of the Filter</em> +<a name="159" href="#159">159</a> <em class="jxr_comment">//</em> +<a name="160" href="#160">160</a> Class<MetadataFilter> filterClass = (Class<MetadataFilter>) Class.forName(className); +<a name="161" href="#161">161</a> Class[] classParams = {Element.<strong class="jxr_keyword">class</strong>}; +<a name="162" href="#162">162</a> Constructor<MetadataFilter> constructor = filterClass.getConstructor(classParams); +<a name="163" href="#163">163</a> Object[] constructorParams = {element}; +<a name="164" href="#164">164</a> +<a name="165" href="#165">165</a> filters.add(constructor.newInstance(constructorParams)); +<a name="166" href="#166">166</a> } +<a name="167" href="#167">167</a> filterChain.setFilters(filters); +<a name="168" href="#168">168</a> } <strong class="jxr_keyword">catch</strong> (Exception e) { +<a name="169" href="#169">169</a> LOG.error(<span class="jxr_string">"Could not load filter "</span> + ident + <span class="jxr_string">"()"</span> + className + <span class="jxr_string">") for "</span> + <strong class="jxr_keyword">this</strong>.identifier, e); +<a name="170" href="#170">170</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/common/ShibbolethConfigurationException.html">ShibbolethConfigurationException</a>(<span class="jxr_string">"Could not load filter"</span>, e); +<a name="171" href="#171">171</a> } +<a name="172" href="#172">172</a> +<a name="173" href="#173">173</a> LOG.info(<span class="jxr_string">"Loading Metadata for "</span> + displayName); +<a name="174" href="#174">174</a> <strong class="jxr_keyword">try</strong> { +<a name="175" href="#175">175</a> <strong class="jxr_keyword">int</strong> delay; +<a name="176" href="#176">176</a> delay = 30000; +<a name="177" href="#177">177</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">null</strong> != delayString && !<span class="jxr_string">""</span>.equals(delayString)) { +<a name="178" href="#178">178</a> delay = Integer.parseInt(delayString); +<a name="179" href="#179">179</a> } +<a name="180" href="#180">180</a> +<a name="181" href="#181">181</a> URL url = <strong class="jxr_keyword">new</strong> URL(location); +<a name="182" href="#182">182</a> <strong class="jxr_keyword">if</strong> (<span class="jxr_string">"file"</span>.equalsIgnoreCase(url.getProtocol())){ +<a name="183" href="#183">183</a> FilesystemMetadataProvider provider = <strong class="jxr_keyword">new</strong> FilesystemMetadataProvider(<strong class="jxr_keyword">new</strong> File(url.getFile())); +<a name="184" href="#184">184</a> provider.setParserPool(parserPool); +<a name="185" href="#185">185</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">null</strong> != filterChain) { +<a name="186" href="#186">186</a> provider.setMetadataFilter(filterChain); +<a name="187" href="#187">187</a> } +<a name="188" href="#188">188</a> provider.initialize(); +<a name="189" href="#189">189</a> metadata = provider; +<a name="190" href="#190">190</a> } <strong class="jxr_keyword">else</strong> { +<a name="191" href="#191">191</a> <strong class="jxr_keyword">if</strong> (spoolSpace == <strong class="jxr_keyword">null</strong> || <span class="jxr_string">""</span>.equals(spoolSpace)) { +<a name="192" href="#192">192</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/common/ShibbolethConfigurationException.html">ShibbolethConfigurationException</a>(<span class="jxr_string">"backingFile must be specified for "</span> + identifier); +<a name="193" href="#193">193</a> } +<a name="194" href="#194">194</a> +<a name="195" href="#195">195</a> FileBackedHTTPMetadataProvider provider; +<a name="196" href="#196">196</a> +<a name="197" href="#197">197</a> provider = <strong class="jxr_keyword">new</strong> FileBackedHTTPMetadataProvider(location, delay, spoolSpace); +<a name="198" href="#198">198</a> provider.setParserPool(parserPool); +<a name="199" href="#199">199</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">null</strong> != filterChain) { +<a name="200" href="#200">200</a> provider.setMetadataFilter(filterChain); +<a name="201" href="#201">201</a> } +<a name="202" href="#202">202</a> provider.initialize(); +<a name="203" href="#203">203</a> metadata = provider; +<a name="204" href="#204">204</a> } +<a name="205" href="#205">205</a> } <strong class="jxr_keyword">catch</strong> (MetadataProviderException e) { +<a name="206" href="#206">206</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/common/ShibbolethConfigurationException.html">ShibbolethConfigurationException</a>(<span class="jxr_string">"Could not read "</span> + location, e); +<a name="207" href="#207">207</a> } <strong class="jxr_keyword">catch</strong> (NumberFormatException e) { +<a name="208" href="#208">208</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/common/ShibbolethConfigurationException.html">ShibbolethConfigurationException</a>(<span class="jxr_string">"Badly formed timeout "</span> + delayString, e); +<a name="209" href="#209">209</a> } <strong class="jxr_keyword">catch</strong> (MalformedURLException e) { +<a name="210" href="#210">210</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/common/ShibbolethConfigurationException.html">ShibbolethConfigurationException</a>(<span class="jxr_string">"Badly formed url "</span>, e); +<a name="211" href="#211">211</a> } +<a name="212" href="#212">212</a> metadata.getObservers().add(<strong class="jxr_keyword">this</strong>); +<a name="213" href="#213">213</a> onEvent(metadata); +<a name="214" href="#214">214</a> } +<a name="215" href="#215">215</a> +<a name="216" href="#216">216</a> <em class="jxr_javadoccomment">/**</em> +<a name="217" href="#217">217</a> <em class="jxr_javadoccomment"> * Based on 1.2 Origin.isMatch. There must have been a reason for it...</em> +<a name="218" href="#218">218</a> <em class="jxr_javadoccomment"> * [Kindas of] support for the search function in the wayf. This return many false positives</em> +<a name="219" href="#219">219</a> <em class="jxr_javadoccomment"> * but given the aim is to provide input for a pull down list...</em> +<a name="220" href="#220">220</a> <em class="jxr_javadoccomment"> * </em> +<a name="221" href="#221">221</a> <em class="jxr_javadoccomment"> * @param entity The entity to match.</em> +<a name="222" href="#222">222</a> <em class="jxr_javadoccomment"> * @param str The patten to match against.</em> +<a name="223" href="#223">223</a> <em class="jxr_javadoccomment"> * @param config Provides list of tokens to not lookup</em> +<a name="224" href="#224">224</a> <em class="jxr_javadoccomment"> * @return Whether this entity matches </em> +<a name="225" href="#225">225</a> <em class="jxr_javadoccomment"> */</em> +<a name="226" href="#226">226</a> +<a name="227" href="#227">227</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">boolean</strong> isMatch(EntityDescriptor entity, String str, <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/HandlerConfig.html">HandlerConfig</a> config) { +<a name="228" href="#228">228</a> +<a name="229" href="#229">229</a> Enumeration input = <strong class="jxr_keyword">new</strong> StringTokenizer(str); +<a name="230" href="#230">230</a> <strong class="jxr_keyword">while</strong> (input.hasMoreElements()) { +<a name="231" href="#231">231</a> String currentToken = (String) input.nextElement(); +<a name="232" href="#232">232</a> +<a name="233" href="#233">233</a> <strong class="jxr_keyword">if</strong> (config.isIgnoredForMatch(currentToken)) { +<a name="234" href="#234">234</a> <strong class="jxr_keyword">continue</strong>; +<a name="235" href="#235">235</a> } +<a name="236" href="#236">236</a> +<a name="237" href="#237">237</a> currentToken = currentToken.toLowerCase(); +<a name="238" href="#238">238</a> +<a name="239" href="#239">239</a> <strong class="jxr_keyword">if</strong> (entity.getEntityID().indexOf(currentToken) > -1) { +<a name="240" href="#240">240</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>; +<a name="241" href="#241">241</a> } +<a name="242" href="#242">242</a> +<a name="243" href="#243">243</a> Organization org = entity.getOrganization(); +<a name="244" href="#244">244</a> +<a name="245" href="#245">245</a> <strong class="jxr_keyword">if</strong> (org != <strong class="jxr_keyword">null</strong>) { +<a name="246" href="#246">246</a> +<a name="247" href="#247">247</a> List <OrganizationName> orgNames = org.getOrganizationNames(); +<a name="248" href="#248">248</a> <strong class="jxr_keyword">for</strong> (OrganizationName name : orgNames) { +<a name="249" href="#249">249</a> <strong class="jxr_keyword">if</strong> (name.getName().getLocalString().indexOf(currentToken) > -1) { +<a name="250" href="#250">250</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>; +<a name="251" href="#251">251</a> } +<a name="252" href="#252">252</a> } +<a name="253" href="#253">253</a> +<a name="254" href="#254">254</a> List <OrganizationDisplayName> orgDisplayNames = org.getDisplayNames(); +<a name="255" href="#255">255</a> <strong class="jxr_keyword">for</strong> (OrganizationDisplayName name : orgDisplayNames) { +<a name="256" href="#256">256</a> <strong class="jxr_keyword">if</strong> (name.getName().getLocalString().indexOf(currentToken) > -1) { +<a name="257" href="#257">257</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>; +<a name="258" href="#258">258</a> } +<a name="259" href="#259">259</a> } +<a name="260" href="#260">260</a> } +<a name="261" href="#261">261</a> } +<a name="262" href="#262">262</a> <strong class="jxr_keyword">return</strong> false; +<a name="263" href="#263">263</a> } +<a name="264" href="#264">264</a> +<a name="265" href="#265">265</a> <em class="jxr_javadoccomment">/**</em> +<a name="266" href="#266">266</a> <em class="jxr_javadoccomment"> * Return all the Idp in the provided entities descriptor. If SearchMatches</em> +<a name="267" href="#267">267</a> <em class="jxr_javadoccomment"> * is non null it is populated with whatever of the IdPs matches the search string </em> +<a name="268" href="#268">268</a> <em class="jxr_javadoccomment"> * (as noted above). </em> +<a name="269" href="#269">269</a> <em class="jxr_javadoccomment"> * @param searchString to match with</em> +<a name="270" href="#270">270</a> <em class="jxr_javadoccomment"> * @param config parameter to mathing</em> +<a name="271" href="#271">271</a> <em class="jxr_javadoccomment"> * @param searchMatches if non null is filled with such of the sites which match the string</em> +<a name="272" href="#272">272</a> <em class="jxr_javadoccomment"> * @return the sites which fit.</em> +<a name="273" href="#273">273</a> <em class="jxr_javadoccomment"> */</em> +<a name="274" href="#274">274</a> <strong class="jxr_keyword">protected</strong> Map<String, IdPSite> getIdPSites(String searchString, +<a name="275" href="#275">275</a> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/HandlerConfig.html">HandlerConfig</a> config, +<a name="276" href="#276">276</a> Collection<IdPSite> searchMatches) +<a name="277" href="#277">277</a> { +<a name="278" href="#278">278</a> XMLObject object; +<a name="279" href="#279">279</a> List <EntityDescriptor> entities; +<a name="280" href="#280">280</a> <strong class="jxr_keyword">try</strong> { +<a name="281" href="#281">281</a> object = metadata.getMetadata(); +<a name="282" href="#282">282</a> } <strong class="jxr_keyword">catch</strong> (MetadataProviderException e) { +<a name="283" href="#283">283</a> LOG.error(<span class="jxr_string">"Metadata for "</span> + location + <span class="jxr_string">"could not be read"</span>, e); +<a name="284" href="#284">284</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>; +<a name="285" href="#285">285</a> } +<a name="286" href="#286">286</a> +<a name="287" href="#287">287</a> <strong class="jxr_keyword">if</strong> (object == <strong class="jxr_keyword">null</strong>) { +<a name="288" href="#288">288</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>; +<a name="289" href="#289">289</a> } +<a name="290" href="#290">290</a> +<a name="291" href="#291">291</a> <em class="jxr_comment">//</em> +<a name="292" href="#292">292</a> <em class="jxr_comment">// Fill in entities approptiately</em> +<a name="293" href="#293">293</a> <em class="jxr_comment">//</em> +<a name="294" href="#294">294</a> +<a name="295" href="#295">295</a> <strong class="jxr_keyword">if</strong> (object instanceof EntityDescriptor) { +<a name="296" href="#296">296</a> entities = <strong class="jxr_keyword">new</strong> ArrayList<EntityDescriptor>(1); +<a name="297" href="#297">297</a> entities.add((EntityDescriptor) object); +<a name="298" href="#298">298</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (object instanceof EntitiesDescriptor) { +<a name="299" href="#299">299</a> +<a name="300" href="#300">300</a> EntitiesDescriptor entitiesDescriptor = (EntitiesDescriptor) object; +<a name="301" href="#301">301</a> +<a name="302" href="#302">302</a> entities = entitiesDescriptor.getEntityDescriptors(); +<a name="303" href="#303">303</a> } <strong class="jxr_keyword">else</strong> { +<a name="304" href="#304">304</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>; +<a name="305" href="#305">305</a> } +<a name="306" href="#306">306</a> +<a name="307" href="#307">307</a> <em class="jxr_comment">//</em> +<a name="308" href="#308">308</a> <em class="jxr_comment">// populate the result (and the searchlist) from the entities list</em> +<a name="309" href="#309">309</a> <em class="jxr_comment">//</em> +<a name="310" href="#310">310</a> +<a name="311" href="#311">311</a> TreeMap<String, IdPSite> result = <strong class="jxr_keyword">new</strong> TreeMap <String,IdPSite>(); +<a name="312" href="#312">312</a> +<a name="313" href="#313">313</a> <strong class="jxr_keyword">for</strong> (EntityDescriptor entity : entities) { +<a name="314" href="#314">314</a> +<a name="315" href="#315">315</a> <strong class="jxr_keyword">if</strong> (entity.isValid() && hasIdPRole(entity)) { +<a name="316" href="#316">316</a> +<a name="317" href="#317">317</a> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/IdPSite.html">IdPSite</a> site = <strong class="jxr_keyword">new</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/IdPSite.html">IdPSite</a>(entity); +<a name="318" href="#318">318</a> result.put(site.getName(), site); +<a name="319" href="#319">319</a> <strong class="jxr_keyword">if</strong> (searchMatches != <strong class="jxr_keyword">null</strong> && isMatch(entity, searchString, config)) { +<a name="320" href="#320">320</a> +<a name="321" href="#321">321</a> searchMatches.add(site); +<a name="322" href="#322">322</a> } +<a name="323" href="#323">323</a> +<a name="324" href="#324">324</a> } +<a name="325" href="#325">325</a> } <em class="jxr_comment">// iterate over all entities</em> +<a name="326" href="#326">326</a> <strong class="jxr_keyword">return</strong> result; +<a name="327" href="#327">327</a> } +<a name="328" href="#328">328</a> +<a name="329" href="#329">329</a> +<a name="330" href="#330">330</a> <em class="jxr_javadoccomment">/**</em> +<a name="331" href="#331">331</a> <em class="jxr_javadoccomment"> * Return this sites (internal) identifier.</em> +<a name="332" href="#332">332</a> <em class="jxr_javadoccomment"> * @return the identifier</em> +<a name="333" href="#333">333</a> <em class="jxr_javadoccomment"> */</em> +<a name="334" href="#334">334</a> <strong class="jxr_keyword">protected</strong> String getIdentifier() { +<a name="335" href="#335">335</a> <strong class="jxr_keyword">return</strong> identifier; +<a name="336" href="#336">336</a> } +<a name="337" href="#337">337</a> +<a name="338" href="#338">338</a> <em class="jxr_javadoccomment">/**</em> +<a name="339" href="#339">339</a> <em class="jxr_javadoccomment"> * Return the human friendly name for this siteset.</em> +<a name="340" href="#340">340</a> <em class="jxr_javadoccomment"> * @return The friendly name</em> +<a name="341" href="#341">341</a> <em class="jxr_javadoccomment"> */</em> +<a name="342" href="#342">342</a> <strong class="jxr_keyword">protected</strong> String getDisplayName() { +<a name="343" href="#343">343</a> <strong class="jxr_keyword">return</strong> displayName; +<a name="344" href="#344">344</a> } +<a name="345" href="#345">345</a> +<a name="346" href="#346">346</a> <em class="jxr_javadoccomment">/**</em> +<a name="347" href="#347">347</a> <em class="jxr_javadoccomment"> * We do not need to look at a set if it doesn't know about the given SP. However if</em> +<a name="348" href="#348">348</a> <em class="jxr_javadoccomment"> * no SP is given (as per 1.1) then we do need to look. This calls lets us know whether </em> +<a name="349" href="#349">349</a> <em class="jxr_javadoccomment"> * this set is a canddiate for looking into.</em> +<a name="350" href="#350">350</a> <em class="jxr_javadoccomment"> * @param SPName the Sp we are interested in.</em> +<a name="351" href="#351">351</a> <em class="jxr_javadoccomment"> * @return whether the site contains the SP.</em> +<a name="352" href="#352">352</a> <em class="jxr_javadoccomment"> */</em> +<a name="353" href="#353">353</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> containsSP(String SPName) { +<a name="354" href="#354">354</a> +<a name="355" href="#355">355</a> <em class="jxr_comment">//</em> +<a name="356" href="#356">356</a> <em class="jxr_comment">// Deal with the case where we do *not* want to search by</em> +<a name="357" href="#357">357</a> <em class="jxr_comment">// SP (also handles the 1.1 case)</em> +<a name="358" href="#358">358</a> <em class="jxr_comment">//</em> +<a name="359" href="#359">359</a> +<a name="360" href="#360">360</a> <strong class="jxr_keyword">if</strong> ((SPName == <strong class="jxr_keyword">null</strong>) || (SPName.length() == 0)) { +<a name="361" href="#361">361</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>; +<a name="362" href="#362">362</a> } +<a name="363" href="#363">363</a> +<a name="364" href="#364">364</a> <em class="jxr_comment">//</em> +<a name="365" href="#365">365</a> <em class="jxr_comment">// Get hold of the current object list so as to provoke observer to fire </em> +<a name="366" href="#366">366</a> <em class="jxr_comment">// if needs be.</em> +<a name="367" href="#367">367</a> <em class="jxr_comment">// </em> +<a name="368" href="#368">368</a> +<a name="369" href="#369">369</a> XMLObject object; +<a name="370" href="#370">370</a> <strong class="jxr_keyword">try</strong> { +<a name="371" href="#371">371</a> object = metadata.getMetadata(); +<a name="372" href="#372">372</a> } <strong class="jxr_keyword">catch</strong> (MetadataProviderException e) { +<a name="373" href="#373">373</a> <strong class="jxr_keyword">return</strong> false; +<a name="374" href="#374">374</a> } +<a name="375" href="#375">375</a> <em class="jxr_comment">//</em> +<a name="376" href="#376">376</a> <em class="jxr_comment">// Now lookup</em> +<a name="377" href="#377">377</a> <em class="jxr_comment">//</em> +<a name="378" href="#378">378</a> +<a name="379" href="#379">379</a> <strong class="jxr_keyword">if</strong> (object instanceof EntitiesDescriptor || +<a name="380" href="#380">380</a> object instanceof EntityDescriptor) { +<a name="381" href="#381">381</a> <strong class="jxr_keyword">return</strong> spNames.contains(SPName); +<a name="382" href="#382">382</a> } <strong class="jxr_keyword">else</strong> { +<a name="383" href="#383">383</a> <strong class="jxr_keyword">return</strong> false; +<a name="384" href="#384">384</a> } +<a name="385" href="#385">385</a> } +<a name="386" href="#386">386</a> +<a name="387" href="#387">387</a> <em class="jxr_javadoccomment">/**</em> +<a name="388" href="#388">388</a> <em class="jxr_javadoccomment"> * For plugin handling we need to know quickly if a metadataset contains the idp.</em> +<a name="389" href="#389">389</a> <em class="jxr_javadoccomment"> * @param IdPName the IdP we are interested in.</em> +<a name="390" href="#390">390</a> <em class="jxr_javadoccomment"> * @return whether the site contains the IdP.</em> +<a name="391" href="#391">391</a> <em class="jxr_javadoccomment"> * </em> +<a name="392" href="#392">392</a> <em class="jxr_javadoccomment"> */</em> +<a name="393" href="#393">393</a> +<a name="394" href="#394">394</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> containsIdP(String IdPName) { +<a name="395" href="#395">395</a> +<a name="396" href="#396">396</a> <strong class="jxr_keyword">if</strong> ((IdPName == <strong class="jxr_keyword">null</strong>) || (IdPName.length() == 0)) { +<a name="397" href="#397">397</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>; +<a name="398" href="#398">398</a> } +<a name="399" href="#399">399</a> +<a name="400" href="#400">400</a> <em class="jxr_comment">//</em> +<a name="401" href="#401">401</a> <em class="jxr_comment">// Get hold of the current object list so as to provoke observer to fire </em> +<a name="402" href="#402">402</a> <em class="jxr_comment">// if needs be.</em> +<a name="403" href="#403">403</a> <em class="jxr_comment">// </em> +<a name="404" href="#404">404</a> +<a name="405" href="#405">405</a> XMLObject object; +<a name="406" href="#406">406</a> <strong class="jxr_keyword">try</strong> { +<a name="407" href="#407">407</a> object = metadata.getMetadata(); +<a name="408" href="#408">408</a> } <strong class="jxr_keyword">catch</strong> (MetadataProviderException e) { +<a name="409" href="#409">409</a> <strong class="jxr_keyword">return</strong> false; +<a name="410" href="#410">410</a> } +<a name="411" href="#411">411</a> <strong class="jxr_keyword">if</strong> (object instanceof EntitiesDescriptor || +<a name="412" href="#412">412</a> object instanceof EntityDescriptor) { +<a name="413" href="#413">413</a> <strong class="jxr_keyword">return</strong> idpNames.contains(IdPName); +<a name="414" href="#414">414</a> } <strong class="jxr_keyword">else</strong> { +<a name="415" href="#415">415</a> <strong class="jxr_keyword">return</strong> false; +<a name="416" href="#416">416</a> } +<a name="417" href="#417">417</a> } +<a name="418" href="#418">418</a> +<a name="419" href="#419">419</a> <em class="jxr_comment">//</em> +<a name="420" href="#420">420</a> <em class="jxr_comment">// Now deal with plugins - these are delcared to use but we are</em> +<a name="421" href="#421">421</a> <em class="jxr_comment">// responsible for their parameter</em> +<a name="422" href="#422">422</a> <em class="jxr_comment">//</em> +<a name="423" href="#423">423</a> +<a name="424" href="#424">424</a> <em class="jxr_javadoccomment">/**</em> +<a name="425" href="#425">425</a> <em class="jxr_javadoccomment"> * Declares a plugin to the siteset.</em> +<a name="426" href="#426">426</a> <em class="jxr_javadoccomment"> * @param plugin what to declare</em> +<a name="427" href="#427">427</a> <em class="jxr_javadoccomment"> */</em> +<a name="428" href="#428">428</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> addPlugin(<a href="../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/Plugin.html">Plugin</a> plugin) { +<a name="429" href="#429">429</a> +<a name="430" href="#430">430</a> <strong class="jxr_keyword">if</strong> (plugins.containsKey(plugin)) { +<a name="431" href="#431">431</a> <strong class="jxr_keyword">return</strong>; +<a name="432" href="#432">432</a> } +<a name="433" href="#433">433</a> +<a name="434" href="#434">434</a> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/PluginMetadataParameter.html">PluginMetadataParameter</a> param = plugin.refreshMetadata(metadata); +<a name="435" href="#435">435</a> +<a name="436" href="#436">436</a> plugins.put(plugin, param); +<a name="437" href="#437">437</a> } +<a name="438" href="#438">438</a> +<a name="439" href="#439">439</a> <em class="jxr_javadoccomment">/**</em> +<a name="440" href="#440">440</a> <em class="jxr_javadoccomment"> * Return the parameter that this plugin uses.</em> +<a name="441" href="#441">441</a> <em class="jxr_javadoccomment"> * @param plugin</em> +<a name="442" href="#442">442</a> <em class="jxr_javadoccomment"> * @return teh parameter.</em> +<a name="443" href="#443">443</a> <em class="jxr_javadoccomment"> */</em> +<a name="444" href="#444">444</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/PluginMetadataParameter.html">PluginMetadataParameter</a> paramFor(<a href="../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/Plugin.html">Plugin</a> plugin) { +<a name="445" href="#445">445</a> <strong class="jxr_keyword">return</strong> plugins.get(plugin); +<a name="446" href="#446">446</a> } +<a name="447" href="#447">447</a> +<a name="448" href="#448">448</a> +<a name="449" href="#449">449</a> <em class="jxr_comment">/*<em class="jxr_comment"> (non-Javadoc)</em></em> +<a name="450" href="#450">450</a> <em class="jxr_comment"> * @see org.opensaml.saml2.metadata.provider.ObservableMetadataProvider.Observer#onEvent(org.opensaml.saml2.metadata.provider.MetadataProvider)</em> +<a name="451" href="#451">451</a> <em class="jxr_comment"> */</em> +<a name="452" href="#452">452</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> onEvent(MetadataProvider provider) { +<a name="453" href="#453">453</a> Set<String> spNameSet = <strong class="jxr_keyword">new</strong> HashSet<String>(0); +<a name="454" href="#454">454</a> Set<String> idpNameSet = <strong class="jxr_keyword">new</strong> HashSet<String>(0); +<a name="455" href="#455">455</a> +<a name="456" href="#456">456</a> XMLObject obj; +<a name="457" href="#457">457</a> <strong class="jxr_keyword">try</strong> { +<a name="458" href="#458">458</a> obj = provider.getMetadata(); +<a name="459" href="#459">459</a> } <strong class="jxr_keyword">catch</strong> (MetadataProviderException e) { +<a name="460" href="#460">460</a> LOG.error(<span class="jxr_string">"Couldn't read metadata for "</span> + location, e); +<a name="461" href="#461">461</a> <strong class="jxr_keyword">return</strong>; +<a name="462" href="#462">462</a> } +<a name="463" href="#463">463</a> <strong class="jxr_keyword">if</strong> ((obj instanceof EntitiesDescriptor)) { +<a name="464" href="#464">464</a> EntitiesDescriptor entitiesDescriptor = (EntitiesDescriptor) obj; +<a name="465" href="#465">465</a> +<a name="466" href="#466">466</a> <strong class="jxr_keyword">for</strong> (EntityDescriptor entity : entitiesDescriptor.getEntityDescriptors()) { +<a name="467" href="#467">467</a> <strong class="jxr_keyword">if</strong> (hasSPRole(entity)) { +<a name="468" href="#468">468</a> spNameSet.add(entity.getEntityID()); +<a name="469" href="#469">469</a> } +<a name="470" href="#470">470</a> <strong class="jxr_keyword">if</strong> (hasIdPRole(entity)) { +<a name="471" href="#471">471</a> idpNameSet.add(entity.getEntityID()); +<a name="472" href="#472">472</a> } +<a name="473" href="#473">473</a> } +<a name="474" href="#474">474</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (obj instanceof EntityDescriptor) { +<a name="475" href="#475">475</a> EntityDescriptor entity = (EntityDescriptor) obj; +<a name="476" href="#476">476</a> <strong class="jxr_keyword">if</strong> (hasSPRole(entity)) { +<a name="477" href="#477">477</a> spNameSet.add(entity.getEntityID()); +<a name="478" href="#478">478</a> } +<a name="479" href="#479">479</a> <strong class="jxr_keyword">if</strong> (hasIdPRole(entity)) { +<a name="480" href="#480">480</a> idpNameSet.add(entity.getEntityID()); +<a name="481" href="#481">481</a> } +<a name="482" href="#482">482</a> } <strong class="jxr_keyword">else</strong> { +<a name="483" href="#483">483</a> LOG.error(<span class="jxr_string">"Metadata for "</span> + location + <span class="jxr_string">" isn't <EntitiesDescriptor> or <EntityDescriptor>"</span>); +<a name="484" href="#484">484</a> <strong class="jxr_keyword">return</strong>; +<a name="485" href="#485">485</a> } +<a name="486" href="#486">486</a> <em class="jxr_comment">//</em> +<a name="487" href="#487">487</a> <em class="jxr_comment">// Now that we have the new set sorted out commit it in</em> +<a name="488" href="#488">488</a> <em class="jxr_comment">//</em> +<a name="489" href="#489">489</a> <strong class="jxr_keyword">this</strong>.spNames = spNameSet; +<a name="490" href="#490">490</a> <strong class="jxr_keyword">this</strong>.idpNames = idpNameSet; +<a name="491" href="#491">491</a> +<a name="492" href="#492">492</a> <strong class="jxr_keyword">for</strong> (Plugin plugin:plugins.keySet()) { +<a name="493" href="#493">493</a> plugins.put(plugin, plugin.refreshMetadata(provider)); +<a name="494" href="#494">494</a> } +<a name="495" href="#495">495</a> } +<a name="496" href="#496">496</a> +<a name="497" href="#497">497</a> <em class="jxr_javadoccomment">/**</em> +<a name="498" href="#498">498</a> <em class="jxr_javadoccomment"> * Enumerate all the roles and see whether this entity can be an IdP.</em> +<a name="499" href="#499">499</a> <em class="jxr_javadoccomment"> * @param entity</em> +<a name="500" href="#500">500</a> <em class="jxr_javadoccomment"> * @return true if one of the roles that entity has is IdPSSO</em> +<a name="501" href="#501">501</a> <em class="jxr_javadoccomment"> */</em> +<a name="502" href="#502">502</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">boolean</strong> hasIdPRole(EntityDescriptor entity) { +<a name="503" href="#503">503</a> List<RoleDescriptor> roles = entity.getRoleDescriptors(); +<a name="504" href="#504">504</a> +<a name="505" href="#505">505</a> <strong class="jxr_keyword">for</strong> (RoleDescriptor role:roles) { +<a name="506" href="#506">506</a> <strong class="jxr_keyword">if</strong> (role instanceof IDPSSODescriptor) { +<a name="507" href="#507">507</a> <em class="jxr_comment">//</em> +<a name="508" href="#508">508</a> <em class="jxr_comment">// So the entity knows how to be some sort of an Idp</em> +<a name="509" href="#509">509</a> <em class="jxr_comment">//</em> +<a name="510" href="#510">510</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>; +<a name="511" href="#511">511</a> } +<a name="512" href="#512">512</a> } +<a name="513" href="#513">513</a> <strong class="jxr_keyword">return</strong> false; +<a name="514" href="#514">514</a> } +<a name="515" href="#515">515</a> +<a name="516" href="#516">516</a> <em class="jxr_javadoccomment">/**</em> +<a name="517" href="#517">517</a> <em class="jxr_javadoccomment"> * Enumerate all the roles and see whether this entity can be an SP.</em> +<a name="518" href="#518">518</a> <em class="jxr_javadoccomment"> * @param entity</em> +<a name="519" href="#519">519</a> <em class="jxr_javadoccomment"> * @return true if one of the roles that entity has is SPSSO</em> +<a name="520" href="#520">520</a> <em class="jxr_javadoccomment"> */</em> +<a name="521" href="#521">521</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">boolean</strong> hasSPRole(EntityDescriptor entity) { +<a name="522" href="#522">522</a> List<RoleDescriptor> roles = entity.getRoleDescriptors(); +<a name="523" href="#523">523</a> +<a name="524" href="#524">524</a> <strong class="jxr_keyword">for</strong> (RoleDescriptor role:roles) { +<a name="525" href="#525">525</a> <strong class="jxr_keyword">if</strong> (role instanceof SPSSODescriptor) { +<a name="526" href="#526">526</a> <em class="jxr_comment">//</em> +<a name="527" href="#527">527</a> <em class="jxr_comment">// "I can do that"</em> +<a name="528" href="#528">528</a> <em class="jxr_comment">//</em> +<a name="529" href="#529">529</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>; +<a name="530" href="#530">530</a> } +<a name="531" href="#531">531</a> } +<a name="532" href="#532">532</a> <strong class="jxr_keyword">return</strong> false; +<a name="533" href="#533">533</a> } +<a name="534" href="#534">534</a> +<a name="535" href="#535">535</a> <em class="jxr_javadoccomment">/**</em> +<a name="536" href="#536">536</a> <em class="jxr_javadoccomment"> * Return the idpSite for the given entity name.</em> +<a name="537" href="#537">537</a> <em class="jxr_javadoccomment"> * @param idpName the entityname to look up</em> +<a name="538" href="#538">538</a> <em class="jxr_javadoccomment"> * @return the associated idpSite</em> +<a name="539" href="#539">539</a> <em class="jxr_javadoccomment"> * @throws WayfException</em> +<a name="540" href="#540">540</a> <em class="jxr_javadoccomment"> */</em> +<a name="541" href="#541">541</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/IdPSite.html">IdPSite</a> getSite(String idpName) <strong class="jxr_keyword">throws</strong> WayfException { +<a name="542" href="#542">542</a> +<a name="543" href="#543">543</a> <strong class="jxr_keyword">try</strong> { +<a name="544" href="#544">544</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/IdPSite.html">IdPSite</a>(metadata.getEntityDescriptor(idpName)); +<a name="545" href="#545">545</a> } <strong class="jxr_keyword">catch</strong> (MetadataProviderException e) { +<a name="546" href="#546">546</a> String s = <span class="jxr_string">"Couldn't resolve "</span> + idpName + <span class="jxr_string">" in "</span> + getDisplayName(); +<a name="547" href="#547">547</a> LOG.error(s, e); +<a name="548" href="#548">548</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/WayfException.html">WayfException</a>(s, e); +<a name="549" href="#549">549</a> } +<a name="550" href="#550">550</a> } +<a name="551" href="#551">551</a> +<a name="552" href="#552">552</a> <strong class="jxr_keyword">protected</strong> EntityDescriptor getEntity(String name) <strong class="jxr_keyword">throws</strong> WayfException { +<a name="553" href="#553">553</a> <strong class="jxr_keyword">try</strong> { +<a name="554" href="#554">554</a> <strong class="jxr_keyword">return</strong> metadata.getEntityDescriptor(name); +<a name="555" href="#555">555</a> } <strong class="jxr_keyword">catch</strong> (MetadataProviderException e) { +<a name="556" href="#556">556</a> String s = <span class="jxr_string">"Couldn't resolve "</span> + name + <span class="jxr_string">" in "</span> + getDisplayName(); +<a name="557" href="#557">557</a> LOG.error(s, e); +<a name="558" href="#558">558</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/WayfException.html">WayfException</a>(s, e); +<a name="559" href="#559">559</a> } +<a name="560" href="#560">560</a> +<a name="561" href="#561">561</a> } +<a name="562" href="#562">562</a> } +<a name="563" href="#563">563</a> +</pre> +<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> +</html> + diff --git a/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/IdPSiteSetEntry.html b/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/IdPSiteSetEntry.html new file mode 100644 index 0000000..cc3ae38 --- /dev/null +++ b/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/IdPSiteSetEntry.html @@ -0,0 +1,71 @@ +<!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>IdPSiteSetEntry xref</title> +<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> +</head> +<body> +<div id="overview"><a href="../../../../../../apidocs/edu/internet2/middleware/shibboleth/wayf/IdPSiteSetEntry.html">View Javadoc</a></div><pre> + +<a name="1" href="#1">1</a> <em class="jxr_comment">/*</em> +<a name="2" href="#2">2</a> <em class="jxr_comment"> * Copyright [2005] [University Corporation for Advanced Internet Development, Inc.]</em> +<a name="3" href="#3">3</a> <em class="jxr_comment"> *</em> +<a name="4" href="#4">4</a> <em class="jxr_comment"> * Licensed under the Apache License, Version 2.0 (the "License");</em> +<a name="5" href="#5">5</a> <em class="jxr_comment"> * you may not use this file except in compliance with the License.</em> +<a name="6" href="#6">6</a> <em class="jxr_comment"> * You may obtain a copy of the License at</em> +<a name="7" href="#7">7</a> <em class="jxr_comment"> *</em> +<a name="8" href="#8">8</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em> +<a name="9" href="#9">9</a> <em class="jxr_comment"> *</em> +<a name="10" href="#10">10</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, software</em> +<a name="11" href="#11">11</a> <em class="jxr_comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em> +<a name="12" href="#12">12</a> <em class="jxr_comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em> +<a name="13" href="#13">13</a> <em class="jxr_comment"> * See the License for the specific language governing permissions and</em> +<a name="14" href="#14">14</a> <em class="jxr_comment"> * limitations under the License.</em> +<a name="15" href="#15">15</a> <em class="jxr_comment"> */</em> +<a name="16" href="#16">16</a> <strong class="jxr_keyword">package</strong> edu.internet2.middleware.shibboleth.wayf; +<a name="17" href="#17">17</a> +<a name="18" href="#18">18</a> <strong class="jxr_keyword">import</strong> java.util.Collection; +<a name="19" href="#19">19</a> <em class="jxr_javadoccomment">/**</em> +<a name="20" href="#20">20</a> <em class="jxr_javadoccomment"> * This is just a container class for tieing together a set of IdPs to a name - this being what</em> +<a name="21" href="#21">21</a> <em class="jxr_javadoccomment"> * is sent to the JSP for display purposes.</em> +<a name="22" href="#22">22</a> <em class="jxr_javadoccomment"> */</em> +<a name="23" href="#23">23</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/IdPSiteSetEntry.html">IdPSiteSetEntry</a> { +<a name="24" href="#24">24</a> +<a name="25" href="#25">25</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> The metadata provider. */</em> +<a name="26" href="#26">26</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/IdPSiteSet.html">IdPSiteSet</a> siteSet; +<a name="27" href="#27">27</a> +<a name="28" href="#28">28</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> The IdPs associated with that metadata provider. */</em> +<a name="29" href="#29">29</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> Collection<IdPSite> sites; +<a name="30" href="#30">30</a> +<a name="31" href="#31">31</a> <em class="jxr_javadoccomment">/**</em> +<a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * Create an object which contains just these two objects.</em> +<a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * @param siteSetParam the metadata provider.</em> +<a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * @param sitesParam the list of IdPs. </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> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/IdPSiteSetEntry.html">IdPSiteSetEntry</a>(<a href="../../../../../edu/internet2/middleware/shibboleth/wayf/IdPSiteSet.html">IdPSiteSet</a> siteSetParam, Collection<IdPSite> sitesParam) { +<a name="37" href="#37">37</a> <strong class="jxr_keyword">this</strong>.siteSet = siteSetParam; +<a name="38" href="#38">38</a> <strong class="jxr_keyword">this</strong>.sites = sitesParam; +<a name="39" href="#39">39</a> } +<a name="40" href="#40">40</a> +<a name="41" href="#41">41</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> </em> +<a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * Return something to display for this set of sites. </em> +<a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * @return the name as defined in the configuration</em> +<a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> */</em> +<a name="45" href="#45">45</a> <strong class="jxr_keyword">public</strong> String getName() { +<a name="46" href="#46">46</a> <strong class="jxr_keyword">return</strong> siteSet.getDisplayName(); +<a name="47" href="#47">47</a> } +<a name="48" href="#48">48</a> +<a name="49" href="#49">49</a> <em class="jxr_javadoccomment">/**</em> +<a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * Return the list of associated sites. </em> +<a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * @return a collection of IdPs.</em> +<a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> */</em> +<a name="53" href="#53">53</a> <strong class="jxr_keyword">public</strong> Collection<IdPSite> getSites() { +<a name="54" href="#54">54</a> <strong class="jxr_keyword">return</strong> sites; +<a name="55" href="#55">55</a> } +<a name="56" href="#56">56</a> +<a name="57" href="#57">57</a> } +</pre> +<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> +</html> + diff --git a/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/LogbackConfigurationChangeListener.html b/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/LogbackConfigurationChangeListener.html new file mode 100644 index 0000000..e4560ba --- /dev/null +++ b/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/LogbackConfigurationChangeListener.html @@ -0,0 +1,86 @@ +<!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>LogbackConfigurationChangeListener xref</title> +<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> +</head> +<body> +<div id="overview"><a href="../../../../../../apidocs/edu/internet2/middleware/shibboleth/wayf/LogbackConfigurationChangeListener.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 [2007] [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> org.opensaml.util.resource.Resource; +<a name="20" href="#20">20</a> <strong class="jxr_keyword">import</strong> org.opensaml.util.resource.ResourceChangeListener; +<a name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> org.opensaml.util.resource.ResourceException; +<a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory; +<a name="23" href="#23">23</a> +<a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> ch.qos.logback.classic.LoggerContext; +<a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> ch.qos.logback.classic.joran.JoranConfigurator; +<a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> ch.qos.logback.core.joran.spi.JoranException; +<a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> ch.qos.logback.core.status.ErrorStatus; +<a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> ch.qos.logback.core.status.InfoStatus; +<a name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> ch.qos.logback.core.status.StatusManager; +<a name="30" href="#30">30</a> +<a name="31" href="#31">31</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Callback that may be registered for a watch logback configuration file. */</em> +<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/LogbackConfigurationChangeListener.html">LogbackConfigurationChangeListener</a> implements ResourceChangeListener { +<a name="33" href="#33">33</a> +<a name="34" href="#34">34</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> {@inheritDoc} */</em> +<a name="35" href="#35">35</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> onResourceCreate(Resource resource) { +<a name="36" href="#36">36</a> configureLogback(resource); +<a name="37" href="#37">37</a> } +<a name="38" href="#38">38</a> +<a name="39" href="#39">39</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> {@inheritDoc} */</em> +<a name="40" href="#40">40</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> onResourceDelete(Resource resource) { +<a name="41" href="#41">41</a> <em class="jxr_comment">// do nothing</em> +<a name="42" href="#42">42</a> } +<a name="43" href="#43">43</a> +<a name="44" href="#44">44</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> {@inheritDoc} */</em> +<a name="45" href="#45">45</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> onResourceUpdate(Resource resource) { +<a name="46" href="#46">46</a> configureLogback(resource); +<a name="47" href="#47">47</a> } +<a name="48" href="#48">48</a> +<a name="49" href="#49">49</a> <em class="jxr_javadoccomment">/**</em> +<a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * Configures logback using the given resource as the Joran configuration file.</em> +<a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * </em> +<a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * @param configuration logback configuration file</em> +<a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> */</em> +<a name="54" href="#54">54</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> configureLogback(Resource configuration) { +<a name="55" href="#55">55</a> LoggerContext loggerContext = (LoggerContext) LoggerFactory.getILoggerFactory(); +<a name="56" href="#56">56</a> StatusManager statusManager = loggerContext.getStatusManager(); +<a name="57" href="#57">57</a> statusManager.add(<strong class="jxr_keyword">new</strong> InfoStatus(<span class="jxr_string">"Loading logging configuration file: "</span> + configuration.getLocation(), <strong class="jxr_keyword">this</strong>)); +<a name="58" href="#58">58</a> <strong class="jxr_keyword">try</strong> { +<a name="59" href="#59">59</a> loggerContext.reset(); +<a name="60" href="#60">60</a> JoranConfigurator configurator = <strong class="jxr_keyword">new</strong> JoranConfigurator(); +<a name="61" href="#61">61</a> configurator.setContext(loggerContext); +<a name="62" href="#62">62</a> configurator.doConfigure(configuration.getInputStream()); +<a name="63" href="#63">63</a> loggerContext.start(); +<a name="64" href="#64">64</a> } <strong class="jxr_keyword">catch</strong> (JoranException e) { +<a name="65" href="#65">65</a> statusManager.add(<strong class="jxr_keyword">new</strong> ErrorStatus(<span class="jxr_string">"Error loading logging configuration file: "</span> +<a name="66" href="#66">66</a> + configuration.getLocation(), <strong class="jxr_keyword">this</strong>, e)); +<a name="67" href="#67">67</a> } <strong class="jxr_keyword">catch</strong> (ResourceException e) { +<a name="68" href="#68">68</a> statusManager.add(<strong class="jxr_keyword">new</strong> ErrorStatus(<span class="jxr_string">"Error loading logging configuration file: "</span> +<a name="69" href="#69">69</a> + configuration.getLocation(), <strong class="jxr_keyword">this</strong>, e)); +<a name="70" href="#70">70</a> } +<a name="71" href="#71">71</a> } +<a name="72" href="#72">72</a> } +</pre> +<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> +</html> + diff --git a/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/LogbackLoggingService.html b/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/LogbackLoggingService.html new file mode 100644 index 0000000..53ef169 --- /dev/null +++ b/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/LogbackLoggingService.html @@ -0,0 +1,78 @@ +<!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>LogbackLoggingService xref</title> +<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> +</head> +<body> +<div id="overview"><a href="../../../../../../apidocs/edu/internet2/middleware/shibboleth/wayf/LogbackLoggingService.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 [2007] [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.Timer; +<a name="20" href="#20">20</a> +<a name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> org.opensaml.util.resource.FilesystemResource; +<a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> org.opensaml.util.resource.Resource; +<a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> org.opensaml.util.resource.ResourceChangeWatcher; +<a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> org.opensaml.util.resource.ResourceException; +<a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory; +<a name="26" href="#26">26</a> +<a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> ch.qos.logback.classic.LoggerContext; +<a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> ch.qos.logback.core.status.ErrorStatus; +<a name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> ch.qos.logback.core.status.StatusManager; +<a name="30" href="#30">30</a> +<a name="31" href="#31">31</a> <em class="jxr_javadoccomment">/**</em> +<a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * Simple logging service that watches for logback configuration file changes and reloads the file when a change occurs.</em> +<a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> */</em> +<a name="34" href="#34">34</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/LogbackLoggingService.html">LogbackLoggingService</a> { +<a name="35" href="#35">35</a> +<a name="36" href="#36">36</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Timer used periodically read the logging configuration file. */</em> +<a name="37" href="#37">37</a> <strong class="jxr_keyword">private</strong> Timer taskTimer; +<a name="38" href="#38">38</a> +<a name="39" href="#39">39</a> <em class="jxr_javadoccomment">/**</em> +<a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * Constructor.</em> +<a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> *</em> +<a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * @param loggingConfigurationFile logback configuration file</em> +<a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * @param pollingFrequency frequency the configuration file should be checked for changes</em> +<a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> */</em> +<a name="45" href="#45">45</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/LogbackLoggingService.html">LogbackLoggingService</a>(String loggingConfigurationFile, <strong class="jxr_keyword">long</strong> pollingFrequency) { +<a name="46" href="#46">46</a> LoggerContext loggerContext = (LoggerContext) LoggerFactory.getILoggerFactory(); +<a name="47" href="#47">47</a> StatusManager statusManager = loggerContext.getStatusManager(); +<a name="48" href="#48">48</a> +<a name="49" href="#49">49</a> <strong class="jxr_keyword">try</strong>{ +<a name="50" href="#50">50</a> Resource configResource = <strong class="jxr_keyword">new</strong> FilesystemResource(loggingConfigurationFile); +<a name="51" href="#51">51</a> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/LogbackConfigurationChangeListener.html">LogbackConfigurationChangeListener</a> configChangeListener = <strong class="jxr_keyword">new</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/LogbackConfigurationChangeListener.html">LogbackConfigurationChangeListener</a>(); +<a name="52" href="#52">52</a> configChangeListener.onResourceCreate(configResource); +<a name="53" href="#53">53</a> +<a name="54" href="#54">54</a> ResourceChangeWatcher resourceWatcher = <strong class="jxr_keyword">new</strong> ResourceChangeWatcher(configResource, pollingFrequency, 5); +<a name="55" href="#55">55</a> resourceWatcher.getResourceListeners().add(configChangeListener); +<a name="56" href="#56">56</a> +<a name="57" href="#57">57</a> taskTimer = <strong class="jxr_keyword">new</strong> Timer(<strong class="jxr_keyword">true</strong>); +<a name="58" href="#58">58</a> taskTimer.schedule(resourceWatcher, 0, pollingFrequency); +<a name="59" href="#59">59</a> }<strong class="jxr_keyword">catch</strong>(ResourceException e){ +<a name="60" href="#60">60</a> statusManager.add(<strong class="jxr_keyword">new</strong> ErrorStatus(<span class="jxr_string">"Error loading logging configuration file: "</span> +<a name="61" href="#61">61</a> + loggingConfigurationFile, <strong class="jxr_keyword">this</strong>, e)); +<a name="62" href="#62">62</a> } +<a name="63" href="#63">63</a> } +<a name="64" href="#64">64</a> } +</pre> +<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> +</html> + diff --git a/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/Version.html b/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/Version.html new file mode 100644 index 0000000..0598401 --- /dev/null +++ b/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/Version.html @@ -0,0 +1,45 @@ +<!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>Version xref</title> +<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> +</head> +<body> +<div id="overview"><a href="../../../../../../apidocs/edu/internet2/middleware/shibboleth/wayf/Version.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 2008 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> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Class for printing the version of this library. */</em> +<a name="20" href="#20">20</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/Version.html">Version</a> { +<a name="21" href="#21">21</a> +<a name="22" href="#22">22</a> <em class="jxr_javadoccomment">/**</em> +<a name="23" href="#23">23</a> <em class="jxr_javadoccomment"> * Main entry point to program.</em> +<a name="24" href="#24">24</a> <em class="jxr_javadoccomment"> * </em> +<a name="25" href="#25">25</a> <em class="jxr_javadoccomment"> * @param args command line arguments</em> +<a name="26" href="#26">26</a> <em class="jxr_javadoccomment"> */</em> +<a name="27" href="#27">27</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> main(String[] args) { +<a name="28" href="#28">28</a> Package pkg = Version.<strong class="jxr_keyword">class</strong>.getPackage(); +<a name="29" href="#29">29</a> System.out.println(pkg.getImplementationTitle() + <span class="jxr_string">" version "</span> + pkg.getImplementationVersion()); +<a name="30" href="#30">30</a> } +<a name="31" href="#31">31</a> } +</pre> +<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> +</html> + diff --git a/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/WayfException.html b/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/WayfException.html new file mode 100644 index 0000000..886c6c8 --- /dev/null +++ b/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/WayfException.html @@ -0,0 +1,61 @@ +<!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>WayfException xref</title> +<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> +</head> +<body> +<div id="overview"><a href="../../../../../../apidocs/edu/internet2/middleware/shibboleth/wayf/WayfException.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> +<a name="20" href="#20">20</a> <em class="jxr_javadoccomment">/**</em> +<a name="21" href="#21">21</a> <em class="jxr_javadoccomment"> * Signals that an error has occurred while processing a Shibboleth WAYF request.</em> +<a name="22" href="#22">22</a> <em class="jxr_javadoccomment"> * </em> +<a name="23" href="#23">23</a> <em class="jxr_javadoccomment"> * @author Walter Hoehn wassa&#064;columbia.edu</em> +<a name="24" href="#24">24</a> <em class="jxr_javadoccomment"> */</em> +<a name="25" href="#25">25</a> +<a name="26" href="#26">26</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/WayfException.html">WayfException</a> <strong class="jxr_keyword">extends</strong> Exception { +<a name="27" href="#27">27</a> +<a name="28" href="#28">28</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Required serialization constant. */</em> +<a name="29" href="#29">29</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">long</strong> serialVersionUID = 8426660801169338914L; +<a name="30" href="#30">30</a> +<a name="31" href="#31">31</a> <em class="jxr_javadoccomment">/**</em> +<a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * Constructor with a description and an exception.</em> +<a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * @param s description</em> +<a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * @param e something bad having happened.</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> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/WayfException.html">WayfException</a>(String s, Throwable e) { +<a name="37" href="#37">37</a> <strong class="jxr_keyword">super</strong>(s, e); +<a name="38" href="#38">38</a> } +<a name="39" href="#39">39</a> +<a name="40" href="#40">40</a> <em class="jxr_javadoccomment">/**</em> +<a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * Constructure with just a description.</em> +<a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * @param s description</em> +<a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> */</em> +<a name="44" href="#44">44</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/WayfException.html">WayfException</a>(String s) { +<a name="45" href="#45">45</a> <strong class="jxr_keyword">super</strong>(s); +<a name="46" href="#46">46</a> } +<a name="47" href="#47">47</a> } +</pre> +<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> +</html> + diff --git a/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/WayfService.html b/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/WayfService.html new file mode 100644 index 0000000..488e3a0 --- /dev/null +++ b/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/WayfService.html @@ -0,0 +1,332 @@ +<!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>WayfService xref</title> +<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> +</head> +<body> +<div id="overview"><a href="../../../../../../apidocs/edu/internet2/middleware/shibboleth/wayf/WayfService.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.io.FileInputStream; +<a name="20" href="#20">20</a> <strong class="jxr_keyword">import</strong> java.io.FileNotFoundException; +<a name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> java.lang.reflect.Constructor; +<a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> java.util.ArrayList; +<a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> java.util.Hashtable; +<a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> java.util.Iterator; +<a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> java.util.List; +<a name="26" href="#26">26</a> +<a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> javax.servlet.GenericServlet; +<a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> javax.servlet.ServletException; +<a name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> javax.servlet.http.HttpServlet; +<a name="30" href="#30">30</a> <strong class="jxr_keyword">import</strong> javax.servlet.http.HttpServletRequest; +<a name="31" href="#31">31</a> <strong class="jxr_keyword">import</strong> javax.servlet.http.HttpServletResponse; +<a name="32" href="#32">32</a> <strong class="jxr_keyword">import</strong> javax.xml.namespace.QName; +<a name="33" href="#33">33</a> +<a name="34" href="#34">34</a> <strong class="jxr_keyword">import</strong> org.opensaml.DefaultBootstrap; +<a name="35" href="#35">35</a> <strong class="jxr_keyword">import</strong> org.opensaml.xml.Configuration; +<a name="36" href="#36">36</a> <strong class="jxr_keyword">import</strong> org.opensaml.xml.parse.BasicParserPool; +<a name="37" href="#37">37</a> <strong class="jxr_keyword">import</strong> org.opensaml.xml.util.DatatypeHelper; +<a name="38" href="#38">38</a> <strong class="jxr_keyword">import</strong> org.slf4j.Logger; +<a name="39" href="#39">39</a> <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory; +<a name="40" href="#40">40</a> <strong class="jxr_keyword">import</strong> org.w3c.dom.Document; +<a name="41" href="#41">41</a> <strong class="jxr_keyword">import</strong> org.w3c.dom.Element; +<a name="42" href="#42">42</a> <strong class="jxr_keyword">import</strong> org.w3c.dom.NodeList; +<a name="43" href="#43">43</a> +<a name="44" href="#44">44</a> <strong class="jxr_keyword">import</strong> edu.internet2.middleware.shibboleth.common.ShibbolethConfigurationException; +<a name="45" href="#45">45</a> <strong class="jxr_keyword">import</strong> edu.internet2.middleware.shibboleth.wayf.plugins.Plugin; +<a name="46" href="#46">46</a> +<a name="47" href="#47">47</a> <em class="jxr_javadoccomment">/**</em> +<a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * A servlet implementation of the Shibboleth WAYF service. Allows a browser</em> +<a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * user to select from among a group of origin sites. User selection is</em> +<a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * optionally cached and the user is forwarded to the HandleService appropriate</em> +<a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * to his selection.</em> +<a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> */</em> +<a name="53" href="#53">53</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/WayfService.html">WayfService</a> <strong class="jxr_keyword">extends</strong> HttpServlet { +<a name="54" href="#54">54</a> +<a name="55" href="#55">55</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Required constant for serializaton. */</em> +<a name="56" href="#56">56</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">long</strong> serialVersionUID = 5244503011625804940L; +<a name="57" href="#57">57</a> +<a name="58" href="#58">58</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Handle for outputting error and other messages. */</em> +<a name="59" href="#59">59</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Logger LOG = LoggerFactory.getLogger(WayfService.<strong class="jxr_keyword">class</strong>.getName()); +<a name="60" href="#60">60</a> +<a name="61" href="#61">61</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Where to get the configuration. */</em> +<a name="62" href="#62">62</a> <strong class="jxr_keyword">private</strong> String wayfConfigFileLocation; +<a name="63" href="#63">63</a> +<a name="64" href="#64">64</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Logging service. */</em> +<a name="65" href="#65">65</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/LogbackLoggingService.html">LogbackLoggingService</a> logService; +<a name="66" href="#66">66</a> +<a name="67" href="#67">67</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> All the different Discovery Services we deal with. */</em> +<a name="68" href="#68">68</a> <strong class="jxr_keyword">private</strong> List <DiscoveryServiceHandler> discoveryServices = <strong class="jxr_keyword">new</strong> ArrayList <DiscoveryServiceHandler>(); +<a name="69" href="#69">69</a> +<a name="70" href="#70">70</a> <em class="jxr_javadoccomment">/**</em> +<a name="71" href="#71">71</a> <em class="jxr_javadoccomment"> * Initialize the Discovery Service.</em> +<a name="72" href="#72">72</a> <em class="jxr_javadoccomment"> * </em> +<a name="73" href="#73">73</a> <em class="jxr_javadoccomment"> * @throws ServletException in the case of something bad happening</em> +<a name="74" href="#74">74</a> <em class="jxr_javadoccomment"> * </em> +<a name="75" href="#75">75</a> <em class="jxr_javadoccomment"> * @see GenericServlet#init()</em> +<a name="76" href="#76">76</a> <em class="jxr_javadoccomment"> */</em> +<a name="77" href="#77">77</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> init() <strong class="jxr_keyword">throws</strong> ServletException { +<a name="78" href="#78">78</a> +<a name="79" href="#79">79</a> <strong class="jxr_keyword">super</strong>.init(); +<a name="80" href="#80">80</a> +<a name="81" href="#81">81</a> wayfConfigFileLocation = getServletContext().getInitParameter(<span class="jxr_string">"WAYFConfigFileLocation"</span>); +<a name="82" href="#82">82</a> <strong class="jxr_keyword">if</strong> (wayfConfigFileLocation == <strong class="jxr_keyword">null</strong>) { +<a name="83" href="#83">83</a> wayfConfigFileLocation = getServletConfig().getInitParameter(<span class="jxr_string">"WAYFConfigFileLocation"</span>); +<a name="84" href="#84">84</a> } +<a name="85" href="#85">85</a> <strong class="jxr_keyword">if</strong> (wayfConfigFileLocation == <strong class="jxr_keyword">null</strong>) { +<a name="86" href="#86">86</a> wayfConfigFileLocation = <span class="jxr_string">"/wayfconfig.xml"</span>; +<a name="87" href="#87">87</a> } +<a name="88" href="#88">88</a> +<a name="89" href="#89">89</a> +<a name="90" href="#90">90</a> <strong class="jxr_keyword">try</strong> { +<a name="91" href="#91">91</a> <em class="jxr_comment">//</em> +<a name="92" href="#92">92</a> <em class="jxr_comment">// Initialize logging</em> +<a name="93" href="#93">93</a> <em class="jxr_comment">//</em> +<a name="94" href="#94">94</a> String wayfLogfile = getServletContext().getInitParameter(<span class="jxr_string">"WAYFLogConfig"</span>); +<a name="95" href="#95">95</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">null</strong> == wayfLogfile) { +<a name="96" href="#96">96</a> wayfLogfile = getServletConfig().getInitParameter(<span class="jxr_string">"WAYFLogConfig"</span>); +<a name="97" href="#97">97</a> } +<a name="98" href="#98">98</a> <strong class="jxr_keyword">long</strong> pollingFrequency = 1000*60*5; +<a name="99" href="#99">99</a> +<a name="100" href="#100">100</a> String wayfLogfilePollFrequency = getServletContext().getInitParameter(<span class="jxr_string">"WAYFLogConfigPollFrequency"</span>); +<a name="101" href="#101">101</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">null</strong> == wayfLogfilePollFrequency) { +<a name="102" href="#102">102</a> wayfLogfilePollFrequency = getServletConfig().getInitParameter(<span class="jxr_string">"WAYFLogConfigPollFrequency"</span>); +<a name="103" href="#103">103</a> } +<a name="104" href="#104">104</a> <strong class="jxr_keyword">if</strong>(!DatatypeHelper.isEmpty(wayfLogfilePollFrequency)){ +<a name="105" href="#105">105</a> pollingFrequency = Long.parseLong(wayfLogfilePollFrequency); +<a name="106" href="#106">106</a> } +<a name="107" href="#107">107</a> <strong class="jxr_keyword">if</strong> (wayfLogfile != <strong class="jxr_keyword">null</strong>) { +<a name="108" href="#108">108</a> logService = <strong class="jxr_keyword">new</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/LogbackLoggingService.html">LogbackLoggingService</a>(wayfLogfile, pollingFrequency); +<a name="109" href="#109">109</a> } +<a name="110" href="#110">110</a> +<a name="111" href="#111">111</a> LOG.info(<span class="jxr_string">"Logging initiated"</span>); +<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">// Initialize OpenSAML 2 library</em> +<a name="115" href="#115">115</a> <em class="jxr_comment">//</em> +<a name="116" href="#116">116</a> DefaultBootstrap.bootstrap(); +<a name="117" href="#117">117</a> +<a name="118" href="#118">118</a> BasicParserPool parser = <strong class="jxr_keyword">new</strong> BasicParserPool(); +<a name="119" href="#119">119</a> parser.setNamespaceAware(<strong class="jxr_keyword">true</strong>); +<a name="120" href="#120">120</a> Document doc; +<a name="121" href="#121">121</a> <strong class="jxr_keyword">try</strong> { +<a name="122" href="#122">122</a> doc = parser.parse(<strong class="jxr_keyword">new</strong> FileInputStream(wayfConfigFileLocation)); +<a name="123" href="#123">123</a> } <strong class="jxr_keyword">catch</strong> (FileNotFoundException e) { +<a name="124" href="#124">124</a> LOG.error(<span class="jxr_string">"Could not parse "</span> + wayfConfigFileLocation, e); +<a name="125" href="#125">125</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/common/ShibbolethConfigurationException.html">ShibbolethConfigurationException</a>(<span class="jxr_string">"Could not parse "</span> + wayfConfigFileLocation, e); +<a name="126" href="#126">126</a> } +<a name="127" href="#127">127</a> NodeList itemElements = doc.getDocumentElement().getElementsByTagNameNS(XMLConstants.CONFIG_NS, +<a name="128" href="#128">128</a> <span class="jxr_string">"Default"</span>); +<a name="129" href="#129">129</a> +<a name="130" href="#130">130</a> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/HandlerConfig.html">HandlerConfig</a> defaultHandlerConfig; +<a name="131" href="#131">131</a> +<a name="132" href="#132">132</a> <strong class="jxr_keyword">if</strong> (itemElements.getLength() == 1) { +<a name="133" href="#133">133</a> +<a name="134" href="#134">134</a> Element element = (Element) itemElements.item(0); +<a name="135" href="#135">135</a> String attribute = element.getAttribute(<span class="jxr_string">"location"</span>); +<a name="136" href="#136">136</a> +<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> +<a name="139" href="#139">139</a> LOG.error(<span class="jxr_string">"<Default> element cannot contain a location attribute"</span>); +<a name="140" href="#140">140</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/common/ShibbolethConfigurationException.html">ShibbolethConfigurationException</a>(<span class="jxr_string">"<Default> element cannot contain a location attribute"</span>); +<a name="141" href="#141">141</a> +<a name="142" href="#142">142</a> } +<a name="143" href="#143">143</a> +<a name="144" href="#144">144</a> attribute = element.getAttribute(<span class="jxr_string">"default"</span>); +<a name="145" href="#145">145</a> +<a name="146" href="#146">146</a> <strong class="jxr_keyword">if</strong> (attribute != <strong class="jxr_keyword">null</strong> && !attribute.equals(<span class="jxr_string">""</span>)) { +<a name="147" href="#147">147</a> +<a name="148" href="#148">148</a> LOG.error(<span class="jxr_string">"<Default> element cannot contain a default attribute"</span>); +<a name="149" href="#149">149</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/common/ShibbolethConfigurationException.html">ShibbolethConfigurationException</a>(<span class="jxr_string">"<Default> element cannot contain a default attribute"</span>); +<a name="150" href="#150">150</a> +<a name="151" href="#151">151</a> } +<a name="152" href="#152">152</a> +<a name="153" href="#153">153</a> itemElements = element.getElementsByTagName(<span class="jxr_string">"Federation"</span>); +<a name="154" href="#154">154</a> +<a name="155" href="#155">155</a> <strong class="jxr_keyword">if</strong> (itemElements.getLength() != 0) { +<a name="156" href="#156">156</a> +<a name="157" href="#157">157</a> LOG.error(<span class="jxr_string">"<Default> element cannot contain <Federation> elements"</span>); +<a name="158" href="#158">158</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/common/ShibbolethConfigurationException.html">ShibbolethConfigurationException</a>(<span class="jxr_string">"<Default> element cannot contain <Federation> elements"</span>); +<a name="159" href="#159">159</a> +<a name="160" href="#160">160</a> } +<a name="161" href="#161">161</a> +<a name="162" href="#162">162</a> defaultHandlerConfig = <strong class="jxr_keyword">new</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/HandlerConfig.html">HandlerConfig</a>(element, <strong class="jxr_keyword">new</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/HandlerConfig.html">HandlerConfig</a>()); +<a name="163" href="#163">163</a> +<a name="164" href="#164">164</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (itemElements.getLength() == 0) { +<a name="165" href="#165">165</a> +<a name="166" href="#166">166</a> defaultHandlerConfig = <strong class="jxr_keyword">new</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/HandlerConfig.html">HandlerConfig</a>(); +<a name="167" href="#167">167</a> +<a name="168" href="#168">168</a> } <strong class="jxr_keyword">else</strong> { +<a name="169" href="#169">169</a> LOG.error(<span class="jxr_string">"Must specify exactly one <Default> element"</span>); +<a name="170" href="#170">170</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/common/ShibbolethConfigurationException.html">ShibbolethConfigurationException</a>(<span class="jxr_string">"Must specify exactly one <Default> element"</span>); +<a name="171" href="#171">171</a> } +<a name="172" href="#172">172</a> <em class="jxr_comment">//</em> +<a name="173" href="#173">173</a> <em class="jxr_comment">// Extra types</em> +<a name="174" href="#174">174</a> <em class="jxr_comment">//</em> +<a name="175" href="#175">175</a> QName response = <strong class="jxr_keyword">new</strong> QName(DiscoveryResponseImpl.METADATA_NS, DiscoveryResponseImpl.DEFAULT_ELEMENT_LOCAL_NAME); +<a name="176" href="#176">176</a> +<a name="177" href="#177">177</a> Configuration.getUnmarshallerFactory().registerUnmarshaller(response, <strong class="jxr_keyword">new</strong> DiscoveryResponseUnmarshaller()); +<a name="178" href="#178">178</a> Configuration.getBuilderFactory().registerBuilder(response, <strong class="jxr_keyword">new</strong> DiscoveryResponseBuilder()); +<a name="179" href="#179">179</a> +<a name="180" href="#180">180</a> <em class="jxr_comment">//</em> +<a name="181" href="#181">181</a> <em class="jxr_comment">// Load metadata</em> +<a name="182" href="#182">182</a> <em class="jxr_comment">//</em> +<a name="183" href="#183">183</a> Hashtable <String, IdPSiteSet> siteSets = <strong class="jxr_keyword">new</strong> Hashtable <String, IdPSiteSet>(); +<a name="184" href="#184">184</a> +<a name="185" href="#185">185</a> itemElements = doc.getDocumentElement().getElementsByTagNameNS(XMLConstants.CONFIG_NS, +<a name="186" href="#186">186</a> <span class="jxr_string">"MetadataProvider"</span>); +<a name="187" href="#187">187</a> +<a name="188" href="#188">188</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i < itemElements.getLength(); i++) { +<a name="189" href="#189">189</a> +<a name="190" href="#190">190</a> Element element = (Element) itemElements.item(i); +<a name="191" href="#191">191</a> +<a name="192" href="#192">192</a> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/IdPSiteSet.html">IdPSiteSet</a> siteset = <strong class="jxr_keyword">new</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/IdPSiteSet.html">IdPSiteSet</a>(element, parser, defaultHandlerConfig.getWarnOnBadBinding()); +<a name="193" href="#193">193</a> +<a name="194" href="#194">194</a> siteSets.put(siteset.getIdentifier(), siteset); +<a name="195" href="#195">195</a> } +<a name="196" href="#196">196</a> <strong class="jxr_keyword">if</strong> (siteSets.size() < 1) { +<a name="197" href="#197">197</a> LOG.error(<span class="jxr_string">"No Metadata Provider metadata loaded."</span>); +<a name="198" href="#198">198</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/common/ShibbolethConfigurationException.html">ShibbolethConfigurationException</a>(<span class="jxr_string">"Could not load SAML metadata."</span>); +<a name="199" href="#199">199</a> } +<a name="200" href="#200">200</a> <em class="jxr_comment">//</em> +<a name="201" href="#201">201</a> <em class="jxr_comment">// Load plugins</em> +<a name="202" href="#202">202</a> <em class="jxr_comment">//</em> +<a name="203" href="#203">203</a> +<a name="204" href="#204">204</a> Hashtable <String, Plugin> plugins = <strong class="jxr_keyword">new</strong> Hashtable <String, Plugin>(); +<a name="205" href="#205">205</a> +<a name="206" href="#206">206</a> itemElements = doc.getDocumentElement().getElementsByTagNameNS(XMLConstants.CONFIG_NS, +<a name="207" href="#207">207</a> <span class="jxr_string">"Plugin"</span>); +<a name="208" href="#208">208</a> +<a name="209" href="#209">209</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i < itemElements.getLength(); i++) { +<a name="210" href="#210">210</a> +<a name="211" href="#211">211</a> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/Plugin.html">Plugin</a> plugin; +<a name="212" href="#212">212</a> +<a name="213" href="#213">213</a> Element element = (Element) itemElements.item(i); +<a name="214" href="#214">214</a> +<a name="215" href="#215">215</a> String identifier = element.getAttribute(<span class="jxr_string">"identifier"</span>); +<a name="216" href="#216">216</a> +<a name="217" href="#217">217</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">null</strong> == identifier || identifier.equals(<span class="jxr_string">""</span>)) { +<a name="218" href="#218">218</a> LOG.error(<span class="jxr_string">"Could not load plugin with no identifier"</span>); +<a name="219" href="#219">219</a> <strong class="jxr_keyword">continue</strong>; +<a name="220" href="#220">220</a> } +<a name="221" href="#221">221</a> +<a name="222" href="#222">222</a> String className = element.getAttribute(<span class="jxr_string">"type"</span>); +<a name="223" href="#223">223</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">null</strong> == className || className.equals(<span class="jxr_string">""</span>)) { +<a name="224" href="#224">224</a> LOG.error(<span class="jxr_string">"Plugin "</span> + identifier + <span class="jxr_string">" did not have a valid type"</span>); +<a name="225" href="#225">225</a> } +<a name="226" href="#226">226</a> <em class="jxr_comment">//</em> +<a name="227" href="#227">227</a> <em class="jxr_comment">// So try to get hold of the plugin</em> +<a name="228" href="#228">228</a> <em class="jxr_comment">//</em> +<a name="229" href="#229">229</a> <strong class="jxr_keyword">try</strong> { +<a name="230" href="#230">230</a> Class<Plugin> pluginClass = (Class<Plugin>) Class.forName(className); +<a name="231" href="#231">231</a> Class[] classParams = {Element.<strong class="jxr_keyword">class</strong>}; +<a name="232" href="#232">232</a> Constructor<Plugin> pluginConstructor = pluginClass.getConstructor(classParams); +<a name="233" href="#233">233</a> Object[] constructorParams = {element}; +<a name="234" href="#234">234</a> +<a name="235" href="#235">235</a> plugin = pluginConstructor.newInstance(constructorParams); +<a name="236" href="#236">236</a> +<a name="237" href="#237">237</a> } <strong class="jxr_keyword">catch</strong> (Exception e) { +<a name="238" href="#238">238</a> LOG.error(<span class="jxr_string">"Plugin "</span> + identifier + <span class="jxr_string">" could not be loaded "</span>, e); +<a name="239" href="#239">239</a> <strong class="jxr_keyword">continue</strong>; +<a name="240" href="#240">240</a> } +<a name="241" href="#241">241</a> +<a name="242" href="#242">242</a> plugins.put(identifier, plugin); +<a name="243" href="#243">243</a> } +<a name="244" href="#244">244</a> +<a name="245" href="#245">245</a> +<a name="246" href="#246">246</a> <em class="jxr_comment">//</em> +<a name="247" href="#247">247</a> <em class="jxr_comment">// Load service handlers</em> +<a name="248" href="#248">248</a> <em class="jxr_comment">//</em> +<a name="249" href="#249">249</a> itemElements = doc.getDocumentElement().getElementsByTagNameNS(XMLConstants.CONFIG_NS, +<a name="250" href="#250">250</a> <span class="jxr_string">"DiscoveryServiceHandler"</span>); +<a name="251" href="#251">251</a> +<a name="252" href="#252">252</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i < itemElements.getLength(); i++) { +<a name="253" href="#253">253</a> +<a name="254" href="#254">254</a> discoveryServices.add(<strong class="jxr_keyword">new</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/DiscoveryServiceHandler.html">DiscoveryServiceHandler</a>((Element)itemElements.item(i), +<a name="255" href="#255">255</a> siteSets, +<a name="256" href="#256">256</a> plugins, +<a name="257" href="#257">257</a> defaultHandlerConfig)); +<a name="258" href="#258">258</a> +<a name="259" href="#259">259</a> } +<a name="260" href="#260">260</a> +<a name="261" href="#261">261</a> } <strong class="jxr_keyword">catch</strong> (Exception e) { +<a name="262" href="#262">262</a> <em class="jxr_comment">//</em> +<a name="263" href="#263">263</a> <em class="jxr_comment">// All other exceptions are from the parsing</em> +<a name="264" href="#264">264</a> <em class="jxr_comment">//</em> +<a name="265" href="#265">265</a> <strong class="jxr_keyword">if</strong> (LOG != <strong class="jxr_keyword">null</strong>) { +<a name="266" href="#266">266</a> LOG.error(<span class="jxr_string">"Error parsing DS configuration file."</span>, e); +<a name="267" href="#267">267</a> } +<a name="268" href="#268">268</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> ServletException(<span class="jxr_string">"Error parsing DS configuration file."</span>, e); +<a name="269" href="#269">269</a> } +<a name="270" href="#270">270</a> +<a name="271" href="#271">271</a> LOG.info(<span class="jxr_string">"DS initialization completed."</span>); +<a name="272" href="#272">272</a> } +<a name="273" href="#273">273</a> +<a name="274" href="#274">274</a> <em class="jxr_javadoccomment">/**</em> +<a name="275" href="#275">275</a> <em class="jxr_javadoccomment"> * Handle an HTTP GET. Just passes out to the appropriate handler.</em> +<a name="276" href="#276">276</a> <em class="jxr_javadoccomment"> * @param req described the request.</em> +<a name="277" href="#277">277</a> <em class="jxr_javadoccomment"> * @param res contains the response.</em> +<a name="278" href="#278">278</a> <em class="jxr_javadoccomment"> * @see HttpServlet#doGet(HttpServletRequest, HttpServletResponse)</em> +<a name="279" href="#279">279</a> <em class="jxr_javadoccomment"> */</em> +<a name="280" href="#280">280</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> doGet(HttpServletRequest req, HttpServletResponse res) { +<a name="281" href="#281">281</a> +<a name="282" href="#282">282</a> LOG.info(<span class="jxr_string">"Handling DS request."</span>); +<a name="283" href="#283">283</a> <em class="jxr_comment">// Tell the browser not to cache the WAYF page</em> +<a name="284" href="#284">284</a> res.setHeader(<span class="jxr_string">"Cache-Control"</span>, <span class="jxr_string">"no-cache"</span>); +<a name="285" href="#285">285</a> res.setHeader(<span class="jxr_string">"Pragma"</span>, <span class="jxr_string">"no-cache"</span>); +<a name="286" href="#286">286</a> res.setDateHeader(<span class="jxr_string">"Expires"</span>, 0); +<a name="287" href="#287">287</a> +<a name="288" href="#288">288</a> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/DiscoveryServiceHandler.html">DiscoveryServiceHandler</a> serviceHandler = lookupServiceHandler(req); +<a name="289" href="#289">289</a> +<a name="290" href="#290">290</a> serviceHandler.doGet(req, res); +<a name="291" href="#291">291</a> +<a name="292" href="#292">292</a> } +<a name="293" href="#293">293</a> +<a name="294" href="#294">294</a> <em class="jxr_javadoccomment">/**</em> +<a name="295" href="#295">295</a> <em class="jxr_javadoccomment"> * Given a request (an HTTP Get) find the apropriate DiscoveryService (from the name).</em> +<a name="296" href="#296">296</a> <em class="jxr_javadoccomment"> * @param req desribed the request</em> +<a name="297" href="#297">297</a> <em class="jxr_javadoccomment"> * @return the apropriate DiscoveryService.</em> +<a name="298" href="#298">298</a> <em class="jxr_javadoccomment"> */</em> +<a name="299" href="#299">299</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/DiscoveryServiceHandler.html">DiscoveryServiceHandler</a> lookupServiceHandler(HttpServletRequest req) { +<a name="300" href="#300">300</a> +<a name="301" href="#301">301</a> Iterator<DiscoveryServiceHandler> it = discoveryServices.iterator(); +<a name="302" href="#302">302</a> String requestURL = req.getRequestURL().toString(); +<a name="303" href="#303">303</a> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/DiscoveryServiceHandler.html">DiscoveryServiceHandler</a> defaultHandler = <strong class="jxr_keyword">null</strong>; +<a name="304" href="#304">304</a> +<a name="305" href="#305">305</a> <strong class="jxr_keyword">while</strong> (it.hasNext()) { +<a name="306" href="#306">306</a> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/DiscoveryServiceHandler.html">DiscoveryServiceHandler</a> handler = it.next(); +<a name="307" href="#307">307</a> +<a name="308" href="#308">308</a> <strong class="jxr_keyword">if</strong> (requestURL.matches(handler.getLocation())) { +<a name="309" href="#309">309</a> <strong class="jxr_keyword">return</strong> handler; +<a name="310" href="#310">310</a> } +<a name="311" href="#311">311</a> <strong class="jxr_keyword">if</strong> (defaultHandler == <strong class="jxr_keyword">null</strong> || handler.isDefault()) { +<a name="312" href="#312">312</a> defaultHandler = handler; +<a name="313" href="#313">313</a> } +<a name="314" href="#314">314</a> } +<a name="315" href="#315">315</a> LOG.warn(<span class="jxr_string">"Could not find Discovery service Handler for "</span> + requestURL); +<a name="316" href="#316">316</a> <strong class="jxr_keyword">return</strong> defaultHandler; +<a name="317" href="#317">317</a> } +<a name="318" href="#318">318</a> } +</pre> +<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> +</html> + diff --git a/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/XMLConstants.html b/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/XMLConstants.html new file mode 100644 index 0000000..9be262d --- /dev/null +++ b/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/XMLConstants.html @@ -0,0 +1,47 @@ +<!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>XMLConstants xref</title> +<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> +</head> +<body> +<div id="overview"><a href="../../../../../../apidocs/edu/internet2/middleware/shibboleth/wayf/XMLConstants.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> <em class="jxr_javadoccomment">/**</em> +<a name="20" href="#20">20</a> <em class="jxr_javadoccomment"> * Holder class for various XML constants (namespaces and so forth).</em> +<a name="21" href="#21">21</a> <em class="jxr_javadoccomment"> */</em> +<a name="22" href="#22">22</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../edu/internet2/middleware/shibboleth/wayf/XMLConstants.html">XMLConstants</a> { +<a name="23" href="#23">23</a> +<a name="24" href="#24">24</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Shibboleth XML namespace. */</em> +<a name="25" href="#25">25</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String SHIB_NS = <span class="jxr_string">"urn:mace:shibboleth:1.0"</span>; +<a name="26" href="#26">26</a> +<a name="27" href="#27">27</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> SSO Binding name. */</em> +<a name="28" href="#28">28</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String IDP_SSO_BINDING = <span class="jxr_string">"urn:mace:shibboleth:1.0:profiles:AuthnRequest"</span>; +<a name="29" href="#29">29</a> +<a name="30" href="#30">30</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Namespace for Discovery Service configuration. */</em> +<a name="31" href="#31">31</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String CONFIG_NS = <span class="jxr_string">"urn:mace:shibboleth:wayf:config:1.0"</span>; +<a name="32" href="#32">32</a> +<a name="33" href="#33">33</a> } +</pre> +<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> +</html> + diff --git a/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/package-frame.html b/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/package-frame.html new file mode 100644 index 0000000..579ca32 --- /dev/null +++ b/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/package-frame.html @@ -0,0 +1,66 @@ +
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "DTD/xhtml1-transitional.dtd">
+<html xml:lang="en" lang="en">
+ <head>
+ <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
+ <title>Shibboleth Discovery Service 1.1.0 Reference Package edu.internet2.middleware.shibboleth.wayf</title>
+ <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="style" />
+ </head>
+ <body>
+
+ <h3>
+ <a href="package-summary.html" target="classFrame">edu.internet2.middleware.shibboleth.wayf</a>
+ </h3>
+
+ <h3>Classes</h3>
+
+ <ul>
+ <li>
+ <a href="IdPSite.html" target="classFrame">Compare</a>
+ </li>
+ <li>
+ <a href="DiscoveryResponseBuilder.html" target="classFrame">DiscoveryResponseBuilder</a>
+ </li>
+ <li>
+ <a href="DiscoveryResponseImpl.html" target="classFrame">DiscoveryResponseImpl</a>
+ </li>
+ <li>
+ <a href="DiscoveryResponseUnmarshaller.html" target="classFrame">DiscoveryResponseUnmarshaller</a>
+ </li>
+ <li>
+ <a href="DiscoveryServiceHandler.html" target="classFrame">DiscoveryServiceHandler</a>
+ </li>
+ <li>
+ <a href="HandlerConfig.html" target="classFrame">HandlerConfig</a>
+ </li>
+ <li>
+ <a href="IdPSite.html" target="classFrame">IdPSite</a>
+ </li>
+ <li>
+ <a href="IdPSiteSet.html" target="classFrame">IdPSiteSet</a>
+ </li>
+ <li>
+ <a href="IdPSiteSetEntry.html" target="classFrame">IdPSiteSetEntry</a>
+ </li>
+ <li>
+ <a href="LogbackConfigurationChangeListener.html" target="classFrame">LogbackConfigurationChangeListener</a>
+ </li>
+ <li>
+ <a href="LogbackLoggingService.html" target="classFrame">LogbackLoggingService</a>
+ </li>
+ <li>
+ <a href="Version.html" target="classFrame">Version</a>
+ </li>
+ <li>
+ <a href="WayfException.html" target="classFrame">WayfException</a>
+ </li>
+ <li>
+ <a href="WayfService.html" target="classFrame">WayfService</a>
+ </li>
+ <li>
+ <a href="XMLConstants.html" target="classFrame">XMLConstants</a>
+ </li>
+ </ul>
+
+ </body>
+</html>
\ No newline at end of file diff --git a/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/package-summary.html b/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/package-summary.html new file mode 100644 index 0000000..0bc1365 --- /dev/null +++ b/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/package-summary.html @@ -0,0 +1,137 @@ +
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "DTD/xhtml1-transitional.dtd">
+<html xml:lang="en" lang="en">
+ <head>
+ <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
+ <title>Shibboleth Discovery Service 1.1.0 Reference Package edu.internet2.middleware.shibboleth.wayf</title>
+ <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="style" />
+ </head>
+ <body>
+ <div class="overview">
+ <ul>
+ <li>
+ <a href="../../../../../overview-summary.html">Overview</a>
+ </li>
+ <li class="selected">Package</li>
+ </ul>
+ </div>
+ <div class="framenoframe">
+ <ul>
+ <li>
+ <a href="../../../../../index.html" target="_top">FRAMES</a>
+ </li>
+ <li>
+ <a href="package-summary.html" target="_top">NO FRAMES</a>
+ </li>
+ </ul>
+ </div>
+
+ <h2>Package edu.internet2.middleware.shibboleth.wayf</h2>
+
+ <table class="summary">
+ <thead>
+ <tr>
+ <th>Class Summary</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ <a href="IdPSite.html" target="classFrame">Compare</a>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <a href="DiscoveryResponseBuilder.html" target="classFrame">DiscoveryResponseBuilder</a>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <a href="DiscoveryResponseImpl.html" target="classFrame">DiscoveryResponseImpl</a>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <a href="DiscoveryResponseUnmarshaller.html" target="classFrame">DiscoveryResponseUnmarshaller</a>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <a href="DiscoveryServiceHandler.html" target="classFrame">DiscoveryServiceHandler</a>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <a href="HandlerConfig.html" target="classFrame">HandlerConfig</a>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <a href="IdPSite.html" target="classFrame">IdPSite</a>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <a href="IdPSiteSet.html" target="classFrame">IdPSiteSet</a>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <a href="IdPSiteSetEntry.html" target="classFrame">IdPSiteSetEntry</a>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <a href="LogbackConfigurationChangeListener.html" target="classFrame">LogbackConfigurationChangeListener</a>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <a href="LogbackLoggingService.html" target="classFrame">LogbackLoggingService</a>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <a href="Version.html" target="classFrame">Version</a>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <a href="WayfException.html" target="classFrame">WayfException</a>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <a href="WayfService.html" target="classFrame">WayfService</a>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <a href="XMLConstants.html" target="classFrame">XMLConstants</a>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
+ <div class="overview">
+ <ul>
+ <li>
+ <a href="../../../../../overview-summary.html">Overview</a>
+ </li>
+ <li class="selected">Package</li>
+ </ul>
+ </div>
+ <div class="framenoframe">
+ <ul>
+ <li>
+ <a href="../../../../../index.html" target="_top">FRAMES</a>
+ </li>
+ <li>
+ <a href="package-summary.html" target="_top">NO FRAMES</a>
+ </li>
+ </ul>
+ </div>
+ <hr />
+ Copyright © 2006-2009 Internet2. All Rights Reserved.
+ </body>
+</html>
\ No newline at end of file diff --git a/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/plugins/Plugin.html b/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/plugins/Plugin.html new file mode 100644 index 0000000..0c6391a --- /dev/null +++ b/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/plugins/Plugin.html @@ -0,0 +1,173 @@ +<!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>Plugin 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/Plugin.html">View Javadoc</a></div><pre> + +<a name="1" href="#1">1</a> <em class="jxr_javadoccomment">/**</em> +<a name="2" href="#2">2</a> <em class="jxr_javadoccomment"> * Copyright [2006] [University Corporation for Advanced Internet Development, Inc.]</em> +<a name="3" href="#3">3</a> <em class="jxr_javadoccomment"> *</em> +<a name="4" href="#4">4</a> <em class="jxr_javadoccomment"> * Licensed under the Apache License, Version 2.0 (the "License");</em> +<a name="5" href="#5">5</a> <em class="jxr_javadoccomment"> * you may not use this file except in compliance with the License.</em> +<a name="6" href="#6">6</a> <em class="jxr_javadoccomment"> * You may obtain a copy of the License at</em> +<a name="7" href="#7">7</a> <em class="jxr_javadoccomment"> *</em> +<a name="8" href="#8">8</a> <em class="jxr_javadoccomment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em> +<a name="9" href="#9">9</a> <em class="jxr_javadoccomment"> *</em> +<a name="10" href="#10">10</a> <em class="jxr_javadoccomment"> * Unless required by applicable law or agreed to in writing, software</em> +<a name="11" href="#11">11</a> <em class="jxr_javadoccomment"> * distributed under the License is distributed on an "AS IS" BASIS,</em> +<a name="12" href="#12">12</a> <em class="jxr_javadoccomment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em> +<a name="13" href="#13">13</a> <em class="jxr_javadoccomment"> * See the License for the specific language governing permissions and</em> +<a name="14" href="#14">14</a> <em class="jxr_javadoccomment"> * limitations under the License.</em> +<a name="15" href="#15">15</a> <em class="jxr_javadoccomment"> */</em> +<a name="16" href="#16">16</a> <strong class="jxr_keyword">package</strong> edu.internet2.middleware.shibboleth.wayf.plugins; +<a name="17" href="#17">17</a> +<a name="18" href="#18">18</a> <strong class="jxr_keyword">import</strong> java.util.Collection; +<a name="19" href="#19">19</a> <strong class="jxr_keyword">import</strong> java.util.List; +<a name="20" href="#20">20</a> <strong class="jxr_keyword">import</strong> java.util.Map; +<a name="21" href="#21">21</a> +<a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> javax.servlet.http.HttpServletRequest; +<a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> javax.servlet.http.HttpServletResponse; +<a name="24" href="#24">24</a> +<a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> org.opensaml.saml2.metadata.provider.MetadataProvider; +<a name="26" href="#26">26</a> +<a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> edu.internet2.middleware.shibboleth.wayf.IdPSite; +<a name="28" href="#28">28</a> +<a name="29" href="#29">29</a> <em class="jxr_javadoccomment">/**</em> +<a name="30" href="#30">30</a> <em class="jxr_javadoccomment"> * </em> +<a name="31" href="#31">31</a> <em class="jxr_javadoccomment"> * The Plugin interface is used to affect the 'hints' that the WAYF offers to the users. </em> +<a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * <p></em> +<a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * The WAYF can register any number of plugins. Each plugin is called when the metadata is loaded or realoaded</em> +<a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * (so it can do any indexing) and at the three entry points into the WAYF - Lookup (main entry), Search and Select.</em> +<a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * Plugins are called in the order in which they are declared to the WAYF. </em> +<a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * <p></em> +<a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * Each plugin is called once when the user has made a selection.</em> +<a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * <p></em> +<a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * For Search and Lookup, each plugin is called multiple times, once for each metadata provider which has </em> +<a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * been declared to this particular WAYF instance. The plugin can return a context which is handed to subsequent calls.</em> +<a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * <p></em> +<a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * The idea is that each plugin can affect the displayed lists of IdPs. As a reminder the WAYF displays two lists of </em> +<a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * IdPs - the complete list, displayed either as a single list or a list of lists, and the hint list (which was</em> +<a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * previously only populated from the _saml_idp cookie. In the search case the WAYF displays a third list of</em> +<a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * the search hits. </em> +<a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * <p></em> +<a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * When the plugin in called it is given the current set of potential IdPs as a Map from EntityID to {@link IdPSite}</em> +<a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * and lists representing the current hint list and search results. A Plugin can remove an entry from </em> +<a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * the map or the lists. Additionally it can insert an IdPSite found in the Map into the hint or search lists.</em> +<a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * Thus the plugin can restrict the number of sites that the WAYF instance displays in the 'complete list' and</em> +<a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * can add or remove IdPs from the hint list.</em> +<a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * <p></em> +<a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> * At any stage the plugin can take control of the current request and redirect or forward it. It signals that</em> +<a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * it has done this to the WAYF by means of an exception.</em> +<a name="55" href="#55">55</a> <em class="jxr_javadoccomment"> * <p> </em> +<a name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * The _saml_idp cookie handling code is written as a WAYF plugin. Other plugins have been written to allow IdPs</em> +<a name="57" href="#57">57</a> <em class="jxr_javadoccomment"> * to be presented as hints based on the client's IP address or to redirect back to the SP once the choice of</em> +<a name="58" href="#58">58</a> <em class="jxr_javadoccomment"> * IdP has been made.</em> +<a name="59" href="#59">59</a> <em class="jxr_javadoccomment"> * <p></em> +<a name="60" href="#60">60</a> <em class="jxr_javadoccomment"> * Object implementing this interface are created during WAYF discovery service initialization. There are </em> +<a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * expected to implement a constructor which takes a {@link org.w3c.dom.Element} as the only parameter and they are </em> +<a name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * created via this constructor, with the parameter being the appropriate section of the WAYF configuration file </em> +<a name="63" href="#63">63</a> <em class="jxr_javadoccomment"> * </em> +<a name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * @version Discussion</em> +<a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> *</em> +<a name="66" href="#66">66</a> <em class="jxr_javadoccomment"> */</em> +<a name="67" href="#67">67</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> <a href="../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/Plugin.html">Plugin</a> { +<a name="68" href="#68">68</a> +<a name="69" href="#69">69</a> <em class="jxr_javadoccomment">/**</em> +<a name="70" href="#70">70</a> <em class="jxr_javadoccomment"> * Whenever the WAYF discoveres that the metadata is stale, it reloads it and calls each plugin at this method.</em> +<a name="71" href="#71">71</a> <em class="jxr_javadoccomment"> * </em> +<a name="72" href="#72">72</a> <em class="jxr_javadoccomment"> * @param metadata - where to get the data from.</em> +<a name="73" href="#73">73</a> <em class="jxr_javadoccomment"> * @return the value which will be provided as input to subsequent calls to {@link #lookup Lookup} and </em> +<a name="74" href="#74">74</a> <em class="jxr_javadoccomment"> * {@link #search Search}</em> +<a name="75" href="#75">75</a> <em class="jxr_javadoccomment"> */</em> +<a name="76" href="#76">76</a> <a href="../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/PluginMetadataParameter.html">PluginMetadataParameter</a> refreshMetadata(MetadataProvider metadata); +<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"> * The WAYF calls each plugin at this entry point when it is first contacted. </em> +<a name="80" href="#80">80</a> <em class="jxr_javadoccomment"> * </em> +<a name="81" href="#81">81</a> <em class="jxr_javadoccomment"> * @param req - Describes the current request. A Plugin might use it to find any appropriate cookies </em> +<a name="82" href="#82">82</a> <em class="jxr_javadoccomment"> * @param res - Describes the current response. A Plugin might use it to redirect a the request. </em> +<a name="83" href="#83">83</a> <em class="jxr_javadoccomment"> * @param parameter Describes the metadata.</em> +<a name="84" href="#84">84</a> <em class="jxr_javadoccomment"> * @param context Any processing context returned from a previous call.</em> +<a name="85" href="#85">85</a> <em class="jxr_javadoccomment"> * @param validIdps The list of IdPs which is currently views as possibly matches for the pattern. </em> +<a name="86" href="#86">86</a> <em class="jxr_javadoccomment"> * The Key is the EntityId for the IdP and the value the object which describes </em> +<a name="87" href="#87">87</a> <em class="jxr_javadoccomment"> * the Idp </em> +<a name="88" href="#88">88</a> <em class="jxr_javadoccomment"> * @param idpList The set of Idps which are currently considered as potential hints. </em> +<a name="89" href="#89">89</a> <em class="jxr_javadoccomment"> * @return a context to hand to subsequent calls</em> +<a name="90" href="#90">90</a> <em class="jxr_javadoccomment"> * @throws WayfRequestHandled if the plugin has handled the request (for instance it has</em> +<a name="91" href="#91">91</a> <em class="jxr_javadoccomment"> * issues a redirect)</em> +<a name="92" href="#92">92</a> <em class="jxr_javadoccomment"> *</em> +<a name="93" href="#93">93</a> <em class="jxr_javadoccomment"> * Each plugin is called multiple times,</em> +<a name="94" href="#94">94</a> <em class="jxr_javadoccomment"> * once for each metadata provider which is registered (Depending on the precise configuration of the WAYF</em> +<a name="95" href="#95">95</a> <em class="jxr_javadoccomment"> * metadata providers whose metadata does not include the target may be dropped). Initially the plugin is</em> +<a name="96" href="#96">96</a> <em class="jxr_javadoccomment"> * called with a context parameter of <code>null</code>. In subsequent calls, the value returned from</em> +<a name="97" href="#97">97</a> <em class="jxr_javadoccomment"> * the previous call is passed in as the context parameter. </em> +<a name="98" href="#98">98</a> <em class="jxr_javadoccomment"> * </em> +<a name="99" href="#99">99</a> <em class="jxr_javadoccomment"> * The plugin may remove IdPSite objects from the validIdps list.</em> +<a name="100" href="#100">100</a> <em class="jxr_javadoccomment"> * </em> +<a name="101" href="#101">101</a> <em class="jxr_javadoccomment"> * The plugin may add or remove them to the idpList. IdPSite Objects which are to be added to the idpList </em> +<a name="102" href="#102">102</a> <em class="jxr_javadoccomment"> * should be looked up by EntityIdName in validIdps by EntityId. Hence any metadata processing shoudl </em> +<a name="103" href="#103">103</a> <em class="jxr_javadoccomment"> * store the entityID. </em> +<a name="104" href="#104">104</a> <em class="jxr_javadoccomment"> * </em> +<a name="105" href="#105">105</a> <em class="jxr_javadoccomment"> */</em> +<a name="106" href="#106">106</a> <a href="../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/PluginContext.html">PluginContext</a> lookup(HttpServletRequest req, +<a name="107" href="#107">107</a> HttpServletResponse res, +<a name="108" href="#108">108</a> <a href="../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/PluginMetadataParameter.html">PluginMetadataParameter</a> parameter, +<a name="109" href="#109">109</a> Map<String, IdPSite> validIdps, +<a name="110" href="#110">110</a> <a href="../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/PluginContext.html">PluginContext</a> context, +<a name="111" href="#111">111</a> List<IdPSite> idpList) <strong class="jxr_keyword">throws</strong> WayfRequestHandled; +<a name="112" href="#112">112</a> +<a name="113" href="#113">113</a> <em class="jxr_javadoccomment">/**</em> +<a name="114" href="#114">114</a> <em class="jxr_javadoccomment"> * This method is called when the user specified a search operation. The processing is similar to </em> +<a name="115" href="#115">115</a> <em class="jxr_javadoccomment"> * that described for {@link #lookup lookup}.</em> +<a name="116" href="#116">116</a> <em class="jxr_javadoccomment"> * Two additional paramaters are provided, the search parameter which was provided, and the current </em> +<a name="117" href="#117">117</a> <em class="jxr_javadoccomment"> * proposed list of candidate IdPs. The plugin is at liberty to alter both the list of hints and the </em> +<a name="118" href="#118">118</a> <em class="jxr_javadoccomment"> * list of valid IdPs. </em> +<a name="119" href="#119">119</a> <em class="jxr_javadoccomment"> * </em> +<a name="120" href="#120">120</a> <em class="jxr_javadoccomment"> * @param req Describes the current request. The Plugin could use it to find any appropriate cookies </em> +<a name="121" href="#121">121</a> <em class="jxr_javadoccomment"> * @param res Describes the result - this is needed if (for instance) a plung needs to change cookie values</em> +<a name="122" href="#122">122</a> <em class="jxr_javadoccomment"> * @param parameter Describes the metadata</em> +<a name="123" href="#123">123</a> <em class="jxr_javadoccomment"> * @param pattern The Search pattern provided</em> +<a name="124" href="#124">124</a> <em class="jxr_javadoccomment"> * @param validIdps The list of IdPs which is currently views as possibly matches for the pattern. </em> +<a name="125" href="#125">125</a> <em class="jxr_javadoccomment"> * The Key is the Idp Name an the value the idp</em> +<a name="126" href="#126">126</a> <em class="jxr_javadoccomment"> * @param context Any processing context returned from a previous call.</em> +<a name="127" href="#127">127</a> <em class="jxr_javadoccomment"> * @param searchResult the resukt of any search</em> +<a name="128" href="#128">128</a> <em class="jxr_javadoccomment"> * @param idpList The set of Idps which are currently considered as potential hints. Each Idp is associated</em> +<a name="129" href="#129">129</a> <em class="jxr_javadoccomment"> * with a numeric weight, where the lower the number is the more likely the IdP is to be a candidate. </em> +<a name="130" href="#130">130</a> <em class="jxr_javadoccomment"> * As descibed above the WAYF uses this to provide hint list to the GUI (or even to dispatch </em> +<a name="131" href="#131">131</a> <em class="jxr_javadoccomment"> * immediately to the IdP). </em> +<a name="132" href="#132">132</a> <em class="jxr_javadoccomment"> * @return a context to hand to subsequent calls</em> +<a name="133" href="#133">133</a> <em class="jxr_javadoccomment"> * @throws WayfRequestHandled if the plugin has handled the request (for instance it has</em> +<a name="134" href="#134">134</a> <em class="jxr_javadoccomment"> * issues a redirect)</em> +<a name="135" href="#135">135</a> <em class="jxr_javadoccomment"> */</em> +<a name="136" href="#136">136</a> <a href="../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/PluginContext.html">PluginContext</a> search(HttpServletRequest req, +<a name="137" href="#137">137</a> HttpServletResponse res, +<a name="138" href="#138">138</a> <a href="../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/PluginMetadataParameter.html">PluginMetadataParameter</a> parameter, +<a name="139" href="#139">139</a> String pattern, +<a name="140" href="#140">140</a> Map<String, IdPSite> validIdps, +<a name="141" href="#141">141</a> <a href="../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/PluginContext.html">PluginContext</a> context, +<a name="142" href="#142">142</a> Collection<IdPSite> searchResult, +<a name="143" href="#143">143</a> List<IdPSite> idpList) <strong class="jxr_keyword">throws</strong> WayfRequestHandled; +<a name="144" href="#144">144</a> +<a name="145" href="#145">145</a> <em class="jxr_javadoccomment">/**</em> +<a name="146" href="#146">146</a> <em class="jxr_javadoccomment"> * This method is called, for every plugin, after a user has selected an IdP. The plugin is expected </em> +<a name="147" href="#147">147</a> <em class="jxr_javadoccomment"> * to use it to update any in memory state (via the {@link PluginMetadataParameter} parameter or permananent </em> +<a name="148" href="#148">148</a> <em class="jxr_javadoccomment"> * state (for instance by writing back a cookie.</em> +<a name="149" href="#149">149</a> <em class="jxr_javadoccomment"> * @param req Describes the current request. </em> +<a name="150" href="#150">150</a> <em class="jxr_javadoccomment"> * @param res Describes the current response</em> +<a name="151" href="#151">151</a> <em class="jxr_javadoccomment"> * @param parameter Describes the metadata</em> +<a name="152" href="#152">152</a> <em class="jxr_javadoccomment"> * @throws WayfRequestHandled if the plugin has handled the request (for instance it has</em> +<a name="153" href="#153">153</a> <em class="jxr_javadoccomment"> * issues a redirect)</em> +<a name="154" href="#154">154</a> <em class="jxr_javadoccomment"> */</em> +<a name="155" href="#155">155</a> <strong class="jxr_keyword">void</strong> selected(HttpServletRequest req, +<a name="156" href="#156">156</a> HttpServletResponse res, +<a name="157" href="#157">157</a> <a href="../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/PluginMetadataParameter.html">PluginMetadataParameter</a> parameter, +<a name="158" href="#158">158</a> String idP) <strong class="jxr_keyword">throws</strong> WayfRequestHandled; +<a name="159" href="#159">159</a> } +</pre> +<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> +</html> + diff --git a/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/plugins/PluginContext.html b/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/plugins/PluginContext.html new file mode 100644 index 0000000..23967b7 --- /dev/null +++ b/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/plugins/PluginContext.html @@ -0,0 +1,45 @@ +<!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>PluginContext 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/PluginContext.html">View Javadoc</a></div><pre> + +<a name="1" href="#1">1</a> <em class="jxr_javadoccomment">/**</em> +<a name="2" href="#2">2</a> <em class="jxr_javadoccomment"> * Copyright [2006] [University Corporation for Advanced Internet Development, Inc.]</em> +<a name="3" href="#3">3</a> <em class="jxr_javadoccomment"> *</em> +<a name="4" href="#4">4</a> <em class="jxr_javadoccomment"> * Licensed under the Apache License, Version 2.0 (the "License");</em> +<a name="5" href="#5">5</a> <em class="jxr_javadoccomment"> * you may not use this file except in compliance with the License.</em> +<a name="6" href="#6">6</a> <em class="jxr_javadoccomment"> * You may obtain a copy of the License at</em> +<a name="7" href="#7">7</a> <em class="jxr_javadoccomment"> *</em> +<a name="8" href="#8">8</a> <em class="jxr_javadoccomment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em> +<a name="9" href="#9">9</a> <em class="jxr_javadoccomment"> *</em> +<a name="10" href="#10">10</a> <em class="jxr_javadoccomment"> * Unless required by applicable law or agreed to in writing, software</em> +<a name="11" href="#11">11</a> <em class="jxr_javadoccomment"> * distributed under the License is distributed on an "AS IS" BASIS,</em> +<a name="12" href="#12">12</a> <em class="jxr_javadoccomment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em> +<a name="13" href="#13">13</a> <em class="jxr_javadoccomment"> * See the License for the specific language governing permissions and</em> +<a name="14" href="#14">14</a> <em class="jxr_javadoccomment"> * limitations under the License.</em> +<a name="15" href="#15">15</a> <em class="jxr_javadoccomment"> */</em> +<a name="16" href="#16">16</a> +<a name="17" href="#17">17</a> <strong class="jxr_keyword">package</strong> edu.internet2.middleware.shibboleth.wayf.plugins; +<a name="18" href="#18">18</a> +<a name="19" href="#19">19</a> <em class="jxr_javadoccomment">/**</em> +<a name="20" href="#20">20</a> <em class="jxr_javadoccomment"> * This is a marker interface.</em> +<a name="21" href="#21">21</a> <em class="jxr_javadoccomment"> * <p></em> +<a name="22" href="#22">22</a> <em class="jxr_javadoccomment"> * Objects which implement PluginContext are passed between sucessive calls to a plugins implementations of</em> +<a name="23" href="#23">23</a> <em class="jxr_javadoccomment"> * {@link Plugin#lookup lookup} and {@link Plugin#search search} as the plugin </em> +<a name="24" href="#24">24</a> <em class="jxr_javadoccomment"> * is called for each {@link org.opensaml.saml2.metadata.provider.MetadataProvider}.</em> +<a name="25" href="#25">25</a> <em class="jxr_javadoccomment"> * <p></em> +<a name="26" href="#26">26</a> <em class="jxr_javadoccomment"> * @author Rod Widdowson</em> +<a name="27" href="#27">27</a> <em class="jxr_javadoccomment"> * @version Discussion</em> +<a name="28" href="#28">28</a> <em class="jxr_javadoccomment"> */</em> +<a name="29" href="#29">29</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> <a href="../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/PluginContext.html">PluginContext</a> { +<a name="30" href="#30">30</a> +<a name="31" href="#31">31</a> } +</pre> +<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> +</html> + diff --git a/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/plugins/PluginMetadataParameter.html b/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/plugins/PluginMetadataParameter.html new file mode 100644 index 0000000..e07d9e0 --- /dev/null +++ b/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/plugins/PluginMetadataParameter.html @@ -0,0 +1,44 @@ +<!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>PluginMetadataParameter 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/PluginMetadataParameter.html">View Javadoc</a></div><pre> + +<a name="1" href="#1">1</a> <em class="jxr_javadoccomment">/**</em> +<a name="2" href="#2">2</a> <em class="jxr_javadoccomment"> * Copyright [2006] [University Corporation for Advanced Internet Development, Inc.]</em> +<a name="3" href="#3">3</a> <em class="jxr_javadoccomment"> *</em> +<a name="4" href="#4">4</a> <em class="jxr_javadoccomment"> * Licensed under the Apache License, Version 2.0 (the "License");</em> +<a name="5" href="#5">5</a> <em class="jxr_javadoccomment"> * you may not use this file except in compliance with the License.</em> +<a name="6" href="#6">6</a> <em class="jxr_javadoccomment"> * You may obtain a copy of the License at</em> +<a name="7" href="#7">7</a> <em class="jxr_javadoccomment"> *</em> +<a name="8" href="#8">8</a> <em class="jxr_javadoccomment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em> +<a name="9" href="#9">9</a> <em class="jxr_javadoccomment"> *</em> +<a name="10" href="#10">10</a> <em class="jxr_javadoccomment"> * Unless required by applicable law or agreed to in writing, software</em> +<a name="11" href="#11">11</a> <em class="jxr_javadoccomment"> * distributed under the License is distributed on an "AS IS" BASIS,</em> +<a name="12" href="#12">12</a> <em class="jxr_javadoccomment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em> +<a name="13" href="#13">13</a> <em class="jxr_javadoccomment"> * See the License for the specific language governing permissions and</em> +<a name="14" href="#14">14</a> <em class="jxr_javadoccomment"> * limitations under the License.</em> +<a name="15" href="#15">15</a> <em class="jxr_javadoccomment"> */</em> +<a name="16" href="#16">16</a> <strong class="jxr_keyword">package</strong> edu.internet2.middleware.shibboleth.wayf.plugins; +<a name="17" href="#17">17</a> +<a name="18" href="#18">18</a> +<a name="19" href="#19">19</a> <em class="jxr_javadoccomment">/**</em> +<a name="20" href="#20">20</a> <em class="jxr_javadoccomment"> * The PluginParameter is a marker interface which a WAYF {@link Plugin} can use to associate extra information </em> +<a name="21" href="#21">21</a> <em class="jxr_javadoccomment"> * with the metadata. Each plugin returns a PluginParameter from {@link Plugin#refreshMetadata RefreshMetadata}</em> +<a name="22" href="#22">22</a> <em class="jxr_javadoccomment"> * and this is in turn presented back to then Plugin when it is called during WAYF processing. </em> +<a name="23" href="#23">23</a> <em class="jxr_javadoccomment"> * <p></em> +<a name="24" href="#24">24</a> <em class="jxr_javadoccomment"> * @author Rod Widdowson</em> +<a name="25" href="#25">25</a> <em class="jxr_javadoccomment"> * @version Discussion</em> +<a name="26" href="#26">26</a> <em class="jxr_javadoccomment"> *</em> +<a name="27" href="#27">27</a> <em class="jxr_javadoccomment"> */</em> +<a name="28" href="#28">28</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> <a href="../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/PluginMetadataParameter.html">PluginMetadataParameter</a> { +<a name="29" href="#29">29</a> +<a name="30" href="#30">30</a> } +</pre> +<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> +</html> + diff --git a/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/plugins/WayfRequestHandled.html b/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/plugins/WayfRequestHandled.html new file mode 100644 index 0000000..bb9d473 --- /dev/null +++ b/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/plugins/WayfRequestHandled.html @@ -0,0 +1,31 @@ +<!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>WayfRequestHandled 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/WayfRequestHandled.html">View Javadoc</a></div><pre> + +<a name="1" href="#1">1</a> <strong class="jxr_keyword">package</strong> edu.internet2.middleware.shibboleth.wayf.plugins; +<a name="2" href="#2">2</a> +<a name="3" href="#3">3</a> <em class="jxr_javadoccomment">/**</em> +<a name="4" href="#4">4</a> <em class="jxr_javadoccomment"> * </em> +<a name="5" href="#5">5</a> <em class="jxr_javadoccomment"> * This Exception can be signalled by a plugin to indicate to the WAYF that it has handled the </em> +<a name="6" href="#6">6</a> <em class="jxr_javadoccomment"> * request and all processing should stop.</em> +<a name="7" href="#7">7</a> <em class="jxr_javadoccomment"> * </em> +<a name="8" href="#8">8</a> <em class="jxr_javadoccomment"> * @author Rod Widdowson</em> +<a name="9" href="#9">9</a> <em class="jxr_javadoccomment"> */</em> +<a name="10" href="#10">10</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/WayfRequestHandled.html">WayfRequestHandled</a> <strong class="jxr_keyword">extends</strong> Exception { +<a name="11" href="#11">11</a> +<a name="12" href="#12">12</a> <em class="jxr_javadoccomment">/**</em> +<a name="13" href="#13">13</a> <em class="jxr_javadoccomment"> * Required Serialization constant.</em> +<a name="14" href="#14">14</a> <em class="jxr_javadoccomment"> */</em> +<a name="15" href="#15">15</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">long</strong> serialVersionUID = 3022489208153734092L; +<a name="16" href="#16">16</a> +<a name="17" href="#17">17</a> } +</pre> +<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> +</html> + diff --git a/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/plugins/package-frame.html b/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/plugins/package-frame.html new file mode 100644 index 0000000..856f7b5 --- /dev/null +++ b/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/plugins/package-frame.html @@ -0,0 +1,33 @@ +
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "DTD/xhtml1-transitional.dtd">
+<html xml:lang="en" lang="en">
+ <head>
+ <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
+ <title>Shibboleth Discovery Service 1.1.0 Reference Package edu.internet2.middleware.shibboleth.wayf.plugins</title>
+ <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="style" />
+ </head>
+ <body>
+
+ <h3>
+ <a href="package-summary.html" target="classFrame">edu.internet2.middleware.shibboleth.wayf.plugins</a>
+ </h3>
+
+ <h3>Classes</h3>
+
+ <ul>
+ <li>
+ <a href="Plugin.html" target="classFrame">Plugin</a>
+ </li>
+ <li>
+ <a href="PluginContext.html" target="classFrame">PluginContext</a>
+ </li>
+ <li>
+ <a href="PluginMetadataParameter.html" target="classFrame">PluginMetadataParameter</a>
+ </li>
+ <li>
+ <a href="WayfRequestHandled.html" target="classFrame">WayfRequestHandled</a>
+ </li>
+ </ul>
+
+ </body>
+</html>
\ No newline at end of file diff --git a/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/plugins/package-summary.html b/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/plugins/package-summary.html new file mode 100644 index 0000000..2c26dfd --- /dev/null +++ b/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/plugins/package-summary.html @@ -0,0 +1,82 @@ +
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "DTD/xhtml1-transitional.dtd">
+<html xml:lang="en" lang="en">
+ <head>
+ <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
+ <title>Shibboleth Discovery Service 1.1.0 Reference Package edu.internet2.middleware.shibboleth.wayf.plugins</title>
+ <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="style" />
+ </head>
+ <body>
+ <div class="overview">
+ <ul>
+ <li>
+ <a href="../../../../../../overview-summary.html">Overview</a>
+ </li>
+ <li class="selected">Package</li>
+ </ul>
+ </div>
+ <div class="framenoframe">
+ <ul>
+ <li>
+ <a href="../../../../../../index.html" target="_top">FRAMES</a>
+ </li>
+ <li>
+ <a href="package-summary.html" target="_top">NO FRAMES</a>
+ </li>
+ </ul>
+ </div>
+
+ <h2>Package edu.internet2.middleware.shibboleth.wayf.plugins</h2>
+
+ <table class="summary">
+ <thead>
+ <tr>
+ <th>Class Summary</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ <a href="Plugin.html" target="classFrame">Plugin</a>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <a href="PluginContext.html" target="classFrame">PluginContext</a>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <a href="PluginMetadataParameter.html" target="classFrame">PluginMetadataParameter</a>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <a href="WayfRequestHandled.html" target="classFrame">WayfRequestHandled</a>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
+ <div class="overview">
+ <ul>
+ <li>
+ <a href="../../../../../../overview-summary.html">Overview</a>
+ </li>
+ <li class="selected">Package</li>
+ </ul>
+ </div>
+ <div class="framenoframe">
+ <ul>
+ <li>
+ <a href="../../../../../../index.html" target="_top">FRAMES</a>
+ </li>
+ <li>
+ <a href="package-summary.html" target="_top">NO FRAMES</a>
+ </li>
+ </ul>
+ </div>
+ <hr />
+ Copyright © 2006-2009 Internet2. All Rights Reserved.
+ </body>
+</html>
\ No newline at end of file diff --git a/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/plugins/provider/BindingFilter.html b/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/plugins/provider/BindingFilter.html new file mode 100644 index 0000000..9a234f3 --- /dev/null +++ b/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/plugins/provider/BindingFilter.html @@ -0,0 +1,190 @@ +<!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>BindingFilter 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/BindingFilter.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 2008 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.plugins.provider; +<a name="18" href="#18">18</a> +<a name="19" href="#19">19</a> <strong class="jxr_keyword">import</strong> java.util.Iterator; +<a name="20" href="#20">20</a> <strong class="jxr_keyword">import</strong> java.util.List; +<a name="21" href="#21">21</a> +<a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> org.opensaml.saml2.common.Extensions; +<a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> org.opensaml.saml2.metadata.EntitiesDescriptor; +<a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> org.opensaml.saml2.metadata.EntityDescriptor; +<a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> org.opensaml.saml2.metadata.RoleDescriptor; +<a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> org.opensaml.saml2.metadata.SPSSODescriptor; +<a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> org.opensaml.saml2.metadata.provider.FilterException; +<a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> org.opensaml.saml2.metadata.provider.MetadataFilter; +<a name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> org.opensaml.xml.XMLObject; +<a name="30" href="#30">30</a> <strong class="jxr_keyword">import</strong> org.slf4j.Logger; +<a name="31" href="#31">31</a> <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory; +<a name="32" href="#32">32</a> +<a name="33" href="#33">33</a> <strong class="jxr_keyword">import</strong> edu.internet2.middleware.shibboleth.wayf.DiscoveryResponseImpl; +<a name="34" href="#34">34</a> <strong class="jxr_keyword">import</strong> edu.internet2.middleware.shibboleth.wayf.HandlerConfig; +<a name="35" href="#35">35</a> +<a name="36" href="#36">36</a> <em class="jxr_javadoccomment">/**</em> +<a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * See SDSJ-48. If we get a DS endpoint then we need to check that the binding is provided</em> +<a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * and that it is correct.</em> +<a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * </em> +<a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * @author Rod Widdowson</em> +<a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> *</em> +<a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> */</em> +<a name="43" href="#43">43</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/provider/BindingFilter.html">BindingFilter</a> implements MetadataFilter { +<a name="44" href="#44">44</a> +<a name="45" href="#45">45</a> <em class="jxr_javadoccomment">/**</em> +<a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * Log for the warning. </em> +<a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> */</em> +<a name="48" href="#48">48</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Logger LOG = LoggerFactory.getLogger(BindingFilter.<strong class="jxr_keyword">class</strong>.getName()); +<a name="49" href="#49">49</a> +<a name="50" href="#50">50</a> <em class="jxr_javadoccomment">/**</em> +<a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * Set if we just want to warn on failure.</em> +<a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> */</em> +<a name="53" href="#53">53</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> warnOnFailure; +<a name="54" href="#54">54</a> +<a name="55" href="#55">55</a> <em class="jxr_javadoccomment">/**</em> +<a name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * Only the protected constructor should be visible.</em> +<a name="57" href="#57">57</a> <em class="jxr_javadoccomment"> */</em> +<a name="58" href="#58">58</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/provider/BindingFilter.html">BindingFilter</a>() { +<a name="59" href="#59">59</a> <strong class="jxr_keyword">this</strong>.warnOnFailure = false; +<a name="60" href="#60">60</a> } +<a name="61" href="#61">61</a> +<a name="62" href="#62">62</a> <em class="jxr_javadoccomment">/**</em> +<a name="63" href="#63">63</a> <em class="jxr_javadoccomment"> * Initialize the filter.</em> +<a name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * @param warn do we warn or do we fail if we see badness?</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> <a href="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/provider/BindingFilter.html">BindingFilter</a>(<strong class="jxr_keyword">boolean</strong> warn) { +<a name="67" href="#67">67</a> <strong class="jxr_keyword">this</strong>.warnOnFailure = warn; +<a name="68" href="#68">68</a> } +<a name="69" href="#69">69</a> +<a name="70" href="#70">70</a> <em class="jxr_javadoccomment">/**</em> +<a name="71" href="#71">71</a> <em class="jxr_javadoccomment"> * Apply the filter.</em> +<a name="72" href="#72">72</a> <em class="jxr_javadoccomment"> * @see org.opensaml.saml2.metadata.provider.MetadataFilter#doFilter(org.opensaml.xml.XMLObject)</em> +<a name="73" href="#73">73</a> <em class="jxr_javadoccomment"> * @param metadata what to filter.</em> +<a name="74" href="#74">74</a> <em class="jxr_javadoccomment"> * @throws FilterException if it sees any missed or bad bindings.</em> +<a name="75" href="#75">75</a> <em class="jxr_javadoccomment"> */</em> +<a name="76" href="#76">76</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> doFilter(XMLObject metadata) <strong class="jxr_keyword">throws</strong> FilterException { +<a name="77" href="#77">77</a> +<a name="78" href="#78">78</a> <strong class="jxr_keyword">if</strong> (metadata instanceof EntitiesDescriptor) { +<a name="79" href="#79">79</a> +<a name="80" href="#80">80</a> checkEntities((EntitiesDescriptor) metadata); +<a name="81" href="#81">81</a> +<a name="82" href="#82">82</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (metadata instanceof EntityDescriptor) { +<a name="83" href="#83">83</a> EntityDescriptor entity = (EntityDescriptor) metadata; +<a name="84" href="#84">84</a> +<a name="85" href="#85">85</a> <strong class="jxr_keyword">if</strong> (!checkEntity(entity)) { +<a name="86" href="#86">86</a> <strong class="jxr_keyword">if</strong> (warnOnFailure) { +<a name="87" href="#87">87</a> LOG.warn(<span class="jxr_string">"Badly formatted binding for "</span> + entity.getEntityID()); +<a name="88" href="#88">88</a> } <strong class="jxr_keyword">else</strong> { +<a name="89" href="#89">89</a> LOG.error(<span class="jxr_string">"Badly formatted binding for top level entity "</span> + entity.getEntityID()); +<a name="90" href="#90">90</a> } +<a name="91" href="#91">91</a> } +<a name="92" href="#92">92</a> } +<a name="93" href="#93">93</a> } +<a name="94" href="#94">94</a> +<a name="95" href="#95">95</a> <em class="jxr_javadoccomment">/**</em> +<a name="96" href="#96">96</a> <em class="jxr_javadoccomment"> * If the entity has an SP characteristic, and it has a DS endpoint</em> +<a name="97" href="#97">97</a> <em class="jxr_javadoccomment"> * then check its binding.</em> +<a name="98" href="#98">98</a> <em class="jxr_javadoccomment"> * </em> +<a name="99" href="#99">99</a> <em class="jxr_javadoccomment"> * @param entity what to check.</em> +<a name="100" href="#100">100</a> <em class="jxr_javadoccomment"> * @return true if all is OK.</em> +<a name="101" href="#101">101</a> <em class="jxr_javadoccomment"> */</em> +<a name="102" href="#102">102</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">boolean</strong> checkEntity(EntityDescriptor entity) { +<a name="103" href="#103">103</a> List<RoleDescriptor> roles = entity.getRoleDescriptors(); +<a name="104" href="#104">104</a> +<a name="105" href="#105">105</a> <strong class="jxr_keyword">for</strong> (RoleDescriptor role:roles) { +<a name="106" href="#106">106</a> +<a name="107" href="#107">107</a> <em class="jxr_comment">//</em> +<a name="108" href="#108">108</a> <em class="jxr_comment">// Check every role</em> +<a name="109" href="#109">109</a> <em class="jxr_comment">//</em> +<a name="110" href="#110">110</a> <strong class="jxr_keyword">if</strong> (role instanceof SPSSODescriptor) { +<a name="111" href="#111">111</a> +<a name="112" href="#112">112</a> <em class="jxr_comment">//</em> +<a name="113" href="#113">113</a> <em class="jxr_comment">// Grab hold of all the extensions for SPSSO descriptors</em> +<a name="114" href="#114">114</a> <em class="jxr_comment">//</em> +<a name="115" href="#115">115</a> +<a name="116" href="#116">116</a> Extensions exts = role.getExtensions(); +<a name="117" href="#117">117</a> <strong class="jxr_keyword">if</strong> (exts != <strong class="jxr_keyword">null</strong>) { +<a name="118" href="#118">118</a> <em class="jxr_comment">//</em> +<a name="119" href="#119">119</a> <em class="jxr_comment">// We have some children check them form <DiscoveryResponse></em> +<a name="120" href="#120">120</a> <em class="jxr_comment">//</em> +<a name="121" href="#121">121</a> List<XMLObject> children = exts.getOrderedChildren(); +<a name="122" href="#122">122</a> +<a name="123" href="#123">123</a> <strong class="jxr_keyword">for</strong> (XMLObject obj : children) { +<a name="124" href="#124">124</a> <strong class="jxr_keyword">if</strong> (obj instanceof DiscoveryResponseImpl) { +<a name="125" href="#125">125</a> <em class="jxr_comment">//</em> +<a name="126" href="#126">126</a> <em class="jxr_comment">// And check or the binding</em> +<a name="127" href="#127">127</a> <em class="jxr_comment">//</em> +<a name="128" href="#128">128</a> <a href="../../../../../../../edu/internet2/middleware/shibboleth/wayf/DiscoveryResponseImpl.html">DiscoveryResponseImpl</a> ds = (DiscoveryResponseImpl) obj; +<a name="129" href="#129">129</a> String binding = ds.getBinding(); +<a name="130" href="#130">130</a> +<a name="131" href="#131">131</a> <strong class="jxr_keyword">if</strong> (!DiscoveryResponseImpl.METADATA_NS.equals(binding)) { +<a name="132" href="#132">132</a> <strong class="jxr_keyword">return</strong> false; +<a name="133" href="#133">133</a> } +<a name="134" href="#134">134</a> } +<a name="135" href="#135">135</a> } +<a name="136" href="#136">136</a> } +<a name="137" href="#137">137</a> } +<a name="138" href="#138">138</a> } +<a name="139" href="#139">139</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>; +<a name="140" href="#140">140</a> } +<a name="141" href="#141">141</a> +<a name="142" href="#142">142</a> <em class="jxr_javadoccomment">/**</em> +<a name="143" href="#143">143</a> <em class="jxr_javadoccomment"> * Check an EntitiesDescriptor call checkentities for the Entities and ourselves</em> +<a name="144" href="#144">144</a> <em class="jxr_javadoccomment"> * recursively for the EntitesDescriptors.</em> +<a name="145" href="#145">145</a> <em class="jxr_javadoccomment"> * </em> +<a name="146" href="#146">146</a> <em class="jxr_javadoccomment"> * @param entities what to check.</em> +<a name="147" href="#147">147</a> <em class="jxr_javadoccomment"> */</em> +<a name="148" href="#148">148</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> checkEntities(EntitiesDescriptor entities) { +<a name="149" href="#149">149</a> List<EntitiesDescriptor> childEntities = entities.getEntitiesDescriptors(); +<a name="150" href="#150">150</a> List<EntityDescriptor> children = entities.getEntityDescriptors(); +<a name="151" href="#151">151</a> +<a name="152" href="#152">152</a> <strong class="jxr_keyword">if</strong> (children != <strong class="jxr_keyword">null</strong>) { +<a name="153" href="#153">153</a> Iterator<EntityDescriptor> itr; +<a name="154" href="#154">154</a> EntityDescriptor entity; +<a name="155" href="#155">155</a> itr = children.iterator(); +<a name="156" href="#156">156</a> +<a name="157" href="#157">157</a> <strong class="jxr_keyword">while</strong> (itr.hasNext()) { +<a name="158" href="#158">158</a> entity = itr.next(); +<a name="159" href="#159">159</a> <strong class="jxr_keyword">if</strong> (!checkEntity(entity)) { +<a name="160" href="#160">160</a> <strong class="jxr_keyword">if</strong> (warnOnFailure) { +<a name="161" href="#161">161</a> LOG.warn(<span class="jxr_string">"Badly formatted binding for "</span> + entity.getEntityID()); +<a name="162" href="#162">162</a> } <strong class="jxr_keyword">else</strong> { +<a name="163" href="#163">163</a> LOG.error(<span class="jxr_string">"Badly formatted binding for "</span> + entity.getEntityID() + <span class="jxr_string">". Entity has been removed"</span>); +<a name="164" href="#164">164</a> itr.remove(); +<a name="165" href="#165">165</a> } +<a name="166" href="#166">166</a> } +<a name="167" href="#167">167</a> } +<a name="168" href="#168">168</a> } +<a name="169" href="#169">169</a> +<a name="170" href="#170">170</a> <strong class="jxr_keyword">if</strong> (childEntities != <strong class="jxr_keyword">null</strong>) { +<a name="171" href="#171">171</a> <strong class="jxr_keyword">for</strong> (EntitiesDescriptor descriptor : childEntities) { +<a name="172" href="#172">172</a> checkEntities(descriptor); +<a name="173" href="#173">173</a> } +<a name="174" href="#174">174</a> } +<a name="175" href="#175">175</a> } +<a name="176" href="#176">176</a> } +</pre> +<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> +</html> + diff --git a/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/plugins/provider/ListFilter.html b/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/plugins/provider/ListFilter.html new file mode 100644 index 0000000..270ec3e --- /dev/null +++ b/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/plugins/provider/ListFilter.html @@ -0,0 +1,198 @@ +<!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>ListFilter 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/ListFilter.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 2008 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.plugins.provider; +<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> <strong class="jxr_keyword">import</strong> java.util.Iterator; +<a name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> java.util.List; +<a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> java.util.Set; +<a name="23" href="#23">23</a> +<a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> org.opensaml.saml2.metadata.EntitiesDescriptor; +<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.provider.FilterException; +<a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> org.opensaml.saml2.metadata.provider.MetadataFilter; +<a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> org.opensaml.xml.XMLObject; +<a name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> org.slf4j.Logger; +<a name="30" href="#30">30</a> <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory; +<a name="31" href="#31">31</a> <strong class="jxr_keyword">import</strong> org.w3c.dom.Element; +<a name="32" href="#32">32</a> <strong class="jxr_keyword">import</strong> org.w3c.dom.NodeList; +<a name="33" href="#33">33</a> +<a name="34" href="#34">34</a> <strong class="jxr_keyword">import</strong> edu.internet2.middleware.shibboleth.wayf.HandlerConfig; +<a name="35" href="#35">35</a> <strong class="jxr_keyword">import</strong> edu.internet2.middleware.shibboleth.wayf.XMLConstants; +<a name="36" href="#36">36</a> +<a name="37" href="#37">37</a> <em class="jxr_javadoccomment">/**</em> +<a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * See SDSJ-57. Explicit </em> +<a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * </em> +<a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * @author Rod Widdowson</em> +<a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> *</em> +<a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> */</em> +<a name="43" href="#43">43</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/provider/ListFilter.html">ListFilter</a> implements MetadataFilter { +<a name="44" href="#44">44</a> +<a name="45" href="#45">45</a> <em class="jxr_javadoccomment">/**</em> +<a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * Log for any messages.</em> +<a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> */</em> +<a name="48" href="#48">48</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Logger LOG = LoggerFactory.getLogger(ListFilter.<strong class="jxr_keyword">class</strong>.getName()); +<a name="49" href="#49">49</a> +<a name="50" href="#50">50</a> <em class="jxr_javadoccomment">/**</em> +<a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * Set if this is a blacklist.</em> +<a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> */</em> +<a name="53" href="#53">53</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> excludeEntries; +<a name="54" href="#54">54</a> +<a name="55" href="#55">55</a> <em class="jxr_javadoccomment">/**</em> +<a name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * The list of entities.</em> +<a name="57" href="#57">57</a> <em class="jxr_javadoccomment"> */</em> +<a name="58" href="#58">58</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> Set<String> filterEntities; +<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"> * The name of the filter (needed for debug).</em> +<a name="62" href="#62">62</a> <em class="jxr_javadoccomment"> */</em> +<a name="63" href="#63">63</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> String filterName; +<a name="64" href="#64">64</a> +<a name="65" href="#65">65</a> <em class="jxr_javadoccomment">/**</em> +<a name="66" href="#66">66</a> <em class="jxr_javadoccomment"> * Only the protected constructor should be visible.</em> +<a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> */</em> +<a name="68" href="#68">68</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/provider/ListFilter.html">ListFilter</a>() { +<a name="69" href="#69">69</a> <strong class="jxr_keyword">this</strong>.excludeEntries = false; +<a name="70" href="#70">70</a> <strong class="jxr_keyword">this</strong>.filterEntities = <strong class="jxr_keyword">new</strong> HashSet<String>(0); +<a name="71" href="#71">71</a> <strong class="jxr_keyword">this</strong>.filterName = <span class="jxr_string">"anonymous"</span>; +<a name="72" href="#72">72</a> } +<a name="73" href="#73">73</a> +<a name="74" href="#74">74</a> <em class="jxr_javadoccomment">/**</em> +<a name="75" href="#75">75</a> <em class="jxr_javadoccomment"> * Initialize the filter.</em> +<a name="76" href="#76">76</a> <em class="jxr_javadoccomment"> * @param config the configuration</em> +<a name="77" href="#77">77</a> <em class="jxr_javadoccomment"> *</em> +<a name="78" href="#78">78</a> <em class="jxr_javadoccomment"> * The configuration looks liken this</em> +<a name="79" href="#79">79</a> <em class="jxr_javadoccomment"> * <code> <Filter identifier="WhiteList" </em> +<a name="80" href="#80">80</a> <em class="jxr_javadoccomment"> * type ="edu.internet2.middleware.shibboleth.wayf.plugins.provider.ListFilter"</em> +<a name="81" href="#81">81</a> <em class="jxr_javadoccomment"> * excludeEntries = "true" ></em> +<a name="82" href="#82">82</a> <em class="jxr_javadoccomment"> * <EntityId>foo</EntityId></em> +<a name="83" href="#83">83</a> <em class="jxr_javadoccomment"> * [...]</em> +<a name="84" href="#84">84</a> <em class="jxr_javadoccomment"> * </Filter></em> +<a name="85" href="#85">85</a> <em class="jxr_javadoccomment"> * </code></em> +<a name="86" href="#86">86</a> <em class="jxr_javadoccomment"> */</em> +<a name="87" href="#87">87</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/provider/ListFilter.html">ListFilter</a>(Element config) { +<a name="88" href="#88">88</a> String excludeEntriesValue; +<a name="89" href="#89">89</a> <strong class="jxr_keyword">this</strong>.filterEntities = <strong class="jxr_keyword">new</strong> HashSet<String>(10); +<a name="90" href="#90">90</a> <strong class="jxr_keyword">this</strong>.filterName = config.getAttribute(<span class="jxr_string">"identifier"</span>); +<a name="91" href="#91">91</a> excludeEntriesValue = config.getAttribute(<span class="jxr_string">"excludeEntries"</span>); +<a name="92" href="#92">92</a> +<a name="93" href="#93">93</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">null</strong> == excludeEntriesValue || 0 == excludeEntriesValue.length()) { +<a name="94" href="#94">94</a> <strong class="jxr_keyword">this</strong>.excludeEntries = <strong class="jxr_keyword">true</strong>; +<a name="95" href="#95">95</a> } <strong class="jxr_keyword">else</strong> { +<a name="96" href="#96">96</a> <strong class="jxr_keyword">this</strong>.excludeEntries = Boolean.getBoolean(excludeEntriesValue); +<a name="97" href="#97">97</a> } +<a name="98" href="#98">98</a> +<a name="99" href="#99">99</a> NodeList itemElements = config.getElementsByTagNameNS(XMLConstants.CONFIG_NS, <span class="jxr_string">"EntityId"</span>); +<a name="100" href="#100">100</a> +<a name="101" href="#101">101</a> <strong class="jxr_keyword">if</strong> (excludeEntries) { +<a name="102" href="#102">102</a> LOG.debug(<span class="jxr_string">"Populating blacklist "</span> + filterName); +<a name="103" href="#103">103</a> } <strong class="jxr_keyword">else</strong> { +<a name="104" href="#104">104</a> LOG.debug(<span class="jxr_string">"Populating whitelist "</span> + filterName); +<a name="105" href="#105">105</a> } +<a name="106" href="#106">106</a> +<a name="107" href="#107">107</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i < itemElements.getLength(); i++) { +<a name="108" href="#108">108</a> Element element = (Element) itemElements.item(i); +<a name="109" href="#109">109</a> String entityId = element.getTextContent(); +<a name="110" href="#110">110</a> +<a name="111" href="#111">111</a> LOG.debug(<span class="jxr_string">"\t"</span> + entityId); +<a name="112" href="#112">112</a> <strong class="jxr_keyword">this</strong>.filterEntities.add(entityId); +<a name="113" href="#113">113</a> } +<a name="114" href="#114">114</a> } +<a name="115" href="#115">115</a> +<a name="116" href="#116">116</a> <em class="jxr_javadoccomment">/**</em> +<a name="117" href="#117">117</a> <em class="jxr_javadoccomment"> * Apply the filter.</em> +<a name="118" href="#118">118</a> <em class="jxr_javadoccomment"> * @see org.opensaml.saml2.metadata.provider.MetadataFilter#doFilter(org.opensaml.xml.XMLObject)</em> +<a name="119" href="#119">119</a> <em class="jxr_javadoccomment"> * @param metadata what to filter.</em> +<a name="120" href="#120">120</a> <em class="jxr_javadoccomment"> * @throws FilterException if it sees any missed or bad bindings.</em> +<a name="121" href="#121">121</a> <em class="jxr_javadoccomment"> */</em> +<a name="122" href="#122">122</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> doFilter(XMLObject metadata) <strong class="jxr_keyword">throws</strong> FilterException { +<a name="123" href="#123">123</a> +<a name="124" href="#124">124</a> <strong class="jxr_keyword">if</strong> (metadata instanceof EntitiesDescriptor) { +<a name="125" href="#125">125</a> filterEntities((EntitiesDescriptor)metadata); +<a name="126" href="#126">126</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (metadata instanceof EntityDescriptor) { +<a name="127" href="#127">127</a> EntityDescriptor entity = (EntityDescriptor) metadata; +<a name="128" href="#128">128</a> String entityName = entity.getEntityID(); +<a name="129" href="#129">129</a> +<a name="130" href="#130">130</a> <strong class="jxr_keyword">if</strong> (excludeEntries) { +<a name="131" href="#131">131</a> <strong class="jxr_keyword">if</strong> (filterEntities.contains(entityName)) { +<a name="132" href="#132">132</a> LOG.error(<span class="jxr_string">"Metadata provider contains a single <EntityDescriptor> ("</span> + entityName + +<a name="133" href="#133">133</a> <span class="jxr_string">") which is in exclude list"</span>); +<a name="134" href="#134">134</a> } +<a name="135" href="#135">135</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (!filterEntities.contains(entity.getEntityID())) { +<a name="136" href="#136">136</a> LOG.error(<span class="jxr_string">"Metadata provider contains a single <EntityDescriptor> ("</span> + entityName + +<a name="137" href="#137">137</a> <span class="jxr_string">") which is not on include list"</span>); +<a name="138" href="#138">138</a> } +<a name="139" href="#139">139</a> } +<a name="140" href="#140">140</a> } +<a name="141" href="#141">141</a> +<a name="142" href="#142">142</a> <em class="jxr_javadoccomment">/**</em> +<a name="143" href="#143">143</a> <em class="jxr_javadoccomment"> * Filter an EntitiesDescriptor . We do this explictly for the Entities and call ourselves</em> +<a name="144" href="#144">144</a> <em class="jxr_javadoccomment"> * recursively for the EntitesDescriptors.</em> +<a name="145" href="#145">145</a> <em class="jxr_javadoccomment"> * </em> +<a name="146" href="#146">146</a> <em class="jxr_javadoccomment"> * @param entities what to check.</em> +<a name="147" href="#147">147</a> <em class="jxr_javadoccomment"> */</em> +<a name="148" href="#148">148</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> filterEntities(EntitiesDescriptor entities) { +<a name="149" href="#149">149</a> String entitiesName = entities.getName(); +<a name="150" href="#150">150</a> List<EntitiesDescriptor> childEntities = entities.getEntitiesDescriptors(); +<a name="151" href="#151">151</a> List<EntityDescriptor> children = entities.getEntityDescriptors(); +<a name="152" href="#152">152</a> +<a name="153" href="#153">153</a> <em class="jxr_comment">//</em> +<a name="154" href="#154">154</a> <em class="jxr_comment">// Go through and apply the filter</em> +<a name="155" href="#155">155</a> <em class="jxr_comment">//</em> +<a name="156" href="#156">156</a> +<a name="157" href="#157">157</a> <strong class="jxr_keyword">if</strong> (children != <strong class="jxr_keyword">null</strong>) { +<a name="158" href="#158">158</a> Iterator<EntityDescriptor> itr; +<a name="159" href="#159">159</a> EntityDescriptor entity; +<a name="160" href="#160">160</a> itr = children.iterator(); +<a name="161" href="#161">161</a> +<a name="162" href="#162">162</a> <strong class="jxr_keyword">while</strong> (itr.hasNext()) { +<a name="163" href="#163">163</a> entity = itr.next(); +<a name="164" href="#164">164</a> String entityName = entity.getEntityID(); +<a name="165" href="#165">165</a> <strong class="jxr_keyword">if</strong> (excludeEntries) { +<a name="166" href="#166">166</a> +<a name="167" href="#167">167</a> <strong class="jxr_keyword">if</strong> (filterEntities.contains(entityName)) { +<a name="168" href="#168">168</a> LOG.debug(<span class="jxr_string">"Filter "</span> + filterName + <span class="jxr_string">": Removing blacklisted "</span> + entityName + <span class="jxr_string">" from "</span> + entitiesName); +<a name="169" href="#169">169</a> itr.remove(); +<a name="170" href="#170">170</a> } +<a name="171" href="#171">171</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (!filterEntities.contains(entityName)) { +<a name="172" href="#172">172</a> LOG.debug(<span class="jxr_string">"Filter "</span> + filterName + <span class="jxr_string">": Removing non-whitelisted "</span> + entityName + <span class="jxr_string">" from "</span> + entitiesName); +<a name="173" href="#173">173</a> itr.remove(); +<a name="174" href="#174">174</a> } +<a name="175" href="#175">175</a> } +<a name="176" href="#176">176</a> } +<a name="177" href="#177">177</a> +<a name="178" href="#178">178</a> <strong class="jxr_keyword">if</strong> (childEntities != <strong class="jxr_keyword">null</strong>) { +<a name="179" href="#179">179</a> <strong class="jxr_keyword">for</strong> (EntitiesDescriptor descriptor : childEntities) { +<a name="180" href="#180">180</a> filterEntities(descriptor); +<a name="181" href="#181">181</a> } +<a name="182" href="#182">182</a> } +<a name="183" href="#183">183</a> } +<a name="184" href="#184">184</a> } +</pre> +<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> +</html> + diff --git a/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/plugins/provider/SamlCookiePlugin.html b/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/plugins/provider/SamlCookiePlugin.html new file mode 100644 index 0000000..9e6528e --- /dev/null +++ b/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/plugins/provider/SamlCookiePlugin.html @@ -0,0 +1,558 @@ +<!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>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 name="1" href="#1">1</a> <strong class="jxr_keyword">package</strong> edu.internet2.middleware.shibboleth.wayf.plugins.provider; +<a name="2" href="#2">2</a> +<a name="3" href="#3">3</a> <strong class="jxr_keyword">import</strong> java.io.UnsupportedEncodingException; +<a name="4" href="#4">4</a> <strong class="jxr_keyword">import</strong> java.net.URLDecoder; +<a name="5" href="#5">5</a> <strong class="jxr_keyword">import</strong> java.net.URLEncoder; +<a name="6" href="#6">6</a> <strong class="jxr_keyword">import</strong> java.util.ArrayList; +<a name="7" href="#7">7</a> <strong class="jxr_keyword">import</strong> java.util.Collection; +<a name="8" href="#8">8</a> <strong class="jxr_keyword">import</strong> java.util.Iterator; +<a name="9" href="#9">9</a> <strong class="jxr_keyword">import</strong> java.util.List; +<a name="10" href="#10">10</a> <strong class="jxr_keyword">import</strong> java.util.Map; +<a name="11" href="#11">11</a> +<a name="12" href="#12">12</a> <strong class="jxr_keyword">import</strong> javax.servlet.http.Cookie; +<a name="13" href="#13">13</a> <strong class="jxr_keyword">import</strong> javax.servlet.http.HttpServletRequest; +<a name="14" href="#14">14</a> <strong class="jxr_keyword">import</strong> javax.servlet.http.HttpServletResponse; +<a name="15" href="#15">15</a> +<a name="16" href="#16">16</a> <strong class="jxr_keyword">import</strong> org.apache.log4j.Logger; +<a name="17" href="#17">17</a> <strong class="jxr_keyword">import</strong> org.opensaml.saml2.metadata.provider.MetadataProvider; +<a name="18" href="#18">18</a> <strong class="jxr_keyword">import</strong> org.opensaml.xml.util.Base64; +<a name="19" href="#19">19</a> <strong class="jxr_keyword">import</strong> org.w3c.dom.Element; +<a name="20" href="#20">20</a> +<a name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> edu.internet2.middleware.shibboleth.wayf.DiscoveryServiceHandler; +<a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> edu.internet2.middleware.shibboleth.wayf.IdPSite; +<a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> edu.internet2.middleware.shibboleth.wayf.WayfException; +<a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> edu.internet2.middleware.shibboleth.wayf.plugins.Plugin; +<a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> edu.internet2.middleware.shibboleth.wayf.plugins.PluginContext; +<a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> edu.internet2.middleware.shibboleth.wayf.plugins.PluginMetadataParameter; +<a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> edu.internet2.middleware.shibboleth.wayf.plugins.WayfRequestHandled; +<a name="28" href="#28">28</a> +<a name="29" href="#29">29</a> <em class="jxr_javadoccomment">/**</em> +<a name="30" href="#30">30</a> <em class="jxr_javadoccomment"> * This is a test implementation of the saml cookie lookup stuff to </em> +<a name="31" href="#31">31</a> <em class="jxr_javadoccomment"> * see whether it fits the plugin architecture.</em> +<a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * </em> +<a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * @author Rod Widdowson</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/plugins/provider/SamlCookiePlugin.html">SamlCookiePlugin</a> implements <a href="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/Plugin.html">Plugin</a> { +<a name="37" href="#37">37</a> +<a name="38" href="#38">38</a> <em class="jxr_javadoccomment">/**</em> +<a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * The parameter which controls the cache.</em> +<a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> */</em> +<a 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 name="42" href="#42">42</a> +<a name="43" href="#43">43</a> <em class="jxr_javadoccomment">/**</em> +<a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * Parameter to say make it last a long time.</em> +<a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> */</em> +<a 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 name="47" href="#47">47</a> +<a name="48" href="#48">48</a> <em class="jxr_javadoccomment">/**</em> +<a 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 name="50" href="#50">50</a> <em class="jxr_javadoccomment"> */</em> +<a 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 name="52" href="#52">52</a> +<a name="53" href="#53">53</a> <em class="jxr_javadoccomment">/**</em> +<a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * Handle for logging. </em> +<a name="55" href="#55">55</a> <em class="jxr_javadoccomment"> */</em> +<a 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 name="57" href="#57">57</a> +<a name="58" href="#58">58</a> <em class="jxr_javadoccomment">/**</em> +<a name="59" href="#59">59</a> <em class="jxr_javadoccomment"> * As specified in the SAML2 profiles specification.</em> +<a name="60" href="#60">60</a> <em class="jxr_javadoccomment"> */</em> +<a 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 name="62" href="#62">62</a> +<a name="63" href="#63">63</a> <em class="jxr_javadoccomment">/**</em> +<a name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * By default we keep the cookie around for a week.</em> +<a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> */</em> +<a 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 name="67" href="#67">67</a> +<a name="68" href="#68">68</a> <em class="jxr_javadoccomment">/**</em> +<a 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 name="70" href="#70">70</a> <em class="jxr_javadoccomment"> */</em> +<a name="71" href="#71">71</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> alwaysFollow; +<a name="72" href="#72">72</a> +<a name="73" href="#73">73</a> <em class="jxr_javadoccomment">/**</em> +<a name="74" href="#74">74</a> <em class="jxr_javadoccomment"> * Is our job to clean up the cookie. </em> +<a name="75" href="#75">75</a> <em class="jxr_javadoccomment"> */</em> +<a name="76" href="#76">76</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> deleteCookie; +<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"> * Lipservice towards having a common domain cookie. </em> +<a name="80" href="#80">80</a> <em class="jxr_javadoccomment"> */</em> +<a name="81" href="#81">81</a> <strong class="jxr_keyword">private</strong> String cacheDomain; +<a name="82" href="#82">82</a> +<a name="83" href="#83">83</a> <em class="jxr_javadoccomment">/**</em> +<a name="84" href="#84">84</a> <em class="jxr_javadoccomment"> * How long the cookie our will be active? </em> +<a name="85" href="#85">85</a> <em class="jxr_javadoccomment"> */</em> +<a name="86" href="#86">86</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">int</strong> cacheExpiration; +<a name="87" href="#87">87</a> +<a name="88" href="#88">88</a> <em class="jxr_javadoccomment">/**</em> +<a name="89" href="#89">89</a> <em class="jxr_javadoccomment"> * This constructor is called during wayf initialization with it's</em> +<a name="90" href="#90">90</a> <em class="jxr_javadoccomment"> * own little bit of XML config.</em> +<a name="91" href="#91">91</a> <em class="jxr_javadoccomment"> * </em> +<a name="92" href="#92">92</a> <em class="jxr_javadoccomment"> * @param element - further information to be gleaned from the DOM.</em> +<a name="93" href="#93">93</a> <em class="jxr_javadoccomment"> */</em> +<a 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 name="95" href="#95">95</a> <em class="jxr_comment">/*</em> +<a name="96" href="#96">96</a> <em class="jxr_comment"> * <Plugin idenfifier="WayfCookiePlugin" </em> +<a name="97" href="#97">97</a> <em class="jxr_comment"> * type="edu.internet2.middleware.shibboleth.wayf.plugins.provider.SamlCookiePlugin"</em> +<a name="98" href="#98">98</a> <em class="jxr_comment"> * alwaysFollow = "FALSE"</em> +<a name="99" href="#99">99</a> <em class="jxr_comment"> * deleteCookie = "FALSE"</em> +<a name="100" href="#100">100</a> <em class="jxr_comment"> * cacheExpiration = "number" </em> +<a name="101" href="#101">101</a> <em class="jxr_comment"> * cacheDomain = "string"/> </em> +<a name="102" href="#102">102</a> <em class="jxr_comment"> */</em> +<a name="103" href="#103">103</a> log.info(<span class="jxr_string">"New plugin"</span>); +<a name="104" href="#104">104</a> String s; +<a name="105" href="#105">105</a> +<a name="106" href="#106">106</a> s = element.getAttribute(<span class="jxr_string">"alwaysFollow"</span>); +<a 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 name="108" href="#108">108</a> alwaysFollow = Boolean.valueOf(s).booleanValue(); +<a name="109" href="#109">109</a> } <strong class="jxr_keyword">else</strong> { +<a name="110" href="#110">110</a> alwaysFollow = <strong class="jxr_keyword">true</strong>; +<a name="111" href="#111">111</a> } +<a name="112" href="#112">112</a> +<a name="113" href="#113">113</a> s = element.getAttribute(<span class="jxr_string">"deleteCookie"</span>); +<a 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 name="115" href="#115">115</a> deleteCookie = Boolean.valueOf(s).booleanValue(); +<a name="116" href="#116">116</a> } <strong class="jxr_keyword">else</strong> { +<a name="117" href="#117">117</a> deleteCookie = false; +<a name="118" href="#118">118</a> } +<a name="119" href="#119">119</a> +<a name="120" href="#120">120</a> s = element.getAttribute(<span class="jxr_string">"cacheDomain"</span>); +<a 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 name="122" href="#122">122</a> cacheDomain = s; +<a name="123" href="#123">123</a> } <strong class="jxr_keyword">else</strong> { +<a name="124" href="#124">124</a> cacheDomain = <span class="jxr_string">""</span>; +<a name="125" href="#125">125</a> } +<a name="126" href="#126">126</a> +<a name="127" href="#127">127</a> s = element.getAttribute(<span class="jxr_string">"cacheExpiration"</span>); +<a 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 name="129" href="#129">129</a> +<a name="130" href="#130">130</a> <strong class="jxr_keyword">try</strong> { +<a name="131" href="#131">131</a> +<a name="132" href="#132">132</a> cacheExpiration = Integer.parseInt(s); +<a name="133" href="#133">133</a> } <strong class="jxr_keyword">catch</strong> (NumberFormatException ex) { +<a name="134" href="#134">134</a> +<a name="135" href="#135">135</a> log.error(<span class="jxr_string">"Invalid CacheExpiration value - "</span> + s); +<a name="136" href="#136">136</a> cacheExpiration = DEFAULT_CACHE_EXPIRATION; +<a name="137" href="#137">137</a> } +<a name="138" href="#138">138</a> } <strong class="jxr_keyword">else</strong> { +<a name="139" href="#139">139</a> cacheExpiration = DEFAULT_CACHE_EXPIRATION; +<a name="140" href="#140">140</a> } +<a name="141" href="#141">141</a> } +<a name="142" href="#142">142</a> +<a name="143" href="#143">143</a> <em class="jxr_javadoccomment">/**</em> +<a name="144" href="#144">144</a> <em class="jxr_javadoccomment"> * Create a plugin with the hard-wired default settings.</em> +<a name="145" href="#145">145</a> <em class="jxr_javadoccomment"> */</em> +<a name="146" href="#146">146</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/provider/SamlCookiePlugin.html">SamlCookiePlugin</a>() { +<a name="147" href="#147">147</a> alwaysFollow = false; +<a name="148" href="#148">148</a> deleteCookie = false; +<a name="149" href="#149">149</a> cacheExpiration = DEFAULT_CACHE_EXPIRATION; +<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"> * This is the 'hook' in the lookup part of Discovery Service processing. </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 req - Describes the current request. Used to find any appropriate cookies </em> +<a name="156" href="#156">156</a> <em class="jxr_javadoccomment"> * @param res - Describes the current response. Used to redirect the request. </em> +<a name="157" href="#157">157</a> <em class="jxr_javadoccomment"> * @param parameter - Describes the metadata.</em> +<a 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 name="159" href="#159">159</a> <em class="jxr_javadoccomment"> * use non null to indicate that we don't go there again.</em> +<a 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 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 name="162" href="#162">162</a> <em class="jxr_javadoccomment"> * the Idp </em> +<a 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 name="164" href="#164">164</a> <em class="jxr_javadoccomment"> * @return a context to hand to subsequent calls</em> +<a name="165" href="#165">165</a> <em class="jxr_javadoccomment"> * @throws WayfRequestHandled if the plugin has handled the request.</em> +<a name="166" href="#166">166</a> <em class="jxr_javadoccomment"> * issues a redirect)</em> +<a name="167" href="#167">167</a> <em class="jxr_javadoccomment"> * </em> +<a name="168" href="#168">168</a> <em class="jxr_javadoccomment"> * @see edu.internet2.middleware.shibboleth.wayf.plugins.Plugin#lookup</em> +<a name="169" href="#169">169</a> <em class="jxr_javadoccomment"> */</em> +<a 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 name="171" href="#171">171</a> HttpServletResponse res, +<a name="172" href="#172">172</a> <a href="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/PluginMetadataParameter.html">PluginMetadataParameter</a> parameter, +<a name="173" href="#173">173</a> Map<String, IdPSite> validIdps, +<a name="174" href="#174">174</a> <a href="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/PluginContext.html">PluginContext</a> context, +<a name="175" href="#175">175</a> List <IdPSite> idpList) <strong class="jxr_keyword">throws</strong> WayfRequestHandled { +<a name="176" href="#176">176</a> +<a name="177" href="#177">177</a> <strong class="jxr_keyword">if</strong> (context != <strong class="jxr_keyword">null</strong>) { +<a name="178" href="#178">178</a> <em class="jxr_comment">//</em> +<a name="179" href="#179">179</a> <em class="jxr_comment">// We only need to be called once</em> +<a name="180" href="#180">180</a> <em class="jxr_comment">//</em> +<a name="181" href="#181">181</a> <strong class="jxr_keyword">return</strong> context; +<a name="182" href="#182">182</a> } +<a name="183" href="#183">183</a> +<a name="184" href="#184">184</a> <strong class="jxr_keyword">if</strong> (deleteCookie) { +<a name="185" href="#185">185</a> deleteCookie(req, res); +<a name="186" href="#186">186</a> <em class="jxr_comment">//</em> +<a name="187" href="#187">187</a> <em class="jxr_comment">// Only need to be called once - so set up a parameter</em> +<a name="188" href="#188">188</a> <em class="jxr_comment">//</em> +<a 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 name="190" href="#190">190</a> } +<a name="191" href="#191">191</a> List <String> idps = getIdPCookie(req, res, cacheDomain).getIdPList(); +<a name="192" href="#192">192</a> +<a name="193" href="#193">193</a> <strong class="jxr_keyword">for</strong> (String idpName : idps) { +<a name="194" href="#194">194</a> <a href="../../../../../../../edu/internet2/middleware/shibboleth/wayf/IdPSite.html">IdPSite</a> idp = validIdps.get(idpName); +<a name="195" href="#195">195</a> <strong class="jxr_keyword">if</strong> (idp != <strong class="jxr_keyword">null</strong>) { +<a name="196" href="#196">196</a> <strong class="jxr_keyword">if</strong> (alwaysFollow) { +<a name="197" href="#197">197</a> <strong class="jxr_keyword">try</strong> { +<a name="198" href="#198">198</a> DiscoveryServiceHandler.forwardRequest(req, res, idp); +<a name="199" href="#199">199</a> } <strong class="jxr_keyword">catch</strong> (WayfException e) { +<a name="200" href="#200">200</a> <em class="jxr_comment">// Do nothing we are going to throw anyway</em> +<a name="201" href="#201">201</a> ; +<a name="202" href="#202">202</a> } +<a 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 name="204" href="#204">204</a> } +<a name="205" href="#205">205</a> <em class="jxr_comment">//</em> +<a name="206" href="#206">206</a> <em class="jxr_comment">// This IDP is ok </em> +<a name="207" href="#207">207</a> <em class="jxr_comment">//</em> +<a name="208" href="#208">208</a> idpList.add(idp); +<a name="209" href="#209">209</a> } +<a name="210" href="#210">210</a> } +<a name="211" href="#211">211</a> +<a name="212" href="#212">212</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>; +<a name="213" href="#213">213</a> } +<a name="214" href="#214">214</a> +<a name="215" href="#215">215</a> <em class="jxr_javadoccomment">/**</em> +<a name="216" href="#216">216</a> <em class="jxr_javadoccomment"> * Plugin point which is called when the data is refreshed.</em> +<a name="217" href="#217">217</a> <em class="jxr_javadoccomment"> * @param metadata - where to get the data from.</em> +<a name="218" href="#218">218</a> <em class="jxr_javadoccomment"> * @return the value which will be provided as input to subsequent calls</em> +<a name="219" href="#219">219</a> <em class="jxr_javadoccomment"> * @see edu.internet2.middleware.shibboleth.wayf.plugins.Plugin#refreshMetadata</em> +<a name="220" href="#220">220</a> <em class="jxr_javadoccomment"> */</em> +<a 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 name="222" href="#222">222</a> <em class="jxr_comment">//</em> +<a 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 name="224" href="#224">224</a> <em class="jxr_comment">//</em> +<a name="225" href="#225">225</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>; +<a name="226" href="#226">226</a> } +<a name="227" href="#227">227</a> +<a name="228" href="#228">228</a> <em class="jxr_javadoccomment">/**</em> +<a name="229" href="#229">229</a> <em class="jxr_javadoccomment"> * Plgin point for searching.</em> +<a name="230" href="#230">230</a> <em class="jxr_javadoccomment"> * </em> +<a name="231" href="#231">231</a> <em class="jxr_javadoccomment"> * @throws WayfRequestHandled </em> +<a name="232" href="#232">232</a> <em class="jxr_javadoccomment"> * @param req Describes the current request. </em> +<a name="233" href="#233">233</a> <em class="jxr_javadoccomment"> * @param res Describes the current response.</em> +<a name="234" href="#234">234</a> <em class="jxr_javadoccomment"> * @param parameter Describes the metadata.</em> +<a name="235" href="#235">235</a> <em class="jxr_javadoccomment"> * @param pattern What we are searchign for. </em> +<a 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 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 name="238" href="#238">238</a> <em class="jxr_javadoccomment"> * the Idp </em> +<a 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 name="240" href="#240">240</a> <em class="jxr_javadoccomment"> * use non null to indicate that we don't go there again.</em> +<a name="241" href="#241">241</a> <em class="jxr_javadoccomment"> * @param searchResult What the search yielded. </em> +<a 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 name="243" href="#243">243</a> <em class="jxr_javadoccomment"> * @return a context to hand to subsequent calls.</em> +<a name="244" href="#244">244</a> <em class="jxr_javadoccomment"> * @see edu.internet2.middleware.shibboleth.wayf.plugins.Plugin#search</em> +<a name="245" href="#245">245</a> <em class="jxr_javadoccomment"> * @throws WayfRequestHandled if the plugin has handled the request.</em> +<a name="246" href="#246">246</a> <em class="jxr_javadoccomment"> * </em> +<a name="247" href="#247">247</a> <em class="jxr_javadoccomment"> */</em> +<a 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 name="249" href="#249">249</a> HttpServletResponse res, +<a name="250" href="#250">250</a> <a href="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/PluginMetadataParameter.html">PluginMetadataParameter</a> parameter, +<a name="251" href="#251">251</a> String pattern, +<a name="252" href="#252">252</a> Map<String, IdPSite> validIdps, +<a name="253" href="#253">253</a> <a href="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/PluginContext.html">PluginContext</a> context, +<a name="254" href="#254">254</a> Collection<IdPSite> searchResult, +<a name="255" href="#255">255</a> List<IdPSite> idpList) <strong class="jxr_keyword">throws</strong> WayfRequestHandled { +<a name="256" href="#256">256</a> <em class="jxr_comment">//</em> +<a name="257" href="#257">257</a> <em class="jxr_comment">// Don't distinguish between lookup and search</em> +<a name="258" href="#258">258</a> <em class="jxr_comment">//</em> +<a name="259" href="#259">259</a> <strong class="jxr_keyword">return</strong> lookup(req, res, parameter, validIdps, context, idpList); +<a name="260" href="#260">260</a> } +<a name="261" href="#261">261</a> +<a name="262" href="#262">262</a> <em class="jxr_javadoccomment">/**</em> +<a name="263" href="#263">263</a> <em class="jxr_javadoccomment"> * Plugin point for selection.</em> +<a name="264" href="#264">264</a> <em class="jxr_javadoccomment"> * </em> +<a 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 name="266" href="#266">266</a> <em class="jxr_javadoccomment"> * javax.servlet.http.HttpServletResponse, </em> +<a name="267" href="#267">267</a> <em class="jxr_javadoccomment"> * edu.internet2.middleware.shibboleth.wayf.plugins.PluginMetadataParameter, </em> +<a name="268" href="#268">268</a> <em class="jxr_javadoccomment"> * java.lang.String)</em> +<a name="269" href="#269">269</a> <em class="jxr_javadoccomment"> * @param req Describes the current request. </em> +<a name="270" href="#270">270</a> <em class="jxr_javadoccomment"> * @param res Describes the current response.</em> +<a name="271" href="#271">271</a> <em class="jxr_javadoccomment"> * @param parameter Describes the metadata.</em> +<a name="272" href="#272">272</a> <em class="jxr_javadoccomment"> * @param idP Describes the idp.</em> +<a name="273" href="#273">273</a> <em class="jxr_javadoccomment"> * </em> +<a name="274" href="#274">274</a> <em class="jxr_javadoccomment"> */</em> +<a name="275" href="#275">275</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> selected(HttpServletRequest req, HttpServletResponse res, +<a name="276" href="#276">276</a> <a href="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/PluginMetadataParameter.html">PluginMetadataParameter</a> parameter, String idP) { +<a name="277" href="#277">277</a> +<a 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 name="279" href="#279">279</a> String param = req.getParameter(PARAMETER_NAME); +<a name="280" href="#280">280</a> +<a 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 name="282" href="#282">282</a> <strong class="jxr_keyword">return</strong>; +<a name="283" href="#283">283</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (param.equalsIgnoreCase(PARAMETER_SESSION)) { +<a name="284" href="#284">284</a> cookie.addIdPName(idP, -1); +<a name="285" href="#285">285</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (param.equalsIgnoreCase(PARAMETER_PERM)) { +<a name="286" href="#286">286</a> cookie.addIdPName(idP, cacheExpiration); +<a name="287" href="#287">287</a> } +<a name="288" href="#288">288</a> } +<a name="289" href="#289">289</a> +<a name="290" href="#290">290</a> <em class="jxr_comment">//</em> +<a name="291" href="#291">291</a> <em class="jxr_comment">// Private classes for internal use</em> +<a name="292" href="#292">292</a> <em class="jxr_comment">//</em> +<a name="293" href="#293">293</a> +<a name="294" href="#294">294</a> <em class="jxr_javadoccomment">/**</em> +<a name="295" href="#295">295</a> <em class="jxr_javadoccomment"> * This is just a marker tag.</em> +<a name="296" href="#296">296</a> <em class="jxr_javadoccomment"> */</em> +<a 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> implements <a href="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/PluginContext.html">PluginContext</a> {} +<a name="298" href="#298">298</a> +<a name="299" href="#299">299</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> </em> +<a name="300" href="#300">300</a> <em class="jxr_javadoccomment"> * Class to abstract away the saml cookie for us.</em> +<a name="301" href="#301">301</a> <em class="jxr_javadoccomment"> */</em> +<a 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 name="303" href="#303">303</a> +<a name="304" href="#304">304</a> +<a name="305" href="#305">305</a> <em class="jxr_javadoccomment">/**</em> +<a name="306" href="#306">306</a> <em class="jxr_javadoccomment"> * The associated request.</em> +<a name="307" href="#307">307</a> <em class="jxr_javadoccomment"> */</em> +<a name="308" href="#308">308</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> HttpServletRequest req; +<a name="309" href="#309">309</a> <em class="jxr_javadoccomment">/**</em> +<a name="310" href="#310">310</a> <em class="jxr_javadoccomment"> * The associated response.</em> +<a name="311" href="#311">311</a> <em class="jxr_javadoccomment"> */</em> +<a name="312" href="#312">312</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> HttpServletResponse res; +<a name="313" href="#313">313</a> <em class="jxr_javadoccomment">/**</em> +<a name="314" href="#314">314</a> <em class="jxr_javadoccomment"> * The associated domain.</em> +<a name="315" href="#315">315</a> <em class="jxr_javadoccomment"> */</em> +<a name="316" href="#316">316</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> String domain; +<a name="317" href="#317">317</a> <em class="jxr_javadoccomment">/**</em> +<a name="318" href="#318">318</a> <em class="jxr_javadoccomment"> * The IdPs.</em> +<a name="319" href="#319">319</a> <em class="jxr_javadoccomment"> */</em> +<a 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 name="321" href="#321">321</a> +<a name="322" href="#322">322</a> <em class="jxr_javadoccomment">/**</em> +<a 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 name="324" href="#324">324</a> <em class="jxr_javadoccomment"> * </em> +<a name="325" href="#325">325</a> <em class="jxr_javadoccomment"> * @param codedData</em> +<a name="326" href="#326">326</a> <em class="jxr_javadoccomment"> * the information read from the cookie</em> +<a name="327" href="#327">327</a> <em class="jxr_javadoccomment"> * @param request Describes the current request. </em> +<a name="328" href="#328">328</a> <em class="jxr_javadoccomment"> * @param response Describes the current response.</em> +<a name="329" href="#329">329</a> <em class="jxr_javadoccomment"> * @param domainName - if non null the domain for any *created* cookie.</em> +<a name="330" href="#330">330</a> <em class="jxr_javadoccomment"> */</em> +<a 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 name="332" href="#332">332</a> HttpServletRequest request, +<a name="333" href="#333">333</a> HttpServletResponse response, +<a name="334" href="#334">334</a> String domainName) { +<a name="335" href="#335">335</a> +<a name="336" href="#336">336</a> <strong class="jxr_keyword">this</strong>.req = request; +<a name="337" href="#337">337</a> <strong class="jxr_keyword">this</strong>.res = response; +<a name="338" href="#338">338</a> <strong class="jxr_keyword">this</strong>.domain = domainName; +<a name="339" href="#339">339</a> +<a name="340" href="#340">340</a> <strong class="jxr_keyword">int</strong> start; +<a name="341" href="#341">341</a> <strong class="jxr_keyword">int</strong> end; +<a name="342" href="#342">342</a> +<a 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 name="344" href="#344">344</a> log.info(<span class="jxr_string">"Empty cookie"</span>); +<a name="345" href="#345">345</a> <strong class="jxr_keyword">return</strong>; +<a name="346" href="#346">346</a> } +<a name="347" href="#347">347</a> <em class="jxr_comment">//</em> +<a 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 name="349" href="#349">349</a> <em class="jxr_comment">// spaces which in turn means we may be quoted. Strip any quotes.</em> +<a name="350" href="#350">350</a> <em class="jxr_comment">//</em> +<a name="351" href="#351">351</a> <strong class="jxr_keyword">if</strong> (codedData.charAt(0) == '"' && codedData.charAt(codedData.length()-1) == '"') { +<a name="352" href="#352">352</a> codedData = codedData.substring(1,codedData.length()-1); +<a name="353" href="#353">353</a> } +<a name="354" href="#354">354</a> +<a name="355" href="#355">355</a> <strong class="jxr_keyword">try</strong> { +<a name="356" href="#356">356</a> codedData = URLDecoder.decode(codedData, <span class="jxr_string">"UTF-8"</span>); +<a name="357" href="#357">357</a> } <strong class="jxr_keyword">catch</strong> (UnsupportedEncodingException e) { +<a name="358" href="#358">358</a> log.error(<span class="jxr_string">"could not decode cookie"</span>); +<a name="359" href="#359">359</a> <strong class="jxr_keyword">return</strong>; +<a name="360" href="#360">360</a> } +<a name="361" href="#361">361</a> +<a name="362" href="#362">362</a> start = 0; +<a name="363" href="#363">363</a> end = codedData.indexOf(' ', start); +<a name="364" href="#364">364</a> <strong class="jxr_keyword">while</strong> (end > 0) { +<a name="365" href="#365">365</a> String value = codedData.substring(start, end); +<a name="366" href="#366">366</a> start = end + 1; +<a name="367" href="#367">367</a> end = codedData.indexOf(' ', start); +<a name="368" href="#368">368</a> <strong class="jxr_keyword">if</strong> (!value.equals(<span class="jxr_string">""</span>)) { +<a name="369" href="#369">369</a> idPList.add(<strong class="jxr_keyword">new</strong> String(Base64.decode(value))); +<a name="370" href="#370">370</a> } +<a name="371" href="#371">371</a> } +<a name="372" href="#372">372</a> <strong class="jxr_keyword">if</strong> (start < codedData.length()) { +<a name="373" href="#373">373</a> String value = codedData.substring(start); +<a name="374" href="#374">374</a> <strong class="jxr_keyword">if</strong> (!value.equals(<span class="jxr_string">""</span>)) { +<a name="375" href="#375">375</a> idPList.add(<strong class="jxr_keyword">new</strong> String(Base64.decode(value))); +<a name="376" href="#376">376</a> } +<a name="377" href="#377">377</a> } +<a name="378" href="#378">378</a> } +<a name="379" href="#379">379</a> <em class="jxr_javadoccomment">/**</em> +<a name="380" href="#380">380</a> <em class="jxr_javadoccomment"> * Create a SamlCookie with no data inside.</em> +<a name="381" href="#381">381</a> <em class="jxr_javadoccomment"> * @param domainName - if non null, the domain of the new cookie </em> +<a name="382" href="#382">382</a> <em class="jxr_javadoccomment"> * @param request Describes the current request. </em> +<a name="383" href="#383">383</a> <em class="jxr_javadoccomment"> * @param response Describes the current response.</em> +<a name="384" href="#384">384</a> <em class="jxr_javadoccomment"> *</em> +<a name="385" href="#385">385</a> <em class="jxr_javadoccomment"> */</em> +<a 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 name="387" href="#387">387</a> <strong class="jxr_keyword">this</strong>.req = request; +<a name="388" href="#388">388</a> <strong class="jxr_keyword">this</strong>.res = response; +<a name="389" href="#389">389</a> <strong class="jxr_keyword">this</strong>.domain = domainName; +<a name="390" href="#390">390</a> } +<a name="391" href="#391">391</a> +<a name="392" href="#392">392</a> <em class="jxr_javadoccomment">/**</em> +<a 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 name="394" href="#394">394</a> <em class="jxr_javadoccomment"> * the front and then write it back.</em> +<a name="395" href="#395">395</a> <em class="jxr_javadoccomment"> * </em> +<a name="396" href="#396">396</a> <em class="jxr_javadoccomment"> * We always add to the front (and remove from wherever it was)</em> +<a name="397" href="#397">397</a> <em class="jxr_javadoccomment"> * </em> +<a name="398" href="#398">398</a> <em class="jxr_javadoccomment"> * @param idPName - The name to be added</em> +<a 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 name="400" href="#400">400</a> <em class="jxr_javadoccomment"> */</em> +<a 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 name="402" href="#402">402</a> +<a name="403" href="#403">403</a> idPList.remove(idPName); +<a name="404" href="#404">404</a> idPList.add(0, idPName); +<a name="405" href="#405">405</a> +<a name="406" href="#406">406</a> writeCookie(expiration); +<a name="407" href="#407">407</a> } +<a name="408" href="#408">408</a> +<a name="409" href="#409">409</a> <em class="jxr_javadoccomment">/**</em> +<a name="410" href="#410">410</a> <em class="jxr_javadoccomment"> * Delete the <b>entire<\b> cookie contents</em> +<a name="411" href="#411">411</a> <em class="jxr_javadoccomment"> */</em> +<a name="412" href="#412">412</a> +<a name="413" href="#413">413</a> +<a name="414" href="#414">414</a> <em class="jxr_javadoccomment">/**</em> +<a name="415" href="#415">415</a> <em class="jxr_javadoccomment"> * Remove origin from the cachedata and write it back.</em> +<a name="416" href="#416">416</a> <em class="jxr_javadoccomment"> * </em> +<a name="417" href="#417">417</a> <em class="jxr_javadoccomment"> * @param origin what to remove.</em> +<a name="418" href="#418">418</a> <em class="jxr_javadoccomment"> * @param expiration How long it will live.</em> +<a name="419" href="#419">419</a> <em class="jxr_javadoccomment"> */</em> +<a name="420" href="#420">420</a> +<a 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 name="422" href="#422">422</a> idPList.remove(origin); +<a name="423" href="#423">423</a> writeCookie(expiration); +<a name="424" href="#424">424</a> } +<a name="425" href="#425">425</a> +<a name="426" href="#426">426</a> <em class="jxr_javadoccomment">/**</em> +<a name="427" href="#427">427</a> <em class="jxr_javadoccomment"> * Write back the cookie.</em> +<a name="428" href="#428">428</a> <em class="jxr_javadoccomment"> * </em> +<a name="429" href="#429">429</a> <em class="jxr_javadoccomment"> * @param expiration How long it will live</em> +<a name="430" href="#430">430</a> <em class="jxr_javadoccomment"> */</em> +<a 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 name="432" href="#432">432</a> Cookie cookie = getCookie(req); +<a name="433" href="#433">433</a> +<a name="434" href="#434">434</a> <strong class="jxr_keyword">if</strong> (idPList.size() == 0) { +<a name="435" href="#435">435</a> <em class="jxr_comment">//</em> +<a name="436" href="#436">436</a> <em class="jxr_comment">// Nothing to write, so delete the cookie</em> +<a name="437" href="#437">437</a> <em class="jxr_comment">//</em> +<a name="438" href="#438">438</a> cookie.setPath(<span class="jxr_string">"/"</span>); +<a name="439" href="#439">439</a> cookie.setMaxAge(0); +<a name="440" href="#440">440</a> res.addCookie(cookie); +<a name="441" href="#441">441</a> <strong class="jxr_keyword">return</strong>; +<a name="442" href="#442">442</a> } +<a name="443" href="#443">443</a> +<a name="444" href="#444">444</a> <em class="jxr_comment">//</em> +<a name="445" href="#445">445</a> <em class="jxr_comment">// Otherwise encode up the cookie</em> +<a name="446" href="#446">446</a> <em class="jxr_comment">//</em> +<a name="447" href="#447">447</a> StringBuffer buffer = <strong class="jxr_keyword">new</strong> StringBuffer(); +<a name="448" href="#448">448</a> Iterator <String> it = idPList.iterator(); +<a name="449" href="#449">449</a> +<a name="450" href="#450">450</a> <strong class="jxr_keyword">while</strong> (it.hasNext()) { +<a name="451" href="#451">451</a> String next = it.next(); +<a name="452" href="#452">452</a> String what = <strong class="jxr_keyword">new</strong> String(Base64.encodeBytes(next.getBytes())); +<a name="453" href="#453">453</a> buffer.append(what).append(' '); +<a name="454" href="#454">454</a> } +<a name="455" href="#455">455</a> +<a name="456" href="#456">456</a> String value; +<a name="457" href="#457">457</a> <strong class="jxr_keyword">try</strong> { +<a name="458" href="#458">458</a> value = URLEncoder.encode(buffer.toString(), <span class="jxr_string">"UTF-8"</span>); +<a name="459" href="#459">459</a> } <strong class="jxr_keyword">catch</strong> (UnsupportedEncodingException e) { +<a name="460" href="#460">460</a> log.error(<span class="jxr_string">"Could not encode cookie"</span>); +<a name="461" href="#461">461</a> <strong class="jxr_keyword">return</strong>; +<a name="462" href="#462">462</a> } +<a name="463" href="#463">463</a> +<a name="464" href="#464">464</a> <strong class="jxr_keyword">if</strong> (cookie == <strong class="jxr_keyword">null</strong>) { +<a name="465" href="#465">465</a> cookie = <strong class="jxr_keyword">new</strong> Cookie(COOKIE_NAME, value); +<a name="466" href="#466">466</a> } <strong class="jxr_keyword">else</strong> { +<a name="467" href="#467">467</a> cookie.setValue(value); +<a name="468" href="#468">468</a> } +<a name="469" href="#469">469</a> cookie.setComment(<span class="jxr_string">"Used to cache selection of a user's Shibboleth IdP"</span>); +<a name="470" href="#470">470</a> cookie.setPath(<span class="jxr_string">"/"</span>); +<a name="471" href="#471">471</a> +<a name="472" href="#472">472</a> +<a name="473" href="#473">473</a> cookie.setMaxAge(expiration); +<a name="474" href="#474">474</a> +<a 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 name="476" href="#476">476</a> cookie.setDomain(domain); +<a name="477" href="#477">477</a> } +<a name="478" href="#478">478</a> res.addCookie(cookie); +<a name="479" href="#479">479</a> +<a name="480" href="#480">480</a> } +<a name="481" href="#481">481</a> +<a name="482" href="#482">482</a> <em class="jxr_javadoccomment">/**</em> +<a name="483" href="#483">483</a> <em class="jxr_javadoccomment"> * Return the list of Idps for this cookie.</em> +<a name="484" href="#484">484</a> <em class="jxr_javadoccomment"> * @return The list.</em> +<a name="485" href="#485">485</a> <em class="jxr_javadoccomment"> */</em> +<a name="486" href="#486">486</a> <strong class="jxr_keyword">public</strong> List <String> getIdPList() { +<a name="487" href="#487">487</a> <strong class="jxr_keyword">return</strong> idPList; +<a name="488" href="#488">488</a> } +<a name="489" href="#489">489</a> } +<a name="490" href="#490">490</a> +<a name="491" href="#491">491</a> <em class="jxr_javadoccomment">/**</em> +<a name="492" href="#492">492</a> <em class="jxr_javadoccomment"> * Extract the cookie from a request.</em> +<a name="493" href="#493">493</a> <em class="jxr_javadoccomment"> * @param req the request.</em> +<a name="494" href="#494">494</a> <em class="jxr_javadoccomment"> * @return the cookie.</em> +<a name="495" href="#495">495</a> <em class="jxr_javadoccomment"> */</em> +<a name="496" href="#496">496</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> Cookie getCookie(HttpServletRequest req) { +<a name="497" href="#497">497</a> +<a name="498" href="#498">498</a> Cookie[] cookies = req.getCookies(); +<a name="499" href="#499">499</a> <strong class="jxr_keyword">if</strong> (cookies != <strong class="jxr_keyword">null</strong>) { +<a 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 name="501" href="#501">501</a> <strong class="jxr_keyword">if</strong> (cookies[i].getName().equals(COOKIE_NAME)) { +<a name="502" href="#502">502</a> <strong class="jxr_keyword">return</strong> cookies[i]; +<a name="503" href="#503">503</a> } +<a name="504" href="#504">504</a> } +<a name="505" href="#505">505</a> } +<a name="506" href="#506">506</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>; +<a name="507" href="#507">507</a> } +<a name="508" href="#508">508</a> +<a name="509" href="#509">509</a> <em class="jxr_javadoccomment">/**</em> +<a name="510" href="#510">510</a> <em class="jxr_javadoccomment"> * Delete the cookie from the response.</em> +<a name="511" href="#511">511</a> <em class="jxr_javadoccomment"> * @param req The request.</em> +<a name="512" href="#512">512</a> <em class="jxr_javadoccomment"> * @param res The response.</em> +<a name="513" href="#513">513</a> <em class="jxr_javadoccomment"> */</em> +<a 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 name="515" href="#515">515</a> Cookie cookie = getCookie(req); +<a name="516" href="#516">516</a> +<a name="517" href="#517">517</a> <strong class="jxr_keyword">if</strong> (cookie == <strong class="jxr_keyword">null</strong>) { +<a name="518" href="#518">518</a> <strong class="jxr_keyword">return</strong>; +<a name="519" href="#519">519</a> } +<a name="520" href="#520">520</a> +<a name="521" href="#521">521</a> cookie.setPath(<span class="jxr_string">"/"</span>); +<a name="522" href="#522">522</a> cookie.setMaxAge(0); +<a name="523" href="#523">523</a> res.addCookie(cookie); +<a name="524" href="#524">524</a> } +<a name="525" href="#525">525</a> <em class="jxr_javadoccomment">/**</em> +<a 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 name="527" href="#527">527</a> <em class="jxr_javadoccomment"> * underlying cookie return a null one.</em> +<a name="528" href="#528">528</a> <em class="jxr_javadoccomment"> * @param req The request.</em> +<a name="529" href="#529">529</a> <em class="jxr_javadoccomment"> * @param res The response.</em> +<a 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 name="531" href="#531">531</a> <em class="jxr_javadoccomment"> * @return the new object. </em> +<a name="532" href="#532">532</a> <em class="jxr_javadoccomment"> */</em> +<a name="533" href="#533">533</a> +<a 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 name="535" href="#535">535</a> Cookie cookie = getCookie(req); +<a name="536" href="#536">536</a> +<a name="537" href="#537">537</a> <strong class="jxr_keyword">if</strong> (cookie == <strong class="jxr_keyword">null</strong>) { +<a 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 name="539" href="#539">539</a> } <strong class="jxr_keyword">else</strong> { +<a 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 name="541" href="#541">541</a> } +<a name="542" href="#542">542</a> } +<a name="543" href="#543">543</a> } +<a 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> + diff --git a/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/plugins/provider/package-frame.html b/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/plugins/provider/package-frame.html new file mode 100644 index 0000000..5eb51b5 --- /dev/null +++ b/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/plugins/provider/package-frame.html @@ -0,0 +1,36 @@ +
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "DTD/xhtml1-transitional.dtd">
+<html xml:lang="en" lang="en">
+ <head>
+ <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
+ <title>Shibboleth Discovery Service 1.1.0 Reference Package edu.internet2.middleware.shibboleth.wayf.plugins.provider</title>
+ <link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="style" />
+ </head>
+ <body>
+
+ <h3>
+ <a href="package-summary.html" target="classFrame">edu.internet2.middleware.shibboleth.wayf.plugins.provider</a>
+ </h3>
+
+ <h3>Classes</h3>
+
+ <ul>
+ <li>
+ <a href="BindingFilter.html" target="classFrame">BindingFilter</a>
+ </li>
+ <li>
+ <a href="SamlCookiePlugin.html" target="classFrame">Context</a>
+ </li>
+ <li>
+ <a href="ListFilter.html" target="classFrame">ListFilter</a>
+ </li>
+ <li>
+ <a href="SamlCookiePlugin.html" target="classFrame">SamlCookiePlugin</a>
+ </li>
+ <li>
+ <a href="SamlCookiePlugin.html" target="classFrame">SamlIdPCookie</a>
+ </li>
+ </ul>
+
+ </body>
+</html>
\ No newline at end of file diff --git a/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/plugins/provider/package-summary.html b/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/plugins/provider/package-summary.html new file mode 100644 index 0000000..2f91e22 --- /dev/null +++ b/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/plugins/provider/package-summary.html @@ -0,0 +1,87 @@ +
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "DTD/xhtml1-transitional.dtd">
+<html xml:lang="en" lang="en">
+ <head>
+ <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
+ <title>Shibboleth Discovery Service 1.1.0 Reference Package edu.internet2.middleware.shibboleth.wayf.plugins.provider</title>
+ <link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="style" />
+ </head>
+ <body>
+ <div class="overview">
+ <ul>
+ <li>
+ <a href="../../../../../../../overview-summary.html">Overview</a>
+ </li>
+ <li class="selected">Package</li>
+ </ul>
+ </div>
+ <div class="framenoframe">
+ <ul>
+ <li>
+ <a href="../../../../../../../index.html" target="_top">FRAMES</a>
+ </li>
+ <li>
+ <a href="package-summary.html" target="_top">NO FRAMES</a>
+ </li>
+ </ul>
+ </div>
+
+ <h2>Package edu.internet2.middleware.shibboleth.wayf.plugins.provider</h2>
+
+ <table class="summary">
+ <thead>
+ <tr>
+ <th>Class Summary</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ <a href="BindingFilter.html" target="classFrame">BindingFilter</a>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <a href="SamlCookiePlugin.html" target="classFrame">Context</a>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <a href="ListFilter.html" target="classFrame">ListFilter</a>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <a href="SamlCookiePlugin.html" target="classFrame">SamlCookiePlugin</a>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <a href="SamlCookiePlugin.html" target="classFrame">SamlIdPCookie</a>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
+ <div class="overview">
+ <ul>
+ <li>
+ <a href="../../../../../../../overview-summary.html">Overview</a>
+ </li>
+ <li class="selected">Package</li>
+ </ul>
+ </div>
+ <div class="framenoframe">
+ <ul>
+ <li>
+ <a href="../../../../../../../index.html" target="_top">FRAMES</a>
+ </li>
+ <li>
+ <a href="package-summary.html" target="_top">NO FRAMES</a>
+ </li>
+ </ul>
+ </div>
+ <hr />
+ Copyright © 2006-2009 Internet2. All Rights Reserved.
+ </body>
+</html>
\ No newline at end of file |