From 0a90384a9c7d840e88d9636271e8393a514647a0 Mon Sep 17 00:00:00 2001 From: Leif Johansson Date: Tue, 28 Jul 2009 10:34:52 +0200 Subject: Import shibboleth ds 1.1.0 --- .../middleware/shibboleth/wayf/plugins/Plugin.html | 381 +++++++++++++++++++ .../shibboleth/wayf/plugins/PluginContext.html | 179 +++++++++ .../wayf/plugins/PluginMetadataParameter.html | 177 +++++++++ .../wayf/plugins/WayfRequestHandled.html | 243 ++++++++++++ .../shibboleth/wayf/plugins/class-use/Plugin.html | 232 ++++++++++++ .../wayf/plugins/class-use/PluginContext.html | 318 ++++++++++++++++ .../plugins/class-use/PluginMetadataParameter.html | 329 +++++++++++++++++ .../wayf/plugins/class-use/WayfRequestHandled.html | 257 +++++++++++++ .../shibboleth/wayf/plugins/package-frame.html | 48 +++ .../shibboleth/wayf/plugins/package-summary.html | 179 +++++++++ .../shibboleth/wayf/plugins/package-tree.html | 160 ++++++++ .../shibboleth/wayf/plugins/package-use.html | 246 +++++++++++++ .../wayf/plugins/provider/BindingFilter.html | 270 ++++++++++++++ .../wayf/plugins/provider/ListFilter.html | 278 ++++++++++++++ .../provider/SamlCookiePlugin.SamlIdPCookie.html | 250 +++++++++++++ .../wayf/plugins/provider/SamlCookiePlugin.html | 408 +++++++++++++++++++++ .../plugins/provider/class-use/BindingFilter.html | 141 +++++++ .../plugins/provider/class-use/ListFilter.html | 141 +++++++ .../class-use/SamlCookiePlugin.SamlIdPCookie.html | 141 +++++++ .../provider/class-use/SamlCookiePlugin.html | 141 +++++++ .../wayf/plugins/provider/package-frame.html | 37 ++ .../wayf/plugins/provider/package-summary.html | 164 +++++++++ .../wayf/plugins/provider/package-tree.html | 153 ++++++++ .../wayf/plugins/provider/package-use.html | 141 +++++++ 24 files changed, 5014 insertions(+) create mode 100644 doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/Plugin.html create mode 100644 doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/PluginContext.html create mode 100644 doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/PluginMetadataParameter.html create mode 100644 doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/WayfRequestHandled.html create mode 100644 doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/class-use/Plugin.html create mode 100644 doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/class-use/PluginContext.html create mode 100644 doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/class-use/PluginMetadataParameter.html create mode 100644 doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/class-use/WayfRequestHandled.html create mode 100644 doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/package-frame.html create mode 100644 doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/package-summary.html create mode 100644 doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/package-tree.html create mode 100644 doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/package-use.html create mode 100644 doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/provider/BindingFilter.html create mode 100644 doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/provider/ListFilter.html create mode 100644 doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/provider/SamlCookiePlugin.SamlIdPCookie.html create mode 100644 doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/provider/SamlCookiePlugin.html create mode 100644 doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/provider/class-use/BindingFilter.html create mode 100644 doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/provider/class-use/ListFilter.html create mode 100644 doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/provider/class-use/SamlCookiePlugin.SamlIdPCookie.html create mode 100644 doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/provider/class-use/SamlCookiePlugin.html create mode 100644 doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/provider/package-frame.html create mode 100644 doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/provider/package-summary.html create mode 100644 doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/provider/package-tree.html create mode 100644 doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/provider/package-use.html (limited to 'doc/api/edu/internet2/middleware/shibboleth/wayf/plugins') diff --git a/doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/Plugin.html b/doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/Plugin.html new file mode 100644 index 0000000..fd2e55d --- /dev/null +++ b/doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/Plugin.html @@ -0,0 +1,381 @@ + + + + + + + +Plugin (Shibboleth Discovery Service 1.1.0 Java API.) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +edu.internet2.middleware.shibboleth.wayf.plugins +
+Interface Plugin

+
+
All Known Implementing Classes:
SamlCookiePlugin
+
+
+
+
public interface Plugin
+ + +

+The Plugin interface is used to affect the 'hints' that the WAYF offers to the users. +

+ The WAYF can register any number of plugins. Each plugin is called when the metadata is loaded or realoaded + (so it can do any indexing) and at the three entry points into the WAYF - Lookup (main entry), Search and Select. + Plugins are called in the order in which they are declared to the WAYF. +

+ Each plugin is called once when the user has made a selection. +

+ For Search and Lookup, each plugin is called multiple times, once for each metadata provider which has + been declared to this particular WAYF instance. The plugin can return a context which is handed to subsequent calls. +

