summaryrefslogtreecommitdiff
path: root/doc/src-xref/edu/internet2/middleware/shibboleth/wayf/IdPSiteSetEntry.html
blob: cc3ae3882e26dad39aa22bbe969a9ac49b0ebecc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
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&lt;IdPSite&gt; 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&lt;IdPSite&gt; 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&lt;IdPSite&gt; 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>