<!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.6.0_22) on Fri Nov 19 06:49:20 EST 2010 -->
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<TITLE>
SamlCookiePlugin (Shibboleth Discovery Service 1.1.2 Java API.)
</TITLE>
<META NAME="date" CONTENT="2010-11-19">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="SamlCookiePlugin (Shibboleth Discovery Service 1.1.2 Java API.)";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= 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> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/SamlCookiePlugin.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/provider/ListFilter.html" title="class in edu.internet2.middleware.shibboleth.wayf.plugins.provider"><B>PREV CLASS</B></A>
<A HREF="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/provider/SamlCookiePlugin.SamlIdPCookie.html" title="class in edu.internet2.middleware.shibboleth.wayf.plugins.provider"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../../../index.html?edu/internet2/middleware/shibboleth/wayf/plugins/provider/SamlCookiePlugin.html" target="_top"><B>FRAMES</B></A>
<A HREF="SamlCookiePlugin.html" target="_top"><B>NO FRAMES</B></A>
<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: <A HREF="#nested_class_summary">NESTED</A> | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <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.plugins.provider</FONT>
<BR>
Class SamlCookiePlugin</H2>
<PRE>
<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true" 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.plugins.provider.SamlCookiePlugin</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/Plugin.html" title="interface in edu.internet2.middleware.shibboleth.wayf.plugins">Plugin</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public class <B>SamlCookiePlugin</B><DT>extends <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A><DT>implements <A HREF="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/Plugin.html" title="interface in edu.internet2.middleware.shibboleth.wayf.plugins">Plugin</A></DL>
</PRE>
<P>
This is a test implementation of the saml cookie lookup stuff to
see whether it fits the plugin architecture.
<P>
<P>
<HR>
<P>
<!-- ======== NESTED CLASS SUMMARY ======== -->
<A NAME="nested_class_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>Nested Class Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> class</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/provider/SamlCookiePlugin.SamlIdPCookie.html" title="class in edu.internet2.middleware.shibboleth.wayf.plugins.provider">SamlCookiePlugin.SamlIdPCookie</A></B></CODE>
<BR>
Class to abstract away the saml cookie for us.</TD>
</TR>
</TABLE>
<!-- ======== 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><CODE><B><A HREF="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/provider/SamlCookiePlugin.html#SamlCookiePlugin(org.w3c.dom.Element)">SamlCookiePlugin</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/org/w3c/dom/Element.html?is-external=true" title="class or interface in org.w3c.dom">Element</A> element)</CODE>
<BR>
This constructor is called during wayf initialization with it's
own little bit of XML config.</TD>
</TR>
</TABLE>
<!-- ========== 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> <A HREF="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/PluginContext.html" title="interface in edu.internet2.middleware.shibboleth.wayf.plugins">PluginContext</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/provider/SamlCookiePlugin.html#lookup(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, edu.internet2.middleware.shibboleth.wayf.plugins.PluginMetadataParameter, java.util.Map, edu.internet2.middleware.shibboleth.wayf.plugins.PluginContext, java.util.List)">lookup</A></B>(javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse res,
<A HREF="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/PluginMetadataParameter.html" title="interface in edu.internet2.middleware.shibboleth.wayf.plugins">PluginMetadataParameter</A> parameter,
<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A><<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" 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>> validIdps,
<A HREF="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/PluginContext.html" title="interface in edu.internet2.middleware.shibboleth.wayf.plugins">PluginContext</A> context,
<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../../../../../edu/internet2/middleware/shibboleth/wayf/IdPSite.html" title="class in edu.internet2.middleware.shibboleth.wayf">IdPSite</A>> idpList)</CODE>
<BR>
This is the 'hook' in the lookup part of Discovery Service processing.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <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/plugins/provider/SamlCookiePlugin.html#refreshMetadata(org.opensaml.saml2.metadata.provider.MetadataProvider)">refreshMetadata</A></B>(org.opensaml.saml2.metadata.provider.MetadataProvider metadata)</CODE>
<BR>
Plugin point which is called when the data is refreshed.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/PluginContext.html" title="interface in edu.internet2.middleware.shibboleth.wayf.plugins">PluginContext</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/provider/SamlCookiePlugin.html#search(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, edu.internet2.middleware.shibboleth.wayf.plugins.PluginMetadataParameter, java.lang.String, java.util.Map, edu.internet2.middleware.shibboleth.wayf.plugins.PluginContext, java.util.Collection, java.util.List)">search</A></B>(javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse res,
<A HREF="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/PluginMetadataParameter.html" title="interface in edu.internet2.middleware.shibboleth.wayf.plugins">PluginMetadataParameter</A> parameter,
<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> pattern,
<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A><<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" 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>> validIdps,
<A HREF="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/PluginContext.html" title="interface in edu.internet2.middleware.shibboleth.wayf.plugins">PluginContext</A> context,
<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A><<A HREF="../../../../../../../edu/internet2/middleware/shibboleth/wayf/IdPSite.html" title="class in edu.internet2.middleware.shibboleth.wayf">IdPSite</A>> searchResult,
<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../../../../../edu/internet2/middleware/shibboleth/wayf/IdPSite.html" title="class in edu.internet2.middleware.shibboleth.wayf">IdPSite</A>> idpList)</CODE>
<BR>
Plgin point for searching.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/provider/SamlCookiePlugin.html#selected(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, edu.internet2.middleware.shibboleth.wayf.plugins.PluginMetadataParameter, java.lang.String)">selected</A></B>(javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse res,
<A HREF="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/PluginMetadataParameter.html" title="interface in edu.internet2.middleware.shibboleth.wayf.plugins">PluginMetadataParameter</A> parameter,
<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> idP)</CODE>
<BR>
Plugin point for selection.</TD>
</TR>
</TABLE>
<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?is-external=true" 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?is-external=true#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?is-external=true#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?is-external=true#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?is-external=true#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?is-external=true#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?is-external=true#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?is-external=true#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?is-external=true#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?is-external=true#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?is-external=true#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?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
</TR>
</TABLE>
<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="SamlCookiePlugin(org.w3c.dom.Element)"><!-- --></A><H3>
SamlCookiePlugin</H3>
<PRE>
public <B>SamlCookiePlugin</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/org/w3c/dom/Element.html?is-external=true" title="class or interface in org.w3c.dom">Element</A> element)</PRE>
<DL>
<DD>This constructor is called during wayf initialization with it's
own little bit of XML config.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>element</CODE> - - further information to be gleaned from the DOM.</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="lookup(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, edu.internet2.middleware.shibboleth.wayf.plugins.PluginMetadataParameter, java.util.Map, edu.internet2.middleware.shibboleth.wayf.plugins.PluginContext, java.util.List)"><!-- --></A><H3>
lookup</H3>
<PRE>
public <A HREF="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/PluginContext.html" title="interface in edu.internet2.middleware.shibboleth.wayf.plugins">PluginContext</A> <B>lookup</B>(javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse res,
<A HREF="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/PluginMetadataParameter.html" title="interface in edu.internet2.middleware.shibboleth.wayf.plugins">PluginMetadataParameter</A> parameter,
<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A><<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" 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>> validIdps,
<A HREF="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/PluginContext.html" title="interface in edu.internet2.middleware.shibboleth.wayf.plugins">PluginContext</A> context,
<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../../../../../edu/internet2/middleware/shibboleth/wayf/IdPSite.html" title="class in edu.internet2.middleware.shibboleth.wayf">IdPSite</A>> idpList)
throws <A HREF="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/WayfRequestHandled.html" title="class in edu.internet2.middleware.shibboleth.wayf.plugins">WayfRequestHandled</A></PRE>
<DL>
<DD>This is the 'hook' in the lookup part of Discovery Service processing.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/Plugin.html#lookup(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, edu.internet2.middleware.shibboleth.wayf.plugins.PluginMetadataParameter, java.util.Map, edu.internet2.middleware.shibboleth.wayf.plugins.PluginContext, java.util.List)">lookup</A></CODE> in interface <CODE><A HREF="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/Plugin.html" title="interface in edu.internet2.middleware.shibboleth.wayf.plugins">Plugin</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>req</CODE> - - Describes the current request. Used to find any appropriate cookies<DD><CODE>res</CODE> - - Describes the current response. Used to redirect the request.<DD><CODE>parameter</CODE> - - Describes the metadata.<DD><CODE>context</CODE> - - Any processing context returned from a previous call. We set this on first call and
use non null to indicate that we don't go there again.<DD><CODE>validIdps</CODE> - The list of IdPs which is currently views as possibly matches for the pattern.
The Key is the EntityId for the IdP and the value the object which describes
the Idp<DD><CODE>idpList</CODE> - The set of Idps which are currently considered as potential hints.
<DT><B>Returns:</B><DD>a context to hand to subsequent calls
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/WayfRequestHandled.html" title="class in edu.internet2.middleware.shibboleth.wayf.plugins">WayfRequestHandled</A></CODE> - if the plugin has handled the request.
issues a redirect)<DT><B>See Also:</B><DD><A HREF="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/Plugin.html#lookup(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, edu.internet2.middleware.shibboleth.wayf.plugins.PluginMetadataParameter, java.util.Map, edu.internet2.middleware.shibboleth.wayf.plugins.PluginContext, java.util.List)"><CODE>Plugin.lookup(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, edu.internet2.middleware.shibboleth.wayf.plugins.PluginMetadataParameter, java.util.Map<java.lang.String, edu.internet2.middleware.shibboleth.wayf.IdPSite>, edu.internet2.middleware.shibboleth.wayf.plugins.PluginContext, java.util.List<edu.internet2.middleware.shibboleth.wayf.IdPSite>)</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="refreshMetadata(org.opensaml.saml2.metadata.provider.MetadataProvider)"><!-- --></A><H3>
refreshMetadata</H3>
<PRE>
public <A HREF="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/PluginMetadataParameter.html" title="interface in edu.internet2.middleware.shibboleth.wayf.plugins">PluginMetadataParameter</A> <B>refreshMetadata</B>(org.opensaml.saml2.metadata.provider.MetadataProvider metadata)</PRE>
<DL>
<DD>Plugin point which is called when the data is refreshed.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/Plugin.html#refreshMetadata(org.opensaml.saml2.metadata.provider.MetadataProvider)">refreshMetadata</A></CODE> in interface <CODE><A HREF="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/Plugin.html" title="interface in edu.internet2.middleware.shibboleth.wayf.plugins">Plugin</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>metadata</CODE> - - where to get the data from.
<DT><B>Returns:</B><DD>the value which will be provided as input to subsequent calls<DT><B>See Also:</B><DD><A HREF="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/Plugin.html#refreshMetadata(org.opensaml.saml2.metadata.provider.MetadataProvider)"><CODE>Plugin.refreshMetadata(org.opensaml.saml2.metadata.provider.MetadataProvider)</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="search(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, edu.internet2.middleware.shibboleth.wayf.plugins.PluginMetadataParameter, java.lang.String, java.util.Map, edu.internet2.middleware.shibboleth.wayf.plugins.PluginContext, java.util.Collection, java.util.List)"><!-- --></A><H3>
search</H3>
<PRE>
public <A HREF="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/PluginContext.html" title="interface in edu.internet2.middleware.shibboleth.wayf.plugins">PluginContext</A> <B>search</B>(javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse res,
<A HREF="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/PluginMetadataParameter.html" title="interface in edu.internet2.middleware.shibboleth.wayf.plugins">PluginMetadataParameter</A> parameter,
<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> pattern,
<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</A><<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" 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>> validIdps,
<A HREF="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/PluginContext.html" title="interface in edu.internet2.middleware.shibboleth.wayf.plugins">PluginContext</A> context,
<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</A><<A HREF="../../../../../../../edu/internet2/middleware/shibboleth/wayf/IdPSite.html" title="class in edu.internet2.middleware.shibboleth.wayf">IdPSite</A>> searchResult,
<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../../../../../edu/internet2/middleware/shibboleth/wayf/IdPSite.html" title="class in edu.internet2.middleware.shibboleth.wayf">IdPSite</A>> idpList)
throws <A HREF="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/WayfRequestHandled.html" title="class in edu.internet2.middleware.shibboleth.wayf.plugins">WayfRequestHandled</A></PRE>
<DL>
<DD>Plgin point for searching.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/Plugin.html#search(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, edu.internet2.middleware.shibboleth.wayf.plugins.PluginMetadataParameter, java.lang.String, java.util.Map, edu.internet2.middleware.shibboleth.wayf.plugins.PluginContext, java.util.Collection, java.util.List)">search</A></CODE> in interface <CODE><A HREF="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/Plugin.html" title="interface in edu.internet2.middleware.shibboleth.wayf.plugins">Plugin</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>req</CODE> - Describes the current request.<DD><CODE>res</CODE> - Describes the current response.<DD><CODE>parameter</CODE> - Describes the metadata.<DD><CODE>pattern</CODE> - What we are searchign for.<DD><CODE>validIdps</CODE> - The list of IdPs which is currently views as possibly matches for the pattern.
The Key is the EntityId for the IdP and the value the object which describes
the Idp<DD><CODE>context</CODE> - Any processing context returned from a previous call. We set this on first call and
use non null to indicate that we don't go there again.<DD><CODE>searchResult</CODE> - What the search yielded.<DD><CODE>idpList</CODE> - The set of Idps which are currently considered as potential hints.
<DT><B>Returns:</B><DD>a context to hand to subsequent calls.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/WayfRequestHandled.html" title="class in edu.internet2.middleware.shibboleth.wayf.plugins">WayfRequestHandled</A></CODE>
<DD><CODE><A HREF="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/WayfRequestHandled.html" title="class in edu.internet2.middleware.shibboleth.wayf.plugins">WayfRequestHandled</A></CODE> - if the plugin has handled the request.<DT><B>See Also:</B><DD><A HREF="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/Plugin.html#search(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, edu.internet2.middleware.shibboleth.wayf.plugins.PluginMetadataParameter, java.lang.String, java.util.Map, edu.internet2.middleware.shibboleth.wayf.plugins.PluginContext, java.util.Collection, java.util.List)"><CODE>Plugin.search(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, edu.internet2.middleware.shibboleth.wayf.plugins.PluginMetadataParameter, java.lang.String, java.util.Map<java.lang.String, edu.internet2.middleware.shibboleth.wayf.IdPSite>, edu.internet2.middleware.shibboleth.wayf.plugins.PluginContext, java.util.Collection<edu.internet2.middleware.shibboleth.wayf.IdPSite>, java.util.List<edu.internet2.middleware.shibboleth.wayf.IdPSite>)</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="selected(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, edu.internet2.middleware.shibboleth.wayf.plugins.PluginMetadataParameter, java.lang.String)"><!-- --></A><H3>
selected</H3>
<PRE>
public void <B>selected</B>(javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse res,
<A HREF="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/PluginMetadataParameter.html" title="interface in edu.internet2.middleware.shibboleth.wayf.plugins">PluginMetadataParameter</A> parameter,
<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> idP)</PRE>
<DL>
<DD>Plugin point for selection.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/Plugin.html#selected(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, edu.internet2.middleware.shibboleth.wayf.plugins.PluginMetadataParameter, java.lang.String)">selected</A></CODE> in interface <CODE><A HREF="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/Plugin.html" title="interface in edu.internet2.middleware.shibboleth.wayf.plugins">Plugin</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>req</CODE> - Describes the current request.<DD><CODE>res</CODE> - Describes the current response.<DD><CODE>parameter</CODE> - Describes the metadata.<DD><CODE>idP</CODE> - Describes the idp.<DT><B>See Also:</B><DD><CODE>edu.internet2.middleware.shibboleth.wayf.plugins.Plugin#selected(javax.servlet.http.HttpServletRequest.
javax.servlet.http.HttpServletResponse,
edu.internet2.middleware.shibboleth.wayf.plugins.PluginMetadataParameter,
java.lang.String)</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> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/SamlCookiePlugin.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/provider/ListFilter.html" title="class in edu.internet2.middleware.shibboleth.wayf.plugins.provider"><B>PREV CLASS</B></A>
<A HREF="../../../../../../../edu/internet2/middleware/shibboleth/wayf/plugins/provider/SamlCookiePlugin.SamlIdPCookie.html" title="class in edu.internet2.middleware.shibboleth.wayf.plugins.provider"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../../../index.html?edu/internet2/middleware/shibboleth/wayf/plugins/provider/SamlCookiePlugin.html" target="_top"><B>FRAMES</B></A>
<A HREF="SamlCookiePlugin.html" target="_top"><B>NO FRAMES</B></A>
<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: <A HREF="#nested_class_summary">NESTED</A> | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
Copyright © 2006-2010 <a href="http://www.internet2.edu/">Internet2</a>. All Rights Reserved.
</BODY>
</HTML>