+ The idea is that each plugin can affect the displayed lists of IdPs. As a reminder the WAYF displays two lists of + IdPs - the complete list, displayed either as a single list or a list of lists, and the hint list (which was + previously only populated from the _saml_idp cookie. In the search case the WAYF displays a third list of + the search hits. +

+ When the plugin in called it is given the current set of potential IdPs as a Map from EntityID to IdPSite + and lists representing the current hint list and search results. A Plugin can remove an entry from + the map or the lists. Additionally it can insert an IdPSite found in the Map into the hint or search lists. + Thus the plugin can restrict the number of sites that the WAYF instance displays in the 'complete list' and + can add or remove IdPs from the hint list. +

+ At any stage the plugin can take control of the current request and redirect or forward it. It signals that + it has done this to the WAYF by means of an exception. +

+ The _saml_idp cookie handling code is written as a WAYF plugin. Other plugins have been written to allow IdPs + to be presented as hints based on the client's IP address or to redirect back to the SP once the choice of + IdP has been made. +

+ Object implementing this interface are created during WAYF discovery service initialization. There are + expected to implement a constructor which takes a Element as the only parameter and they are + created via this constructor, with the parameter being the appropriate section of the WAYF configuration file +

+ +

+

+
Version:
+
Discussion
+
+
+ +

+ + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ PluginContextlookup(javax.servlet.http.HttpServletRequest req, + javax.servlet.http.HttpServletResponse res, + PluginMetadataParameter parameter, + Map<String,IdPSite> validIdps, + PluginContext context, + List<IdPSite> idpList) + +
+          The WAYF calls each plugin at this entry point when it is first contacted.
+ PluginMetadataParameterrefreshMetadata(org.opensaml.saml2.metadata.provider.MetadataProvider metadata) + +
+          Whenever the WAYF discoveres that the metadata is stale, it reloads it and calls each plugin at this method.
+ PluginContextsearch(javax.servlet.http.HttpServletRequest req, + javax.servlet.http.HttpServletResponse res, + PluginMetadataParameter parameter, + String pattern, + Map<String,IdPSite> validIdps, + PluginContext context, + Collection<IdPSite> searchResult, + List<IdPSite> idpList) + +
+          This method is called when the user specified a search operation.
+ voidselected(javax.servlet.http.HttpServletRequest req, + javax.servlet.http.HttpServletResponse res, + PluginMetadataParameter parameter, + String idP) + +
+          This method is called, for every plugin, after a user has selected an IdP.
+  +

+ + + + + + + + +
+Method Detail
+ +

+refreshMetadata

+
+PluginMetadataParameter refreshMetadata(org.opensaml.saml2.metadata.provider.MetadataProvider metadata)
+
+
Whenever the WAYF discoveres that the metadata is stale, it reloads it and calls each plugin at this method. +

+

+
Parameters:
metadata - - where to get the data from. +
Returns:
the value which will be provided as input to subsequent calls to Lookup and + Search
+
+
+
+ +

+lookup

+
+PluginContext lookup(javax.servlet.http.HttpServletRequest req,
+                     javax.servlet.http.HttpServletResponse res,
+                     PluginMetadataParameter parameter,
+                     Map<String,IdPSite> validIdps,
+                     PluginContext context,
+                     List<IdPSite> idpList)
+                     throws WayfRequestHandled
+
+
The WAYF calls each plugin at this entry point when it is first contacted. +

+

+
Parameters:
req - - Describes the current request. A Plugin might use it to find any appropriate cookies
res - - Describes the current response. A Plugin might use it to redirect a the request.
parameter - Describes the metadata.
context - Any processing context returned from a previous call.
validIdps - 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
idpList - The set of Idps which are currently considered as potential hints. +
Returns:
a context to hand to subsequent calls +
Throws: +
WayfRequestHandled - if the plugin has handled the request (for instance it has + issues a redirect) + + Each plugin is called multiple times, + once for each metadata provider which is registered (Depending on the precise configuration of the WAYF + metadata providers whose metadata does not include the target may be dropped). Initially the plugin is + called with a context parameter of null. In subsequent calls, the value returned from + the previous call is passed in as the context parameter. + + The plugin may remove IdPSite objects from the validIdps list. + + The plugin may add or remove them to the idpList. IdPSite Objects which are to be added to the idpList + should be looked up by EntityIdName in validIdps by EntityId. Hence any metadata processing shoudl + store the entityID.
+
+
+
+ +

+search

+
+PluginContext search(javax.servlet.http.HttpServletRequest req,
+                     javax.servlet.http.HttpServletResponse res,
+                     PluginMetadataParameter parameter,
+                     String pattern,
+                     Map<String,IdPSite> validIdps,
+                     PluginContext context,
+                     Collection<IdPSite> searchResult,
+                     List<IdPSite> idpList)
+                     throws WayfRequestHandled
+
+
This method is called when the user specified a search operation. The processing is similar to + that described for lookup. + Two additional paramaters are provided, the search parameter which was provided, and the current + proposed list of candidate IdPs. The plugin is at liberty to alter both the list of hints and the + list of valid IdPs. +

+

+
Parameters:
req - Describes the current request. The Plugin could use it to find any appropriate cookies
res - Describes the result - this is needed if (for instance) a plung needs to change cookie values
parameter - Describes the metadata
pattern - The Search pattern provided
validIdps - The list of IdPs which is currently views as possibly matches for the pattern. + The Key is the Idp Name an the value the idp
context - Any processing context returned from a previous call.
searchResult - the resukt of any search
idpList - The set of Idps which are currently considered as potential hints. Each Idp is associated + with a numeric weight, where the lower the number is the more likely the IdP is to be a candidate. + As descibed above the WAYF uses this to provide hint list to the GUI (or even to dispatch + immediately to the IdP). +
Returns:
a context to hand to subsequent calls +
Throws: +
WayfRequestHandled - if the plugin has handled the request (for instance it has + issues a redirect)
+
+
+
+ +

+selected

+
+void selected(javax.servlet.http.HttpServletRequest req,
+              javax.servlet.http.HttpServletResponse res,
+              PluginMetadataParameter parameter,
+              String idP)
+              throws WayfRequestHandled
+
+
This method is called, for every plugin, after a user has selected an IdP. The plugin is expected + to use it to update any in memory state (via the PluginMetadataParameter parameter or permananent + state (for instance by writing back a cookie. +

+

+
Parameters:
req - Describes the current request.
res - Describes the current response
parameter - Describes the metadata +
Throws: +
WayfRequestHandled - if the plugin has handled the request (for instance it has + issues a redirect)
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2006-2009 Internet2. All Rights Reserved. + + diff --git a/doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/PluginContext.html b/doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/PluginContext.html new file mode 100644 index 0000000..a52ce92 --- /dev/null +++ b/doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/PluginContext.html @@ -0,0 +1,179 @@ + + + + + + + +PluginContext (Shibboleth Discovery Service 1.1.0 Java API.) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +edu.internet2.middleware.shibboleth.wayf.plugins +
+Interface PluginContext

+
+
+
public interface PluginContext
+ + +

+This is a marker interface. +

+ Objects which implement PluginContext are passed between sucessive calls to a plugins implementations of + lookup and search as the plugin + is called for each MetadataProvider. +

+

+ +

+

+
Version:
+
Discussion
+
+
+ +

+ +

+ +

+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2006-2009 Internet2. All Rights Reserved. + + diff --git a/doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/PluginMetadataParameter.html b/doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/PluginMetadataParameter.html new file mode 100644 index 0000000..0922980 --- /dev/null +++ b/doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/PluginMetadataParameter.html @@ -0,0 +1,177 @@ + + + + + + + +PluginMetadataParameter (Shibboleth Discovery Service 1.1.0 Java API.) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +edu.internet2.middleware.shibboleth.wayf.plugins +
+Interface PluginMetadataParameter

+
+
+
public interface PluginMetadataParameter
+ + +

+The PluginParameter is a marker interface which a WAYF Plugin can use to associate extra information + with the metadata. Each plugin returns a PluginParameter from RefreshMetadata + and this is in turn presented back to then Plugin when it is called during WAYF processing. +

+

+ +

+

+
Version:
+
Discussion
+
+
+ +

+ +

+ +

+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2006-2009 Internet2. All Rights Reserved. + + diff --git a/doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/WayfRequestHandled.html b/doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/WayfRequestHandled.html new file mode 100644 index 0000000..3ef38e1 --- /dev/null +++ b/doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/WayfRequestHandled.html @@ -0,0 +1,243 @@ + + + + + + + +WayfRequestHandled (Shibboleth Discovery Service 1.1.0 Java API.) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +edu.internet2.middleware.shibboleth.wayf.plugins +
+Class WayfRequestHandled

+
+java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by edu.internet2.middleware.shibboleth.wayf.plugins.WayfRequestHandled
+
+
+
All Implemented Interfaces:
Serializable
+
+
+
+
public class WayfRequestHandled
extends Exception
+ + +

+This Exception can be signalled by a plugin to indicate to the WAYF that it has handled the + request and all processing should stop. +

+ +

+

+
See Also:
Serialized Form
+
+ +

+ + + + + + + + + + + +
+Constructor Summary
WayfRequestHandled() + +
+           
+  + + + + + + + +
+Method Summary
+  + + + + + + + +
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
+  + + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+WayfRequestHandled

+
+public WayfRequestHandled()
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2006-2009 Internet2. All Rights Reserved. + + diff --git a/doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/class-use/Plugin.html b/doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/class-use/Plugin.html new file mode 100644 index 0000000..0521d9a --- /dev/null +++ b/doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/class-use/Plugin.html @@ -0,0 +1,232 @@ + + + + + + + +Uses of Interface edu.internet2.middleware.shibboleth.wayf.plugins.Plugin (Shibboleth Discovery Service 1.1.0 Java API.) + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
edu.internet2.middleware.shibboleth.wayf.plugins.Plugin

+
+ + + + + + + + + + + + + +
+Packages that use Plugin
edu.internet2.middleware.shibboleth.wayf  
edu.internet2.middleware.shibboleth.wayf.plugins.provider  
+  +

+ + + + + +
+Uses of Plugin in edu.internet2.middleware.shibboleth.wayf
+  +

+ + + + + + + + + + + + + +
Methods in edu.internet2.middleware.shibboleth.wayf with parameters of type Plugin
+protected  voidIdPSiteSet.addPlugin(Plugin plugin) + +
+          Declares a plugin to the siteset.
+protected  PluginMetadataParameterIdPSiteSet.paramFor(Plugin plugin) + +
+          Return the parameter that this plugin uses.
+  +

+ + + + + + + + +
Constructor parameters in edu.internet2.middleware.shibboleth.wayf with type arguments of type Plugin
DiscoveryServiceHandler(Element config, + Hashtable<String,IdPSiteSet> federations, + Hashtable<String,Plugin> plugins, + HandlerConfig defaultConfig) + +
+          Constructor to create and configure the handler.
+  +

+ + + + + +
+Uses of Plugin in edu.internet2.middleware.shibboleth.wayf.plugins.provider
+  +

+ + + + + + + + + +
Classes in edu.internet2.middleware.shibboleth.wayf.plugins.provider that implement Plugin
+ classSamlCookiePlugin + +
+          This is a test implementation of the saml cookie lookup stuff to + see whether it fits the plugin architecture.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2006-2009 Internet2. All Rights Reserved. + + diff --git a/doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/class-use/PluginContext.html b/doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/class-use/PluginContext.html new file mode 100644 index 0000000..a1c190a --- /dev/null +++ b/doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/class-use/PluginContext.html @@ -0,0 +1,318 @@ + + + + + + + +Uses of Interface edu.internet2.middleware.shibboleth.wayf.plugins.PluginContext (Shibboleth Discovery Service 1.1.0 Java API.) + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
edu.internet2.middleware.shibboleth.wayf.plugins.PluginContext

+
+ + + + + + + + + + + + + +
+Packages that use PluginContext
edu.internet2.middleware.shibboleth.wayf.plugins  
edu.internet2.middleware.shibboleth.wayf.plugins.provider  
+  +

+ + + + + +
+Uses of PluginContext in edu.internet2.middleware.shibboleth.wayf.plugins
+  +

+ + + + + + + + + + + + + +
Methods in edu.internet2.middleware.shibboleth.wayf.plugins that return PluginContext
+ PluginContextPlugin.lookup(javax.servlet.http.HttpServletRequest req, + javax.servlet.http.HttpServletResponse res, + PluginMetadataParameter parameter, + Map<String,IdPSite> validIdps, + PluginContext context, + List<IdPSite> idpList) + +
+          The WAYF calls each plugin at this entry point when it is first contacted.
+ PluginContextPlugin.search(javax.servlet.http.HttpServletRequest req, + javax.servlet.http.HttpServletResponse res, + PluginMetadataParameter parameter, + String pattern, + Map<String,IdPSite> validIdps, + PluginContext context, + Collection<IdPSite> searchResult, + List<IdPSite> idpList) + +
+          This method is called when the user specified a search operation.
+  +

+ + + + + + + + + + + + + +
Methods in edu.internet2.middleware.shibboleth.wayf.plugins with parameters of type PluginContext
+ PluginContextPlugin.lookup(javax.servlet.http.HttpServletRequest req, + javax.servlet.http.HttpServletResponse res, + PluginMetadataParameter parameter, + Map<String,IdPSite> validIdps, + PluginContext context, + List<IdPSite> idpList) + +
+          The WAYF calls each plugin at this entry point when it is first contacted.
+ PluginContextPlugin.search(javax.servlet.http.HttpServletRequest req, + javax.servlet.http.HttpServletResponse res, + PluginMetadataParameter parameter, + String pattern, + Map<String,IdPSite> validIdps, + PluginContext context, + Collection<IdPSite> searchResult, + List<IdPSite> idpList) + +
+          This method is called when the user specified a search operation.
+  +

+ + + + + +
+Uses of PluginContext in edu.internet2.middleware.shibboleth.wayf.plugins.provider
+  +

+ + + + + + + + + + + + + +
Methods in edu.internet2.middleware.shibboleth.wayf.plugins.provider that return PluginContext
+ PluginContextSamlCookiePlugin.lookup(javax.servlet.http.HttpServletRequest req, + javax.servlet.http.HttpServletResponse res, + PluginMetadataParameter parameter, + Map<String,IdPSite> validIdps, + PluginContext context, + List<IdPSite> idpList) + +
+          This is the 'hook' in the lookup part of Discovery Service processing.
+ PluginContextSamlCookiePlugin.search(javax.servlet.http.HttpServletRequest req, + javax.servlet.http.HttpServletResponse res, + PluginMetadataParameter parameter, + String pattern, + Map<String,IdPSite> validIdps, + PluginContext context, + Collection<IdPSite> searchResult, + List<IdPSite> idpList) + +
+          Plgin point for searching.
+  +

+ + + + + + + + + + + + + +
Methods in edu.internet2.middleware.shibboleth.wayf.plugins.provider with parameters of type PluginContext
+ PluginContextSamlCookiePlugin.lookup(javax.servlet.http.HttpServletRequest req, + javax.servlet.http.HttpServletResponse res, + PluginMetadataParameter parameter, + Map<String,IdPSite> validIdps, + PluginContext context, + List<IdPSite> idpList) + +
+          This is the 'hook' in the lookup part of Discovery Service processing.
+ PluginContextSamlCookiePlugin.search(javax.servlet.http.HttpServletRequest req, + javax.servlet.http.HttpServletResponse res, + PluginMetadataParameter parameter, + String pattern, + Map<String,IdPSite> validIdps, + PluginContext context, + Collection<IdPSite> searchResult, + List<IdPSite> idpList) + +
+          Plgin point for searching.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2006-2009 Internet2. All Rights Reserved. + + diff --git a/doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/class-use/PluginMetadataParameter.html b/doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/class-use/PluginMetadataParameter.html new file mode 100644 index 0000000..b442fa8 --- /dev/null +++ b/doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/class-use/PluginMetadataParameter.html @@ -0,0 +1,329 @@ + + + + + + + +Uses of Interface edu.internet2.middleware.shibboleth.wayf.plugins.PluginMetadataParameter (Shibboleth Discovery Service 1.1.0 Java API.) + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Interface
edu.internet2.middleware.shibboleth.wayf.plugins.PluginMetadataParameter

+
+ + + + + + + + + + + + + + + + + +
+Packages that use PluginMetadataParameter
edu.internet2.middleware.shibboleth.wayf  
edu.internet2.middleware.shibboleth.wayf.plugins  
edu.internet2.middleware.shibboleth.wayf.plugins.provider  
+  +

+ + + + + +
+Uses of PluginMetadataParameter in edu.internet2.middleware.shibboleth.wayf
+  +

+ + + + + + + + + +
Methods in edu.internet2.middleware.shibboleth.wayf that return PluginMetadataParameter
+protected  PluginMetadataParameterIdPSiteSet.paramFor(Plugin plugin) + +
+          Return the parameter that this plugin uses.
+  +

+ + + + + +
+Uses of PluginMetadataParameter in edu.internet2.middleware.shibboleth.wayf.plugins
+  +

+ + + + + + + + + +
Methods in edu.internet2.middleware.shibboleth.wayf.plugins that return PluginMetadataParameter
+ PluginMetadataParameterPlugin.refreshMetadata(org.opensaml.saml2.metadata.provider.MetadataProvider metadata) + +
+          Whenever the WAYF discoveres that the metadata is stale, it reloads it and calls each plugin at this method.
+  +

+ + + + + + + + + + + + + + + + + +
Methods in edu.internet2.middleware.shibboleth.wayf.plugins with parameters of type PluginMetadataParameter
+ PluginContextPlugin.lookup(javax.servlet.http.HttpServletRequest req, + javax.servlet.http.HttpServletResponse res, + PluginMetadataParameter parameter, + Map<String,IdPSite> validIdps, + PluginContext context, + List<IdPSite> idpList) + +
+          The WAYF calls each plugin at this entry point when it is first contacted.
+ PluginContextPlugin.search(javax.servlet.http.HttpServletRequest req, + javax.servlet.http.HttpServletResponse res, + PluginMetadataParameter parameter, + String pattern, + Map<String,IdPSite> validIdps, + PluginContext context, + Collection<IdPSite> searchResult, + List<IdPSite> idpList) + +
+          This method is called when the user specified a search operation.
+ voidPlugin.selected(javax.servlet.http.HttpServletRequest req, + javax.servlet.http.HttpServletResponse res, + PluginMetadataParameter parameter, + String idP) + +
+          This method is called, for every plugin, after a user has selected an IdP.
+  +

+ + + + + +
+Uses of PluginMetadataParameter in edu.internet2.middleware.shibboleth.wayf.plugins.provider
+  +

+ + + + + + + + + +
Methods in edu.internet2.middleware.shibboleth.wayf.plugins.provider that return PluginMetadataParameter
+ PluginMetadataParameterSamlCookiePlugin.refreshMetadata(org.opensaml.saml2.metadata.provider.MetadataProvider metadata) + +
+          Plugin point which is called when the data is refreshed.
+  +

+ + + + + + + + + + + + + + + + + +
Methods in edu.internet2.middleware.shibboleth.wayf.plugins.provider with parameters of type PluginMetadataParameter
+ PluginContextSamlCookiePlugin.lookup(javax.servlet.http.HttpServletRequest req, + javax.servlet.http.HttpServletResponse res, + PluginMetadataParameter parameter, + Map<String,IdPSite> validIdps, + PluginContext context, + List<IdPSite> idpList) + +
+          This is the 'hook' in the lookup part of Discovery Service processing.
+ PluginContextSamlCookiePlugin.search(javax.servlet.http.HttpServletRequest req, + javax.servlet.http.HttpServletResponse res, + PluginMetadataParameter parameter, + String pattern, + Map<String,IdPSite> validIdps, + PluginContext context, + Collection<IdPSite> searchResult, + List<IdPSite> idpList) + +
+          Plgin point for searching.
+ voidSamlCookiePlugin.selected(javax.servlet.http.HttpServletRequest req, + javax.servlet.http.HttpServletResponse res, + PluginMetadataParameter parameter, + String idP) + +
+          Plugin point for selection.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2006-2009 Internet2. All Rights Reserved. + + diff --git a/doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/class-use/WayfRequestHandled.html b/doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/class-use/WayfRequestHandled.html new file mode 100644 index 0000000..6a1ead5 --- /dev/null +++ b/doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/class-use/WayfRequestHandled.html @@ -0,0 +1,257 @@ + + + + + + + +Uses of Class edu.internet2.middleware.shibboleth.wayf.plugins.WayfRequestHandled (Shibboleth Discovery Service 1.1.0 Java API.) + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
edu.internet2.middleware.shibboleth.wayf.plugins.WayfRequestHandled

+
+ + + + + + + + + + + + + +
+Packages that use WayfRequestHandled
edu.internet2.middleware.shibboleth.wayf.plugins  
edu.internet2.middleware.shibboleth.wayf.plugins.provider  
+  +

+ + + + + +
+Uses of WayfRequestHandled in edu.internet2.middleware.shibboleth.wayf.plugins
+  +

+ + + + + + + + + + + + + + + + + +
Methods in edu.internet2.middleware.shibboleth.wayf.plugins that throw WayfRequestHandled
+ PluginContextPlugin.lookup(javax.servlet.http.HttpServletRequest req, + javax.servlet.http.HttpServletResponse res, + PluginMetadataParameter parameter, + Map<String,IdPSite> validIdps, + PluginContext context, + List<IdPSite> idpList) + +
+          The WAYF calls each plugin at this entry point when it is first contacted.
+ PluginContextPlugin.search(javax.servlet.http.HttpServletRequest req, + javax.servlet.http.HttpServletResponse res, + PluginMetadataParameter parameter, + String pattern, + Map<String,IdPSite> validIdps, + PluginContext context, + Collection<IdPSite> searchResult, + List<IdPSite> idpList) + +
+          This method is called when the user specified a search operation.
+ voidPlugin.selected(javax.servlet.http.HttpServletRequest req, + javax.servlet.http.HttpServletResponse res, + PluginMetadataParameter parameter, + String idP) + +
+          This method is called, for every plugin, after a user has selected an IdP.
+  +

+ + + + + +
+Uses of WayfRequestHandled in edu.internet2.middleware.shibboleth.wayf.plugins.provider
+  +

+ + + + + + + + + + + + + +
Methods in edu.internet2.middleware.shibboleth.wayf.plugins.provider that throw WayfRequestHandled
+ PluginContextSamlCookiePlugin.lookup(javax.servlet.http.HttpServletRequest req, + javax.servlet.http.HttpServletResponse res, + PluginMetadataParameter parameter, + Map<String,IdPSite> validIdps, + PluginContext context, + List<IdPSite> idpList) + +
+          This is the 'hook' in the lookup part of Discovery Service processing.
+ PluginContextSamlCookiePlugin.search(javax.servlet.http.HttpServletRequest req, + javax.servlet.http.HttpServletResponse res, + PluginMetadataParameter parameter, + String pattern, + Map<String,IdPSite> validIdps, + PluginContext context, + Collection<IdPSite> searchResult, + List<IdPSite> idpList) + +
+          Plgin point for searching.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2006-2009 Internet2. All Rights Reserved. + + diff --git a/doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/package-frame.html b/doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/package-frame.html new file mode 100644 index 0000000..55f1ae3 --- /dev/null +++ b/doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/package-frame.html @@ -0,0 +1,48 @@ + + + + + + + +edu.internet2.middleware.shibboleth.wayf.plugins (Shibboleth Discovery Service 1.1.0 Java API.) + + + + + + + + + + + +edu.internet2.middleware.shibboleth.wayf.plugins + + + + +
+Interfaces  + +
+Plugin +
+PluginContext +
+PluginMetadataParameter
+ + + + + + +
+Exceptions  + +
+WayfRequestHandled
+ + + + diff --git a/doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/package-summary.html b/doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/package-summary.html new file mode 100644 index 0000000..cf48e7e --- /dev/null +++ b/doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/package-summary.html @@ -0,0 +1,179 @@ + + + + + + + +edu.internet2.middleware.shibboleth.wayf.plugins (Shibboleth Discovery Service 1.1.0 Java API.) + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package edu.internet2.middleware.shibboleth.wayf.plugins +

+ + + + + + + + + + + + + + + + + +
+Interface Summary
PluginThe Plugin interface is used to affect the 'hints' that the WAYF offers to the users.
PluginContextThis is a marker interface.
PluginMetadataParameterThe PluginParameter is a marker interface which a WAYF Plugin can use to associate extra information + with the metadata.
+  + +

+ + + + + + + + + +
+Exception Summary
WayfRequestHandledThis Exception can be signalled by a plugin to indicate to the WAYF that it has handled the + request and all processing should stop.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2006-2009 Internet2. All Rights Reserved. + + diff --git a/doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/package-tree.html b/doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/package-tree.html new file mode 100644 index 0000000..e0e8975 --- /dev/null +++ b/doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/package-tree.html @@ -0,0 +1,160 @@ + + + + + + + +edu.internet2.middleware.shibboleth.wayf.plugins Class Hierarchy (Shibboleth Discovery Service 1.1.0 Java API.) + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package edu.internet2.middleware.shibboleth.wayf.plugins +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2006-2009 Internet2. All Rights Reserved. + + diff --git a/doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/package-use.html b/doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/package-use.html new file mode 100644 index 0000000..1c5f99d --- /dev/null +++ b/doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/package-use.html @@ -0,0 +1,246 @@ + + + + + + + +Uses of Package edu.internet2.middleware.shibboleth.wayf.plugins (Shibboleth Discovery Service 1.1.0 Java API.) + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
edu.internet2.middleware.shibboleth.wayf.plugins

+
+ + + + + + + + + + + + + + + + + +
+Packages that use edu.internet2.middleware.shibboleth.wayf.plugins
edu.internet2.middleware.shibboleth.wayf  
edu.internet2.middleware.shibboleth.wayf.plugins  
edu.internet2.middleware.shibboleth.wayf.plugins.provider  
+  +

+ + + + + + + + + + + +
+Classes in edu.internet2.middleware.shibboleth.wayf.plugins used by edu.internet2.middleware.shibboleth.wayf
Plugin + +
+          The Plugin interface is used to affect the 'hints' that the WAYF offers to the users.
PluginMetadataParameter + +
+          The PluginParameter is a marker interface which a WAYF Plugin can use to associate extra information + with the metadata.
+  +

+ + + + + + + + + + + + + + +
+Classes in edu.internet2.middleware.shibboleth.wayf.plugins used by edu.internet2.middleware.shibboleth.wayf.plugins
PluginContext + +
+          This is a marker interface.
PluginMetadataParameter + +
+          The PluginParameter is a marker interface which a WAYF Plugin can use to associate extra information + with the metadata.
WayfRequestHandled + +
+          This Exception can be signalled by a plugin to indicate to the WAYF that it has handled the + request and all processing should stop.
+  +

+ + + + + + + + + + + + + + + + + +
+Classes in edu.internet2.middleware.shibboleth.wayf.plugins used by edu.internet2.middleware.shibboleth.wayf.plugins.provider
Plugin + +
+          The Plugin interface is used to affect the 'hints' that the WAYF offers to the users.
PluginContext + +
+          This is a marker interface.
PluginMetadataParameter + +
+          The PluginParameter is a marker interface which a WAYF Plugin can use to associate extra information + with the metadata.
WayfRequestHandled + +
+          This Exception can be signalled by a plugin to indicate to the WAYF that it has handled the + request and all processing should stop.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2006-2009 Internet2. All Rights Reserved. + + diff --git a/doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/provider/BindingFilter.html b/doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/provider/BindingFilter.html new file mode 100644 index 0000000..eb3219d --- /dev/null +++ b/doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/provider/BindingFilter.html @@ -0,0 +1,270 @@ + + + + + + + +BindingFilter (Shibboleth Discovery Service 1.1.0 Java API.) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +edu.internet2.middleware.shibboleth.wayf.plugins.provider +
+Class BindingFilter

+
+java.lang.Object
+  extended by edu.internet2.middleware.shibboleth.wayf.plugins.provider.BindingFilter
+
+
+
All Implemented Interfaces:
org.opensaml.saml2.metadata.provider.MetadataFilter
+
+
+
+
public class BindingFilter
extends Object
implements org.opensaml.saml2.metadata.provider.MetadataFilter
+ + +

+See SDSJ-48. If we get a DS endpoint then we need to check that the binding is provided + and that it is correct. +

+ +

+

+ +

+ + + + + + + + + + + +
+Constructor Summary
BindingFilter(boolean warn) + +
+          Initialize the filter.
+  + + + + + + + + + + + +
+Method Summary
+ voiddoFilter(org.opensaml.xml.XMLObject metadata) + +
+          Apply the filter.
+  + + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+BindingFilter

+
+public BindingFilter(boolean warn)
+
+
Initialize the filter. +

+

+
Parameters:
warn - do we warn or do we fail if we see badness?
+
+ + + + + + + + +
+Method Detail
+ +

+doFilter

+
+public void doFilter(org.opensaml.xml.XMLObject metadata)
+              throws org.opensaml.saml2.metadata.provider.FilterException
+
+
Apply the filter. +

+

+
Specified by:
doFilter in interface org.opensaml.saml2.metadata.provider.MetadataFilter
+
+
+
Parameters:
metadata - what to filter. +
Throws: +
org.opensaml.saml2.metadata.provider.FilterException - if it sees any missed or bad bindings.
See Also:
MetadataFilter.doFilter(org.opensaml.xml.XMLObject)
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2006-2009 Internet2. All Rights Reserved. + + diff --git a/doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/provider/ListFilter.html b/doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/provider/ListFilter.html new file mode 100644 index 0000000..4fbc41a --- /dev/null +++ b/doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/provider/ListFilter.html @@ -0,0 +1,278 @@ + + + + + + + +ListFilter (Shibboleth Discovery Service 1.1.0 Java API.) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +edu.internet2.middleware.shibboleth.wayf.plugins.provider +
+Class ListFilter

+
+java.lang.Object
+  extended by edu.internet2.middleware.shibboleth.wayf.plugins.provider.ListFilter
+
+
+
All Implemented Interfaces:
org.opensaml.saml2.metadata.provider.MetadataFilter
+
+
+
+
public class ListFilter
extends Object
implements org.opensaml.saml2.metadata.provider.MetadataFilter
+ + +

+See SDSJ-57. Explicit +

+ +

+

+ +

+ + + + + + + + + + + +
+Constructor Summary
ListFilter(Element config) + +
+          Initialize the filter.
+  + + + + + + + + + + + +
+Method Summary
+ voiddoFilter(org.opensaml.xml.XMLObject metadata) + +
+          Apply the filter.
+  + + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+ListFilter

+
+public ListFilter(Element config)
+
+
Initialize the filter. +

+

+
Parameters:
config - the configuration + + The configuration looks liken this + + foo + [...] + +
+
+ + + + + + + + +
+Method Detail
+ +

+doFilter

+
+public void doFilter(org.opensaml.xml.XMLObject metadata)
+              throws org.opensaml.saml2.metadata.provider.FilterException
+
+
Apply the filter. +

+

+
Specified by:
doFilter in interface org.opensaml.saml2.metadata.provider.MetadataFilter
+
+
+
Parameters:
metadata - what to filter. +
Throws: +
org.opensaml.saml2.metadata.provider.FilterException - if it sees any missed or bad bindings.
See Also:
MetadataFilter.doFilter(org.opensaml.xml.XMLObject)
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2006-2009 Internet2. All Rights Reserved. + + diff --git a/doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/provider/SamlCookiePlugin.SamlIdPCookie.html b/doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/provider/SamlCookiePlugin.SamlIdPCookie.html new file mode 100644 index 0000000..7122956 --- /dev/null +++ b/doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/provider/SamlCookiePlugin.SamlIdPCookie.html @@ -0,0 +1,250 @@ + + + + + + + +SamlCookiePlugin.SamlIdPCookie (Shibboleth Discovery Service 1.1.0 Java API.) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +edu.internet2.middleware.shibboleth.wayf.plugins.provider +
+Class SamlCookiePlugin.SamlIdPCookie

+
+java.lang.Object
+  extended by edu.internet2.middleware.shibboleth.wayf.plugins.provider.SamlCookiePlugin.SamlIdPCookie
+
+
+
Enclosing class:
SamlCookiePlugin
+
+
+
+
public final class SamlCookiePlugin.SamlIdPCookie
extends Object
+ + +

+Class to abstract away the saml cookie for us. +

+ +

+

+ +

+ + + + + + + + + + + + + + + + +
+Method Summary
+ voiddeleteIdPName(String origin, + int expiration) + +
+          Remove origin from the cachedata and write it back.
+ List<String>getIdPList() + +
+          Return the list of Idps for this cookie.
+  + + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Method Detail
+ +

+deleteIdPName

+
+public void deleteIdPName(String origin,
+                          int expiration)
+
+
Remove origin from the cachedata and write it back. +

+

+
Parameters:
origin - what to remove.
expiration - How long it will live.
+
+
+
+ +

+getIdPList

+
+public List<String> getIdPList()
+
+
Return the list of Idps for this cookie. +

+

+ +
Returns:
The list.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2006-2009 Internet2. All Rights Reserved. + + diff --git a/doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/provider/SamlCookiePlugin.html b/doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/provider/SamlCookiePlugin.html new file mode 100644 index 0000000..2cdafbd --- /dev/null +++ b/doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/provider/SamlCookiePlugin.html @@ -0,0 +1,408 @@ + + + + + + + +SamlCookiePlugin (Shibboleth Discovery Service 1.1.0 Java API.) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +edu.internet2.middleware.shibboleth.wayf.plugins.provider +
+Class SamlCookiePlugin

+
+java.lang.Object
+  extended by edu.internet2.middleware.shibboleth.wayf.plugins.provider.SamlCookiePlugin
+
+
+
All Implemented Interfaces:
Plugin
+
+
+
+
public class SamlCookiePlugin
extends Object
implements Plugin
+ + +

+This is a test implementation of the saml cookie lookup stuff to + see whether it fits the plugin architecture. +

+ +

+

+ +

+ + + + + + + + + + + +
+Nested Class Summary
+ classSamlCookiePlugin.SamlIdPCookie + +
+          Class to abstract away the saml cookie for us.
+  + + + + + + + + + + +
+Constructor Summary
SamlCookiePlugin(Element element) + +
+          This constructor is called during wayf initialization with it's + own little bit of XML config.
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ PluginContextlookup(javax.servlet.http.HttpServletRequest req, + javax.servlet.http.HttpServletResponse res, + PluginMetadataParameter parameter, + Map<String,IdPSite> validIdps, + PluginContext context, + List<IdPSite> idpList) + +
+          This is the 'hook' in the lookup part of Discovery Service processing.
+ PluginMetadataParameterrefreshMetadata(org.opensaml.saml2.metadata.provider.MetadataProvider metadata) + +
+          Plugin point which is called when the data is refreshed.
+ PluginContextsearch(javax.servlet.http.HttpServletRequest req, + javax.servlet.http.HttpServletResponse res, + PluginMetadataParameter parameter, + String pattern, + Map<String,IdPSite> validIdps, + PluginContext context, + Collection<IdPSite> searchResult, + List<IdPSite> idpList) + +
+          Plgin point for searching.
+ voidselected(javax.servlet.http.HttpServletRequest req, + javax.servlet.http.HttpServletResponse res, + PluginMetadataParameter parameter, + String idP) + +
+          Plugin point for selection.
+  + + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+SamlCookiePlugin

+
+public SamlCookiePlugin(Element element)
+
+
This constructor is called during wayf initialization with it's + own little bit of XML config. +

+

+
Parameters:
element - - further information to be gleaned from the DOM.
+
+ + + + + + + + +
+Method Detail
+ +

+lookup

+
+public PluginContext lookup(javax.servlet.http.HttpServletRequest req,
+                            javax.servlet.http.HttpServletResponse res,
+                            PluginMetadataParameter parameter,
+                            Map<String,IdPSite> validIdps,
+                            PluginContext context,
+                            List<IdPSite> idpList)
+                     throws WayfRequestHandled
+
+
This is the 'hook' in the lookup part of Discovery Service processing. +

+

+
Specified by:
lookup in interface Plugin
+
+
+
Parameters:
req - - Describes the current request. Used to find any appropriate cookies
res - - Describes the current response. Used to redirect the request.
parameter - - Describes the metadata.
context - - 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.
validIdps - 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
idpList - The set of Idps which are currently considered as potential hints. +
Returns:
a context to hand to subsequent calls +
Throws: +
WayfRequestHandled - if the plugin has handled the request. + issues a redirect)
See Also:
Plugin.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)
+
+
+
+ +

+refreshMetadata

+
+public PluginMetadataParameter refreshMetadata(org.opensaml.saml2.metadata.provider.MetadataProvider metadata)
+
+
Plugin point which is called when the data is refreshed. +

+

+
Specified by:
refreshMetadata in interface Plugin
+
+
+
Parameters:
metadata - - where to get the data from. +
Returns:
the value which will be provided as input to subsequent calls
See Also:
Plugin.refreshMetadata(org.opensaml.saml2.metadata.provider.MetadataProvider)
+
+
+
+ +

+search

+
+public PluginContext search(javax.servlet.http.HttpServletRequest req,
+                            javax.servlet.http.HttpServletResponse res,
+                            PluginMetadataParameter parameter,
+                            String pattern,
+                            Map<String,IdPSite> validIdps,
+                            PluginContext context,
+                            Collection<IdPSite> searchResult,
+                            List<IdPSite> idpList)
+                     throws WayfRequestHandled
+
+
Plgin point for searching. +

+

+
Specified by:
search in interface Plugin
+
+
+
Parameters:
req - Describes the current request.
res - Describes the current response.
parameter - Describes the metadata.
pattern - What we are searchign for.
validIdps - 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
context - 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.
searchResult - What the search yielded.
idpList - The set of Idps which are currently considered as potential hints. +
Returns:
a context to hand to subsequent calls. +
Throws: +
WayfRequestHandled +
WayfRequestHandled - if the plugin has handled the request.
See Also:
Plugin.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)
+
+
+
+ +

