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 +++++++++++++++++++++ 1 file changed, 381 insertions(+) create mode 100644 doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/Plugin.html (limited to 'doc/api/edu/internet2/middleware/shibboleth/wayf/plugins/Plugin.html') 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. + + -- cgit v1.1