summaryrefslogtreecommitdiff
path: root/doc/api/edu/internet2/middleware/shibboleth/wayf/IdPSiteSet.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/api/edu/internet2/middleware/shibboleth/wayf/IdPSiteSet.html')
-rw-r--r--doc/api/edu/internet2/middleware/shibboleth/wayf/IdPSiteSet.html514
1 files changed, 514 insertions, 0 deletions
diff --git a/doc/api/edu/internet2/middleware/shibboleth/wayf/IdPSiteSet.html b/doc/api/edu/internet2/middleware/shibboleth/wayf/IdPSiteSet.html
new file mode 100644
index 0000000..2269d01
--- /dev/null
+++ b/doc/api/edu/internet2/middleware/shibboleth/wayf/IdPSiteSet.html
@@ -0,0 +1,514 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!--NewPage-->
+<HTML>
+<HEAD>
+<!-- Generated by javadoc (build 1.5.0_16) on Wed Jan 14 13:49:24 CET 2009 -->
+<META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<TITLE>
+IdPSiteSet (Shibboleth Discovery Service 1.1.0 Java API.)
+</TITLE>
+
+<META NAME="keywords" CONTENT="edu.internet2.middleware.shibboleth.wayf.IdPSiteSet class">
+
+<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
+
+<SCRIPT type="text/javascript">
+function windowTitle()
+{
+ parent.document.title="IdPSiteSet (Shibboleth Discovery Service 1.1.0 Java API.)";
+}
+</SCRIPT>
+<NOSCRIPT>
+</NOSCRIPT>
+
+</HEAD>
+
+<BODY BGCOLOR="white" onload="windowTitle();">
+
+
+<!-- ========= START OF TOP NAVBAR ======= -->
+<A NAME="navbar_top"><!-- --></A>
+<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
+<TR>
+<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<A NAME="navbar_top_firstrow"><!-- --></A>
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
+ <TR ALIGN="center" VALIGN="top">
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/IdPSiteSet.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
+ </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+&nbsp;<A HREF="../../../../../edu/internet2/middleware/shibboleth/wayf/IdPSite.Compare.html" title="class in edu.internet2.middleware.shibboleth.wayf"><B>PREV CLASS</B></A>&nbsp;
+&nbsp;<A HREF="../../../../../edu/internet2/middleware/shibboleth/wayf/IdPSiteSetEntry.html" title="class in edu.internet2.middleware.shibboleth.wayf"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../../../index.html?edu/internet2/middleware/shibboleth/wayf/IdPSiteSet.html" target="_top"><B>FRAMES</B></A> &nbsp;
+&nbsp;<A HREF="IdPSiteSet.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
+&nbsp;<SCRIPT type="text/javascript">
+ <!--
+ if(window==top) {
+ document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
+ }
+ //-->
+</SCRIPT>
+<NOSCRIPT>
+ <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
+</NOSCRIPT>
+
+
+</FONT></TD>
+</TR>
+<TR>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+ SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
+</TR>
+</TABLE>
+<A NAME="skip-navbar_top"></A>
+<!-- ========= END OF TOP NAVBAR ========= -->
+
+<HR>
+<!-- ======== START OF CLASS DATA ======== -->
+<H2>
+<FONT SIZE="-1">
+edu.internet2.middleware.shibboleth.wayf</FONT>
+<BR>
+Class IdPSiteSet</H2>
+<PRE>
+<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">java.lang.Object</A>
+ <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>edu.internet2.middleware.shibboleth.wayf.IdPSiteSet</B>
+</PRE>
+<DL>
+<DT><B>All Implemented Interfaces:</B> <DD>org.opensaml.saml2.metadata.provider.ObservableMetadataProvider.Observer</DD>
+</DL>
+<HR>
+<DL>
+<DT><PRE>public class <B>IdPSiteSet</B><DT>extends <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A><DT>implements org.opensaml.saml2.metadata.provider.ObservableMetadataProvider.Observer</DL>
+</PRE>
+
+<P>
+Represents a collection of related sites as desribed by a single soirce of metadata.
+ This is usually a federation. When the WAYF looks to see which IdP sites to show,
+ it trims the list so as to not show IdP's which do not trust the SP.
+
+ This class is opaque outside this file. The three static methods getSitesLists,
+ searchForMatchingOrigins and lookupIdP provide mechansims for accessing
+ collections of IdPSiteSets.
+<P>
+
+<P>
+<HR>
+
+<P>
+
+<!-- ======== CONSTRUCTOR SUMMARY ======== -->
+
+<A NAME="constructor_summary"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
+<B>Constructor Summary</B></FONT></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>protected </CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../edu/internet2/middleware/shibboleth/wayf/IdPSiteSet.html#IdPSiteSet(org.w3c.dom.Element, org.opensaml.xml.parse.ParserPool, boolean)">IdPSiteSet</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/org/w3c/dom/Element.html" title="class or interface in org.w3c.dom">Element</A>&nbsp;el,
+ org.opensaml.xml.parse.ParserPool&nbsp;parserPool,
+ boolean&nbsp;warnOnBadBinding)</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Create a new IdPSiteSet as described by the supplied XML segment.</TD>
+</TR>
+</TABLE>
+&nbsp;
+<!-- ========== METHOD SUMMARY =========== -->
+
+<A NAME="method_summary"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
+<B>Method Summary</B></FONT></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>protected &nbsp;void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../edu/internet2/middleware/shibboleth/wayf/IdPSiteSet.html#addPlugin(edu.internet2.middleware.shibboleth.wayf.plugins.Plugin)">addPlugin</A></B>(<A HREF="../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/Plugin.html" title="interface in edu.internet2.middleware.shibboleth.wayf.plugins">Plugin</A>&nbsp;plugin)</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Declares a plugin to the siteset.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>protected &nbsp;boolean</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../edu/internet2/middleware/shibboleth/wayf/IdPSiteSet.html#containsIdP(java.lang.String)">containsIdP</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;IdPName)</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;For plugin handling we need to know quickly if a metadataset contains the idp.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>protected &nbsp;boolean</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../edu/internet2/middleware/shibboleth/wayf/IdPSiteSet.html#containsSP(java.lang.String)">containsSP</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;SPName)</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;We do not need to look at a set if it doesn't know about the given SP.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>protected &nbsp;<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../edu/internet2/middleware/shibboleth/wayf/IdPSiteSet.html#getDisplayName()">getDisplayName</A></B>()</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the human friendly name for this siteset.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>protected &nbsp;org.opensaml.saml2.metadata.EntityDescriptor</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../edu/internet2/middleware/shibboleth/wayf/IdPSiteSet.html#getEntity(java.lang.String)">getEntity</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;name)</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>protected &nbsp;<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../edu/internet2/middleware/shibboleth/wayf/IdPSiteSet.html#getIdentifier()">getIdentifier</A></B>()</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return this sites (internal) identifier.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>protected &nbsp;<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Map.html" title="class or interface in java.util">Map</A>&lt;<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>,<A HREF="../../../../../edu/internet2/middleware/shibboleth/wayf/IdPSite.html" title="class in edu.internet2.middleware.shibboleth.wayf">IdPSite</A>&gt;</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../edu/internet2/middleware/shibboleth/wayf/IdPSiteSet.html#getIdPSites(java.lang.String, edu.internet2.middleware.shibboleth.wayf.HandlerConfig, java.util.Collection)">getIdPSites</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;searchString,
+ <A HREF="../../../../../edu/internet2/middleware/shibboleth/wayf/HandlerConfig.html" title="class in edu.internet2.middleware.shibboleth.wayf">HandlerConfig</A>&nbsp;config,
+ <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A>&lt;<A HREF="../../../../../edu/internet2/middleware/shibboleth/wayf/IdPSite.html" title="class in edu.internet2.middleware.shibboleth.wayf">IdPSite</A>&gt;&nbsp;searchMatches)</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return all the Idp in the provided entities descriptor.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>protected &nbsp;<A HREF="../../../../../edu/internet2/middleware/shibboleth/wayf/IdPSite.html" title="class in edu.internet2.middleware.shibboleth.wayf">IdPSite</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../edu/internet2/middleware/shibboleth/wayf/IdPSiteSet.html#getSite(java.lang.String)">getSite</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;idpName)</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the idpSite for the given entity name.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>&nbsp;void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../edu/internet2/middleware/shibboleth/wayf/IdPSiteSet.html#onEvent(org.opensaml.saml2.metadata.provider.MetadataProvider)">onEvent</A></B>(org.opensaml.saml2.metadata.provider.MetadataProvider&nbsp;provider)</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>protected &nbsp;<A HREF="../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/PluginMetadataParameter.html" title="interface in edu.internet2.middleware.shibboleth.wayf.plugins">PluginMetadataParameter</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../../edu/internet2/middleware/shibboleth/wayf/IdPSiteSet.html#paramFor(edu.internet2.middleware.shibboleth.wayf.plugins.Plugin)">paramFor</A></B>(<A HREF="../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/Plugin.html" title="interface in edu.internet2.middleware.shibboleth.wayf.plugins">Plugin</A>&nbsp;plugin)</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the parameter that this plugin uses.</TD>
+</TR>
+</TABLE>
+&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
+<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></B></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
+</TR>
+</TABLE>
+&nbsp;
+<P>
+
+<!-- ========= CONSTRUCTOR DETAIL ======== -->
+
+<A NAME="constructor_detail"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
+<B>Constructor Detail</B></FONT></TH>
+</TR>
+</TABLE>
+
+<A NAME="IdPSiteSet(org.w3c.dom.Element, org.opensaml.xml.parse.ParserPool, boolean)"><!-- --></A><H3>
+IdPSiteSet</H3>
+<PRE>
+protected <B>IdPSiteSet</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/org/w3c/dom/Element.html" title="class or interface in org.w3c.dom">Element</A>&nbsp;el,
+ org.opensaml.xml.parse.ParserPool&nbsp;parserPool,
+ boolean&nbsp;warnOnBadBinding)
+ throws <A HREF="../../../../../edu/internet2/middleware/shibboleth/common/ShibbolethConfigurationException.html" title="class in edu.internet2.middleware.shibboleth.common">ShibbolethConfigurationException</A></PRE>
+<DL>
+<DD>Create a new IdPSiteSet as described by the supplied XML segment.
+<P>
+<DL>
+<DT><B>Parameters:</B><DD><CODE>el</CODE> - - configuration details.<DD><CODE>parserPool</CODE> - - the parsers we initialized above.<DD><CODE>warnOnBadBinding</CODE> - if we just warn or give an error if an SP has bad entry points.
+<DT><B>Throws:</B>
+<DD><CODE><A HREF="../../../../../edu/internet2/middleware/shibboleth/common/ShibbolethConfigurationException.html" title="class in edu.internet2.middleware.shibboleth.common">ShibbolethConfigurationException</A></CODE> - - if something goes wrong.</DL>
+</DL>
+
+<!-- ============ METHOD DETAIL ========== -->
+
+<A NAME="method_detail"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
+<B>Method Detail</B></FONT></TH>
+</TR>
+</TABLE>
+
+<A NAME="getIdPSites(java.lang.String, edu.internet2.middleware.shibboleth.wayf.HandlerConfig, java.util.Collection)"><!-- --></A><H3>
+getIdPSites</H3>
+<PRE>
+protected <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Map.html" title="class or interface in java.util">Map</A>&lt;<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>,<A HREF="../../../../../edu/internet2/middleware/shibboleth/wayf/IdPSite.html" title="class in edu.internet2.middleware.shibboleth.wayf">IdPSite</A>&gt; <B>getIdPSites</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;searchString,
+ <A HREF="../../../../../edu/internet2/middleware/shibboleth/wayf/HandlerConfig.html" title="class in edu.internet2.middleware.shibboleth.wayf">HandlerConfig</A>&nbsp;config,
+ <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A>&lt;<A HREF="../../../../../edu/internet2/middleware/shibboleth/wayf/IdPSite.html" title="class in edu.internet2.middleware.shibboleth.wayf">IdPSite</A>&gt;&nbsp;searchMatches)</PRE>
+<DL>
+<DD>Return all the Idp in the provided entities descriptor. If SearchMatches
+ is non null it is populated with whatever of the IdPs matches the search string
+ (as noted above).
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>searchString</CODE> - to match with<DD><CODE>config</CODE> - parameter to mathing<DD><CODE>searchMatches</CODE> - if non null is filled with such of the sites which match the string
+<DT><B>Returns:</B><DD>the sites which fit.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getIdentifier()"><!-- --></A><H3>
+getIdentifier</H3>
+<PRE>
+protected <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getIdentifier</B>()</PRE>
+<DL>
+<DD>Return this sites (internal) identifier.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>the identifier</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getDisplayName()"><!-- --></A><H3>
+getDisplayName</H3>
+<PRE>
+protected <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getDisplayName</B>()</PRE>
+<DL>
+<DD>Return the human friendly name for this siteset.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>The friendly name</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="containsSP(java.lang.String)"><!-- --></A><H3>
+containsSP</H3>
+<PRE>
+protected boolean <B>containsSP</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;SPName)</PRE>
+<DL>
+<DD>We do not need to look at a set if it doesn't know about the given SP. However if
+ no SP is given (as per 1.1) then we do need to look. This calls lets us know whether
+ this set is a canddiate for looking into.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>SPName</CODE> - the Sp we are interested in.
+<DT><B>Returns:</B><DD>whether the site contains the SP.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="containsIdP(java.lang.String)"><!-- --></A><H3>
+containsIdP</H3>
+<PRE>
+protected boolean <B>containsIdP</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;IdPName)</PRE>
+<DL>
+<DD>For plugin handling we need to know quickly if a metadataset contains the idp.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>IdPName</CODE> - the IdP we are interested in.
+<DT><B>Returns:</B><DD>whether the site contains the IdP.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="addPlugin(edu.internet2.middleware.shibboleth.wayf.plugins.Plugin)"><!-- --></A><H3>
+addPlugin</H3>
+<PRE>
+protected void <B>addPlugin</B>(<A HREF="../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/Plugin.html" title="interface in edu.internet2.middleware.shibboleth.wayf.plugins">Plugin</A>&nbsp;plugin)</PRE>
+<DL>
+<DD>Declares a plugin to the siteset.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>plugin</CODE> - what to declare</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="paramFor(edu.internet2.middleware.shibboleth.wayf.plugins.Plugin)"><!-- --></A><H3>
+paramFor</H3>
+<PRE>
+protected <A HREF="../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/PluginMetadataParameter.html" title="interface in edu.internet2.middleware.shibboleth.wayf.plugins">PluginMetadataParameter</A> <B>paramFor</B>(<A HREF="../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/Plugin.html" title="interface in edu.internet2.middleware.shibboleth.wayf.plugins">Plugin</A>&nbsp;plugin)</PRE>
+<DL>
+<DD>Return the parameter that this plugin uses.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>plugin</CODE> -
+<DT><B>Returns:</B><DD>teh parameter.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="onEvent(org.opensaml.saml2.metadata.provider.MetadataProvider)"><!-- --></A><H3>
+onEvent</H3>
+<PRE>
+public void <B>onEvent</B>(org.opensaml.saml2.metadata.provider.MetadataProvider&nbsp;provider)</PRE>
+<DL>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE>onEvent</CODE> in interface <CODE>org.opensaml.saml2.metadata.provider.ObservableMetadataProvider.Observer</CODE></DL>
+</DD>
+<DD><DL>
+</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getSite(java.lang.String)"><!-- --></A><H3>
+getSite</H3>
+<PRE>
+protected <A HREF="../../../../../edu/internet2/middleware/shibboleth/wayf/IdPSite.html" title="class in edu.internet2.middleware.shibboleth.wayf">IdPSite</A> <B>getSite</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;idpName)
+ throws <A HREF="../../../../../edu/internet2/middleware/shibboleth/wayf/WayfException.html" title="class in edu.internet2.middleware.shibboleth.wayf">WayfException</A></PRE>
+<DL>
+<DD>Return the idpSite for the given entity name.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>idpName</CODE> - the entityname to look up
+<DT><B>Returns:</B><DD>the associated idpSite
+<DT><B>Throws:</B>
+<DD><CODE><A HREF="../../../../../edu/internet2/middleware/shibboleth/wayf/WayfException.html" title="class in edu.internet2.middleware.shibboleth.wayf">WayfException</A></CODE></DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getEntity(java.lang.String)"><!-- --></A><H3>
+getEntity</H3>
+<PRE>
+protected org.opensaml.saml2.metadata.EntityDescriptor <B>getEntity</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;name)
+ throws <A HREF="../../../../../edu/internet2/middleware/shibboleth/wayf/WayfException.html" title="class in edu.internet2.middleware.shibboleth.wayf">WayfException</A></PRE>
+<DL>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+
+<DT><B>Throws:</B>
+<DD><CODE><A HREF="../../../../../edu/internet2/middleware/shibboleth/wayf/WayfException.html" title="class in edu.internet2.middleware.shibboleth.wayf">WayfException</A></CODE></DL>
+</DD>
+</DL>
+<!-- ========= END OF CLASS DATA ========= -->
+<HR>
+
+
+<!-- ======= START OF BOTTOM NAVBAR ====== -->
+<A NAME="navbar_bottom"><!-- --></A>
+<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
+<TR>
+<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<A NAME="navbar_bottom_firstrow"><!-- --></A>
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
+ <TR ALIGN="center" VALIGN="top">
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/IdPSiteSet.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
+ </TR>
+</TABLE>
+</TD>
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
+</EM>
+</TD>
+</TR>
+
+<TR>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+&nbsp;<A HREF="../../../../../edu/internet2/middleware/shibboleth/wayf/IdPSite.Compare.html" title="class in edu.internet2.middleware.shibboleth.wayf"><B>PREV CLASS</B></A>&nbsp;
+&nbsp;<A HREF="../../../../../edu/internet2/middleware/shibboleth/wayf/IdPSiteSetEntry.html" title="class in edu.internet2.middleware.shibboleth.wayf"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../../../index.html?edu/internet2/middleware/shibboleth/wayf/IdPSiteSet.html" target="_top"><B>FRAMES</B></A> &nbsp;
+&nbsp;<A HREF="IdPSiteSet.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
+&nbsp;<SCRIPT type="text/javascript">
+ <!--
+ if(window==top) {
+ document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
+ }
+ //-->
+</SCRIPT>
+<NOSCRIPT>
+ <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
+</NOSCRIPT>
+
+
+</FONT></TD>
+</TR>
+<TR>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+ SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
+DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
+</TR>
+</TABLE>
+<A NAME="skip-navbar_bottom"></A>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+
+<HR>
+Copyright &#169; 2006-2009 <a href="http://www.internet2.edu/">Internet2</a>. All Rights Reserved.
+</BODY>
+</HTML>