+selected

+
+public void selected(javax.servlet.http.HttpServletRequest req,
+                     javax.servlet.http.HttpServletResponse res,
+                     PluginMetadataParameter parameter,
+                     String idP)
+
+
Plugin point for selection. +

+

+
Specified by:
selected in interface Plugin
+
+
+
Parameters:
req - Describes the current request.
res - Describes the current response.
parameter - Describes the metadata.
idP - Describes the idp.
See Also:
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)
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Copyright © 2006-2009 Internet2. All Rights Reserved. + + diff --git a/doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/provider/class-use/BindingFilter.html b/doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/provider/class-use/BindingFilter.html new file mode 100644 index 0000000..399a773 --- /dev/null +++ b/doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/provider/class-use/BindingFilter.html @@ -0,0 +1,141 @@ + + + + + + + +Uses of Class edu.internet2.middleware.shibboleth.wayf.plugins.provider.BindingFilter (Shibboleth Discovery Service 1.1.0 Java API.) + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
edu.internet2.middleware.shibboleth.wayf.plugins.provider.BindingFilter

+
+No usage of edu.internet2.middleware.shibboleth.wayf.plugins.provider.BindingFilter +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2006-2009 Internet2. All Rights Reserved. + + diff --git a/doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/provider/class-use/ListFilter.html b/doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/provider/class-use/ListFilter.html new file mode 100644 index 0000000..4ed8d51 --- /dev/null +++ b/doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/provider/class-use/ListFilter.html @@ -0,0 +1,141 @@ + + + + + + + +Uses of Class edu.internet2.middleware.shibboleth.wayf.plugins.provider.ListFilter (Shibboleth Discovery Service 1.1.0 Java API.) + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
edu.internet2.middleware.shibboleth.wayf.plugins.provider.ListFilter

+
+No usage of edu.internet2.middleware.shibboleth.wayf.plugins.provider.ListFilter +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2006-2009 Internet2. All Rights Reserved. + + diff --git a/doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/provider/class-use/SamlCookiePlugin.SamlIdPCookie.html b/doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/provider/class-use/SamlCookiePlugin.SamlIdPCookie.html new file mode 100644 index 0000000..7b8076d --- /dev/null +++ b/doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/provider/class-use/SamlCookiePlugin.SamlIdPCookie.html @@ -0,0 +1,141 @@ + + + + + + + +Uses of Class edu.internet2.middleware.shibboleth.wayf.plugins.provider.SamlCookiePlugin.SamlIdPCookie (Shibboleth Discovery Service 1.1.0 Java API.) + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
edu.internet2.middleware.shibboleth.wayf.plugins.provider.SamlCookiePlugin.SamlIdPCookie

+
+No usage of edu.internet2.middleware.shibboleth.wayf.plugins.provider.SamlCookiePlugin.SamlIdPCookie +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2006-2009 Internet2. All Rights Reserved. + + diff --git a/doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/provider/class-use/SamlCookiePlugin.html b/doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/provider/class-use/SamlCookiePlugin.html new file mode 100644 index 0000000..33bfcfc --- /dev/null +++ b/doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/provider/class-use/SamlCookiePlugin.html @@ -0,0 +1,141 @@ + + + + + + + +Uses of Class edu.internet2.middleware.shibboleth.wayf.plugins.provider.SamlCookiePlugin (Shibboleth Discovery Service 1.1.0 Java API.) + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Class
edu.internet2.middleware.shibboleth.wayf.plugins.provider.SamlCookiePlugin

+
+No usage of edu.internet2.middleware.shibboleth.wayf.plugins.provider.SamlCookiePlugin +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2006-2009 Internet2. All Rights Reserved. + + diff --git a/doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/provider/package-frame.html b/doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/provider/package-frame.html new file mode 100644 index 0000000..64d2e79 --- /dev/null +++ b/doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/provider/package-frame.html @@ -0,0 +1,37 @@ + + + + + + + +edu.internet2.middleware.shibboleth.wayf.plugins.provider (Shibboleth Discovery Service 1.1.0 Java API.) + + + + + + + + + + + +edu.internet2.middleware.shibboleth.wayf.plugins.provider + + + + +
+Classes  + +
+BindingFilter +
+ListFilter +
+SamlCookiePlugin
+ + + + diff --git a/doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/provider/package-summary.html b/doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/provider/package-summary.html new file mode 100644 index 0000000..088f8a1 --- /dev/null +++ b/doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/provider/package-summary.html @@ -0,0 +1,164 @@ + + + + + + + +edu.internet2.middleware.shibboleth.wayf.plugins.provider (Shibboleth Discovery Service 1.1.0 Java API.) + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package edu.internet2.middleware.shibboleth.wayf.plugins.provider +

+ + + + + + + + + + + + + + + + + +
+Class Summary
BindingFilterSee SDSJ-48.
ListFilterSee SDSJ-57.
SamlCookiePluginThis is a test implementation of the saml cookie lookup stuff to + see whether it fits the plugin architecture.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2006-2009 Internet2. All Rights Reserved. + + diff --git a/doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/provider/package-tree.html b/doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/provider/package-tree.html new file mode 100644 index 0000000..c0b38e7 --- /dev/null +++ b/doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/provider/package-tree.html @@ -0,0 +1,153 @@ + + + + + + + +edu.internet2.middleware.shibboleth.wayf.plugins.provider Class Hierarchy (Shibboleth Discovery Service 1.1.0 Java API.) + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package edu.internet2.middleware.shibboleth.wayf.plugins.provider +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2006-2009 Internet2. All Rights Reserved. + + diff --git a/doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/provider/package-use.html b/doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/provider/package-use.html new file mode 100644 index 0000000..2e426c4 --- /dev/null +++ b/doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/provider/package-use.html @@ -0,0 +1,141 @@ + + + + + + + +Uses of Package edu.internet2.middleware.shibboleth.wayf.plugins.provider (Shibboleth Discovery Service 1.1.0 Java API.) + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
edu.internet2.middleware.shibboleth.wayf.plugins.provider

+
+No usage of edu.internet2.middleware.shibboleth.wayf.plugins.provider +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Copyright © 2006-2009 Internet2. All Rights Reserved. + + -- cgit v1.1