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 --- .../common/ShibbolethConfigurationException.html | 267 +++++++++++ .../ShibbolethConfigurationException.html | 193 ++++++++ .../shibboleth/common/package-frame.html | 33 ++ .../shibboleth/common/package-summary.html | 155 +++++++ .../middleware/shibboleth/common/package-tree.html | 155 +++++++ .../middleware/shibboleth/common/package-use.html | 167 +++++++ .../shibboleth/wayf/DiscoveryResponseBuilder.html | 312 +++++++++++++ .../shibboleth/wayf/DiscoveryResponseImpl.html | 420 +++++++++++++++++ .../wayf/DiscoveryResponseUnmarshaller.html | 298 ++++++++++++ .../shibboleth/wayf/DiscoveryServiceHandler.html | 343 ++++++++++++++ .../middleware/shibboleth/wayf/HandlerConfig.html | 414 +++++++++++++++++ .../shibboleth/wayf/IdPSite.Compare.html | 270 +++++++++++ .../middleware/shibboleth/wayf/IdPSite.html | 396 ++++++++++++++++ .../middleware/shibboleth/wayf/IdPSiteSet.html | 514 +++++++++++++++++++++ .../shibboleth/wayf/IdPSiteSetEntry.html | 286 ++++++++++++ .../wayf/LogbackConfigurationChangeListener.html | 353 ++++++++++++++ .../shibboleth/wayf/LogbackLoggingService.html | 232 ++++++++++ .../middleware/shibboleth/wayf/Version.html | 256 ++++++++++ .../middleware/shibboleth/wayf/WayfException.html | 266 +++++++++++ .../middleware/shibboleth/wayf/WayfService.html | 316 +++++++++++++ .../middleware/shibboleth/wayf/XMLConstants.html | 304 ++++++++++++ .../wayf/class-use/DiscoveryResponseBuilder.html | 141 ++++++ .../wayf/class-use/DiscoveryResponseImpl.html | 187 ++++++++ .../class-use/DiscoveryResponseUnmarshaller.html | 141 ++++++ .../wayf/class-use/DiscoveryServiceHandler.html | 141 ++++++ .../shibboleth/wayf/class-use/HandlerConfig.html | 203 ++++++++ .../shibboleth/wayf/class-use/IdPSite.Compare.html | 141 ++++++ .../shibboleth/wayf/class-use/IdPSite.html | 447 ++++++++++++++++++ .../shibboleth/wayf/class-use/IdPSiteSet.html | 193 ++++++++ .../shibboleth/wayf/class-use/IdPSiteSetEntry.html | 141 ++++++ .../LogbackConfigurationChangeListener.html | 141 ++++++ .../wayf/class-use/LogbackLoggingService.html | 141 ++++++ .../shibboleth/wayf/class-use/Version.html | 141 ++++++ .../shibboleth/wayf/class-use/WayfException.html | 195 ++++++++ .../shibboleth/wayf/class-use/WayfService.html | 141 ++++++ .../shibboleth/wayf/class-use/XMLConstants.html | 141 ++++++ .../middleware/shibboleth/wayf/package-frame.html | 70 +++ .../shibboleth/wayf/package-summary.html | 223 +++++++++ .../middleware/shibboleth/wayf/package-tree.html | 194 ++++++++ .../middleware/shibboleth/wayf/package-use.html | 230 +++++++++ .../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 ++++++ 64 files changed, 14316 insertions(+) create mode 100644 doc/api/edu/internet2/middleware/shibboleth/common/ShibbolethConfigurationException.html create mode 100644 doc/api/edu/internet2/middleware/shibboleth/common/class-use/ShibbolethConfigurationException.html create mode 100644 doc/api/edu/internet2/middleware/shibboleth/common/package-frame.html create mode 100644 doc/api/edu/internet2/middleware/shibboleth/common/package-summary.html create mode 100644 doc/api/edu/internet2/middleware/shibboleth/common/package-tree.html create mode 100644 doc/api/edu/internet2/middleware/shibboleth/common/package-use.html create mode 100644 doc/api/edu/internet2/middleware/shibboleth/wayf/DiscoveryResponseBuilder.html create mode 100644 doc/api/edu/internet2/middleware/shibboleth/wayf/DiscoveryResponseImpl.html create mode 100644 doc/api/edu/internet2/middleware/shibboleth/wayf/DiscoveryResponseUnmarshaller.html create mode 100644 doc/api/edu/internet2/middleware/shibboleth/wayf/DiscoveryServiceHandler.html create mode 100644 doc/api/edu/internet2/middleware/shibboleth/wayf/HandlerConfig.html create mode 100644 doc/api/edu/internet2/middleware/shibboleth/wayf/IdPSite.Compare.html create mode 100644 doc/api/edu/internet2/middleware/shibboleth/wayf/IdPSite.html create mode 100644 doc/api/edu/internet2/middleware/shibboleth/wayf/IdPSiteSet.html create mode 100644 doc/api/edu/internet2/middleware/shibboleth/wayf/IdPSiteSetEntry.html create mode 100644 doc/api/edu/internet2/middleware/shibboleth/wayf/LogbackConfigurationChangeListener.html create mode 100644 doc/api/edu/internet2/middleware/shibboleth/wayf/LogbackLoggingService.html create mode 100644 doc/api/edu/internet2/middleware/shibboleth/wayf/Version.html create mode 100644 doc/api/edu/internet2/middleware/shibboleth/wayf/WayfException.html create mode 100644 doc/api/edu/internet2/middleware/shibboleth/wayf/WayfService.html create mode 100644 doc/api/edu/internet2/middleware/shibboleth/wayf/XMLConstants.html create mode 100644 doc/api/edu/internet2/middleware/shibboleth/wayf/class-use/DiscoveryResponseBuilder.html create mode 100644 doc/api/edu/internet2/middleware/shibboleth/wayf/class-use/DiscoveryResponseImpl.html create mode 100644 doc/api/edu/internet2/middleware/shibboleth/wayf/class-use/DiscoveryResponseUnmarshaller.html create mode 100644 doc/api/edu/internet2/middleware/shibboleth/wayf/class-use/DiscoveryServiceHandler.html create mode 100644 doc/api/edu/internet2/middleware/shibboleth/wayf/class-use/HandlerConfig.html create mode 100644 doc/api/edu/internet2/middleware/shibboleth/wayf/class-use/IdPSite.Compare.html create mode 100644 doc/api/edu/internet2/middleware/shibboleth/wayf/class-use/IdPSite.html create mode 100644 doc/api/edu/internet2/middleware/shibboleth/wayf/class-use/IdPSiteSet.html create mode 100644 doc/api/edu/internet2/middleware/shibboleth/wayf/class-use/IdPSiteSetEntry.html create mode 100644 doc/api/edu/internet2/middleware/shibboleth/wayf/class-use/LogbackConfigurationChangeListener.html create mode 100644 doc/api/edu/internet2/middleware/shibboleth/wayf/class-use/LogbackLoggingService.html create mode 100644 doc/api/edu/internet2/middleware/shibboleth/wayf/class-use/Version.html create mode 100644 doc/api/edu/internet2/middleware/shibboleth/wayf/class-use/WayfException.html create mode 100644 doc/api/edu/internet2/middleware/shibboleth/wayf/class-use/WayfService.html create mode 100644 doc/api/edu/internet2/middleware/shibboleth/wayf/class-use/XMLConstants.html create mode 100644 doc/api/edu/internet2/middleware/shibboleth/wayf/package-frame.html create mode 100644 doc/api/edu/internet2/middleware/shibboleth/wayf/package-summary.html create mode 100644 doc/api/edu/internet2/middleware/shibboleth/wayf/package-tree.html create mode 100644 doc/api/edu/internet2/middleware/shibboleth/wayf/package-use.html 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') diff --git a/doc/api/edu/internet2/middleware/shibboleth/common/ShibbolethConfigurationException.html b/doc/api/edu/internet2/middleware/shibboleth/common/ShibbolethConfigurationException.html new file mode 100644 index 0000000..ece2906 --- /dev/null +++ b/doc/api/edu/internet2/middleware/shibboleth/common/ShibbolethConfigurationException.html @@ -0,0 +1,267 @@ + + + + + + + +ShibbolethConfigurationException (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.common +
+Class ShibbolethConfigurationException

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

+Signals that the a Shibboleth component has been given insufficient or improper runtime configuration paramerts. +

+ +

+

+
See Also:
Serialized Form
+
+ +

+ + + + + + + + + + + + + + +
+Constructor Summary
ShibbolethConfigurationException(String message) + +
+          Build an object embedding a String message.
ShibbolethConfigurationException(String message, + Throwable t) + +
+          Build an object which embeds an message an exception.
+  + + + + + + + +
+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
+ +

+ShibbolethConfigurationException

+
+public ShibbolethConfigurationException(String message)
+
+
Build an object embedding a String message. Normally called for detected errors. +

+

+
Parameters:
message - - Text (in US English) describing the reason for raising the exception.
+
+
+ +

+ShibbolethConfigurationException

+
+public ShibbolethConfigurationException(String message,
+                                        Throwable t)
+
+
Build an object which embeds an message an exception. + Normally called to pass on errors found at a lower level. +

+

+
Parameters:
message - - Text (in US English) describing the reasdon for raising the exception.
t - - Cause for the failure as returned by the lower level component.
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
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/common/class-use/ShibbolethConfigurationException.html b/doc/api/edu/internet2/middleware/shibboleth/common/class-use/ShibbolethConfigurationException.html new file mode 100644 index 0000000..21ada9d --- /dev/null +++ b/doc/api/edu/internet2/middleware/shibboleth/common/class-use/ShibbolethConfigurationException.html @@ -0,0 +1,193 @@ + + + + + + + +Uses of Class edu.internet2.middleware.shibboleth.common.ShibbolethConfigurationException (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.common.ShibbolethConfigurationException

+
+ + + + + + + + + +
+Packages that use ShibbolethConfigurationException
edu.internet2.middleware.shibboleth.wayf  
+  +

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

+ + + + + + + + + + + + + + +
Constructors in edu.internet2.middleware.shibboleth.wayf that throw ShibbolethConfigurationException
DiscoveryServiceHandler(Element config, + Hashtable<String,IdPSiteSet> federations, + Hashtable<String,Plugin> plugins, + HandlerConfig defaultConfig) + +
+          Constructor to create and configure the handler.
HandlerConfig(Element config, + HandlerConfig defaultValue) + +
+          Parse the Supplied XML element into a new WayfConfig Object.
IdPSiteSet(Element el, + org.opensaml.xml.parse.ParserPool parserPool, + boolean warnOnBadBinding) + +
+          Create a new IdPSiteSet as described by the supplied XML segment.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
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/common/package-frame.html b/doc/api/edu/internet2/middleware/shibboleth/common/package-frame.html new file mode 100644 index 0000000..90af46b --- /dev/null +++ b/doc/api/edu/internet2/middleware/shibboleth/common/package-frame.html @@ -0,0 +1,33 @@ + + + + + + + +edu.internet2.middleware.shibboleth.common (Shibboleth Discovery Service 1.1.0 Java API.) + + + + + + + + + + + +edu.internet2.middleware.shibboleth.common + + + + +
+Exceptions  + +
+ShibbolethConfigurationException
+ + + + diff --git a/doc/api/edu/internet2/middleware/shibboleth/common/package-summary.html b/doc/api/edu/internet2/middleware/shibboleth/common/package-summary.html new file mode 100644 index 0000000..731ed08 --- /dev/null +++ b/doc/api/edu/internet2/middleware/shibboleth/common/package-summary.html @@ -0,0 +1,155 @@ + + + + + + + +edu.internet2.middleware.shibboleth.common (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.common +

+ + + + + + + + + +
+Exception Summary
ShibbolethConfigurationExceptionSignals that the a Shibboleth component has been given insufficient or improper runtime configuration paramerts.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
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/common/package-tree.html b/doc/api/edu/internet2/middleware/shibboleth/common/package-tree.html new file mode 100644 index 0000000..feeac93 --- /dev/null +++ b/doc/api/edu/internet2/middleware/shibboleth/common/package-tree.html @@ -0,0 +1,155 @@ + + + + + + + +edu.internet2.middleware.shibboleth.common 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.common +

+
+
+
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/common/package-use.html b/doc/api/edu/internet2/middleware/shibboleth/common/package-use.html new file mode 100644 index 0000000..c8a0bd8 --- /dev/null +++ b/doc/api/edu/internet2/middleware/shibboleth/common/package-use.html @@ -0,0 +1,167 @@ + + + + + + + +Uses of Package edu.internet2.middleware.shibboleth.common (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.common

+
+ + + + + + + + + +
+Packages that use edu.internet2.middleware.shibboleth.common
edu.internet2.middleware.shibboleth.wayf  
+  +

+ + + + + + + + +
+Classes in edu.internet2.middleware.shibboleth.common used by edu.internet2.middleware.shibboleth.wayf
ShibbolethConfigurationException + +
+          Signals that the a Shibboleth component has been given insufficient or improper runtime configuration paramerts.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
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/DiscoveryResponseBuilder.html b/doc/api/edu/internet2/middleware/shibboleth/wayf/DiscoveryResponseBuilder.html new file mode 100644 index 0000000..933855a --- /dev/null +++ b/doc/api/edu/internet2/middleware/shibboleth/wayf/DiscoveryResponseBuilder.html @@ -0,0 +1,312 @@ + + + + + + + +DiscoveryResponseBuilder (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 +
+Class DiscoveryResponseBuilder

+
+java.lang.Object
+  extended by org.opensaml.xml.AbstractXMLObjectBuilder<SAMLObjectType>
+      extended by org.opensaml.common.impl.AbstractSAMLObjectBuilder<DiscoveryResponseImpl>
+          extended by edu.internet2.middleware.shibboleth.wayf.DiscoveryResponseBuilder
+
+
+
All Implemented Interfaces:
org.opensaml.common.SAMLObjectBuilder<DiscoveryResponseImpl>, org.opensaml.xml.XMLObjectBuilder<DiscoveryResponseImpl>
+
+
+
+
public class DiscoveryResponseBuilder
extends org.opensaml.common.impl.AbstractSAMLObjectBuilder<DiscoveryResponseImpl>
+ + +

+Builder of SingleLogoutServiceImpl. +

+ +

+

+ +

+ + + + + + + + + + + +
+Constructor Summary
DiscoveryResponseBuilder() + +
+          Constructor
+  + + + + + + + + + + + + + + + +
+Method Summary
+ DiscoveryResponseImplbuildObject() + +
+          
+ DiscoveryResponseImplbuildObject(String namespaceURI, + String localName, + String namespacePrefix) + +
+          
+  + + + + + + + +
Methods inherited from class org.opensaml.xml.AbstractXMLObjectBuilder
buildObject, buildObject, buildObject, buildObject
+  + + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  + + + + + + + +
Methods inherited from interface org.opensaml.xml.XMLObjectBuilder
buildObject, buildObject, buildObject, buildObject
+  +

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

+DiscoveryResponseBuilder

+
+public DiscoveryResponseBuilder()
+
+
Constructor +

+

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

+buildObject

+
+public DiscoveryResponseImpl buildObject()
+
+
+

+

+
Specified by:
buildObject in interface org.opensaml.common.SAMLObjectBuilder<DiscoveryResponseImpl>
Specified by:
buildObject in class org.opensaml.common.impl.AbstractSAMLObjectBuilder<DiscoveryResponseImpl>
+
+
+
+
+
+
+ +

+buildObject

+
+public DiscoveryResponseImpl buildObject(String namespaceURI,
+                                         String localName,
+                                         String namespacePrefix)
+
+
+

+

+
Specified by:
buildObject in interface org.opensaml.xml.XMLObjectBuilder<DiscoveryResponseImpl>
Specified by:
buildObject in class org.opensaml.xml.AbstractXMLObjectBuilder<DiscoveryResponseImpl>
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
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/DiscoveryResponseImpl.html b/doc/api/edu/internet2/middleware/shibboleth/wayf/DiscoveryResponseImpl.html new file mode 100644 index 0000000..85c047f --- /dev/null +++ b/doc/api/edu/internet2/middleware/shibboleth/wayf/DiscoveryResponseImpl.html @@ -0,0 +1,420 @@ + + + + + + + +DiscoveryResponseImpl (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 +
+Class DiscoveryResponseImpl

+
+java.lang.Object
+  extended by org.opensaml.xml.AbstractXMLObject
+      extended by org.opensaml.xml.validation.AbstractValidatingXMLObject
+          extended by org.opensaml.common.impl.AbstractSAMLObject
+              extended by org.opensaml.saml2.metadata.impl.EndpointImpl
+                  extended by org.opensaml.saml2.metadata.impl.IndexedEndpointImpl
+                      extended by edu.internet2.middleware.shibboleth.wayf.DiscoveryResponseImpl
+
+
+
All Implemented Interfaces:
org.opensaml.common.SAMLObject, org.opensaml.saml2.metadata.Endpoint, org.opensaml.saml2.metadata.IndexedEndpoint, org.opensaml.xml.AttributeExtensibleXMLObject, org.opensaml.xml.ElementExtensibleXMLObject, org.opensaml.xml.validation.ValidatingXMLObject, org.opensaml.xml.XMLObject
+
+
+
+
public class DiscoveryResponseImpl
extends org.opensaml.saml2.metadata.impl.IndexedEndpointImpl
implements org.opensaml.saml2.metadata.IndexedEndpoint
+ + +

+This plugs into the standard opensaml2 parser framework to allow us to get use DiscoverResponse + elements in our extensions. +

+ +

+

+ +

+ + + + + + + + + + + + + + + +
+Field Summary
+protected static StringDEFAULT_ELEMENT_LOCAL_NAME + +
+          Name of the element inside the Extensions.
+static StringMETADATA_NS + +
+          Namespace for Discovery Service metadata extensions.
+  + + + + + + + +
Fields inherited from interface org.opensaml.saml2.metadata.IndexedEndpoint
DEFAULT_ELEMENT_NAME, INDEX_ATTRIB_NAME, IS_DEFAULT_ATTRIB_NAME, TYPE_LOCAL_NAME, TYPE_NAME
+  + + + + + + + +
Fields inherited from interface org.opensaml.saml2.metadata.Endpoint
BINDING_ATTRIB_NAME, LOCATION_ATTRIB_NAME, RESPONSE_LOCATION_ATTRIB_NAME
+  + + + + + + + + + + + +
+Constructor Summary
+protected DiscoveryResponseImpl(String namespaceURI, + String elementLocalName, + String namespacePrefix) + +
+          Constructor.
+  + + + + + + + +
+Method Summary
+  + + + + + + + +
Methods inherited from class org.opensaml.saml2.metadata.impl.IndexedEndpointImpl
getIndex, isDefault, isDefaultXSBoolean, setIndex, setIsDefault, setIsDefault
+  + + + + + + + +
Methods inherited from class org.opensaml.saml2.metadata.impl.EndpointImpl
getBinding, getLocation, getOrderedChildren, getResponseLocation, getUnknownAttributes, getUnknownXMLObjects, getUnknownXMLObjects, setBinding, setLocation, setResponseLocation
+  + + + + + + + +
Methods inherited from class org.opensaml.common.impl.AbstractSAMLObject
equals, prepareForAssignment
+  + + + + + + + +
Methods inherited from class org.opensaml.xml.validation.AbstractValidatingXMLObject
deregisterValidator, getValidators, registerValidator, validate, validateChildren
+  + + + + + + + +
Methods inherited from class org.opensaml.xml.AbstractXMLObject
addNamespace, detach, getDOM, getElementQName, getIDIndex, getNamespaces, getNoNamespaceSchemaLocation, getParent, getSchemaLocation, getSchemaType, hasChildren, hasParent, prepareForAssignment, prepareForAssignment, prepareForAssignment, prepareForAssignment, registerOwnID, releaseChildrenDOM, releaseDOM, releaseParentDOM, releaseThisAndChildrenDOM, releaseThisandParentDOM, removeNamespace, resolveID, resolveIDFromRoot, setDOM, setElementNamespacePrefix, setElementQName, setNoNamespaceSchemaLocation, setParent, setSchemaLocation, setSchemaType
+  + + + + + + + +
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  + + + + + + + +
Methods inherited from interface org.opensaml.saml2.metadata.IndexedEndpoint
getIndex, isDefault, isDefaultXSBoolean, setIndex, setIsDefault, setIsDefault
+  + + + + + + + +
Methods inherited from interface org.opensaml.saml2.metadata.Endpoint
getBinding, getLocation, getResponseLocation, setBinding, setLocation, setResponseLocation
+  + + + + + + + +
Methods inherited from interface org.opensaml.xml.validation.ValidatingXMLObject
deregisterValidator, getValidators, registerValidator, validate
+  + + + + + + + +
Methods inherited from interface org.opensaml.xml.XMLObject
addNamespace, detach, getDOM, getElementQName, getIDIndex, getNamespaces, getNoNamespaceSchemaLocation, getOrderedChildren, getParent, getSchemaLocation, getSchemaType, hasChildren, hasParent, releaseChildrenDOM, releaseDOM, releaseParentDOM, removeNamespace, resolveID, resolveIDFromRoot, setDOM, setNoNamespaceSchemaLocation, setParent, setSchemaLocation
+  + + + + + + + +
Methods inherited from interface org.opensaml.xml.ElementExtensibleXMLObject
getUnknownXMLObjects, getUnknownXMLObjects
+  + + + + + + + +
Methods inherited from interface org.opensaml.xml.AttributeExtensibleXMLObject
getUnknownAttributes
+  +

+ + + + + + + + +
+Field Detail
+ +

+METADATA_NS

+
+public static final String METADATA_NS
+
+
Namespace for Discovery Service metadata extensions. +

+

+
See Also:
Constant Field Values
+
+
+ +

+DEFAULT_ELEMENT_LOCAL_NAME

+
+protected static final String DEFAULT_ELEMENT_LOCAL_NAME
+
+
Name of the element inside the Extensions. +

+

+
See Also:
Constant Field Values
+
+ + + + + + + + +
+Constructor Detail
+ +

+DiscoveryResponseImpl

+
+protected DiscoveryResponseImpl(String namespaceURI,
+                                String elementLocalName,
+                                String namespacePrefix)
+
+
Constructor. +

+

+
Parameters:
namespaceURI - the Uri
elementLocalName - the local name
namespacePrefix - the prefix
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
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/DiscoveryResponseUnmarshaller.html b/doc/api/edu/internet2/middleware/shibboleth/wayf/DiscoveryResponseUnmarshaller.html new file mode 100644 index 0000000..75a3c3f --- /dev/null +++ b/doc/api/edu/internet2/middleware/shibboleth/wayf/DiscoveryResponseUnmarshaller.html @@ -0,0 +1,298 @@ + + + + + + + +DiscoveryResponseUnmarshaller (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 +
+Class DiscoveryResponseUnmarshaller

+
+java.lang.Object
+  extended by org.opensaml.xml.io.AbstractXMLObjectUnmarshaller
+      extended by org.opensaml.common.impl.AbstractSAMLObjectUnmarshaller
+          extended by org.opensaml.saml2.metadata.impl.EndpointUnmarshaller
+              extended by org.opensaml.saml2.metadata.impl.IndexedEndpointUnmarshaller
+                  extended by edu.internet2.middleware.shibboleth.wayf.DiscoveryResponseUnmarshaller
+
+
+
All Implemented Interfaces:
org.opensaml.xml.io.Unmarshaller
+
+
+
+
public class DiscoveryResponseUnmarshaller
extends org.opensaml.saml2.metadata.impl.IndexedEndpointUnmarshaller
+ + +

+A thread safe Unmarshaller for SingleLogoutService objects. +

+ +

+

+ +

+ + + + + + + + + + + +
+Constructor Summary
DiscoveryResponseUnmarshaller() + +
+           
+  + + + + + + + + + + + +
+Method Summary
+protected  voidprocessAttribute(org.opensaml.xml.XMLObject samlObject, + Attr attribute) + +
+          
+  + + + + + + + +
Methods inherited from class org.opensaml.saml2.metadata.impl.EndpointUnmarshaller
processChildElement
+  + + + + + + + +
Methods inherited from class org.opensaml.common.impl.AbstractSAMLObjectUnmarshaller
processElementContent
+  + + + + + + + +
Methods inherited from class org.opensaml.xml.io.AbstractXMLObjectUnmarshaller
buildXMLObject, checkElementIsTarget, checkIDAttribute, unmarshall, unmarshallAttribute, unmarshallChildElement, unmarshallNamespaceAttribute, unmarshallSchemaInstanceAttributes, unmarshallTextContent
+  + + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

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

+DiscoveryResponseUnmarshaller

+
+public DiscoveryResponseUnmarshaller()
+
+
+ + + + + + + + +
+Method Detail
+ +

+processAttribute

+
+protected void processAttribute(org.opensaml.xml.XMLObject samlObject,
+                                Attr attribute)
+                         throws org.opensaml.xml.io.UnmarshallingException
+
+
+

+

+
Overrides:
processAttribute in class org.opensaml.saml2.metadata.impl.IndexedEndpointUnmarshaller
+
+
+ +
Throws: +
org.opensaml.xml.io.UnmarshallingException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
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/DiscoveryServiceHandler.html b/doc/api/edu/internet2/middleware/shibboleth/wayf/DiscoveryServiceHandler.html new file mode 100644 index 0000000..c5f8026 --- /dev/null +++ b/doc/api/edu/internet2/middleware/shibboleth/wayf/DiscoveryServiceHandler.html @@ -0,0 +1,343 @@ + + + + + + + +DiscoveryServiceHandler (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 +
+Class DiscoveryServiceHandler

+
+java.lang.Object
+  extended by edu.internet2.middleware.shibboleth.wayf.DiscoveryServiceHandler
+
+
+
+
public class DiscoveryServiceHandler
extends Object
+ + +

+Specific handler for each version of the Discovery Service. +

+ +

+

+ +

+ + + + + + + + + + + + +
+Constructor Summary
+protected DiscoveryServiceHandler(Element config, + Hashtable<String,IdPSiteSet> federations, + Hashtable<String,Plugin> plugins, + HandlerConfig defaultConfig) + +
+          Constructor to create and configure the handler.
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voiddoGet(javax.servlet.http.HttpServletRequest req, + javax.servlet.http.HttpServletResponse res) + +
+           
+static voidforwardRequest(javax.servlet.http.HttpServletRequest req, + javax.servlet.http.HttpServletResponse res, + IdPSite site) + +
+          Uses an HTTP Status 307 redirect to forward the user to the IdP or the SP.
+protected  StringgetLocation() + +
+          The 'Name' of the service.
+protected  booleanisDefault() + +
+          Whether this is the default service.
+  + + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

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

+DiscoveryServiceHandler

+
+protected DiscoveryServiceHandler(Element config,
+                                  Hashtable<String,IdPSiteSet> federations,
+                                  Hashtable<String,Plugin> plugins,
+                                  HandlerConfig defaultConfig)
+                           throws ShibbolethConfigurationException
+
+
Constructor to create and configure the handler. +

+

+
Parameters:
config - - DOM Element with configuration information.
federations - - Supplies all known providers which will be included if so configured.
plugins - - Supplies all known plugins which will be included if configured in.
defaultConfig - - The default configurations. +
Throws: +
ShibbolethConfigurationException - - if we find something odd in the config file.
+
+ + + + + + + + +
+Method Detail
+ +

+getLocation

+
+protected String getLocation()
+
+
The 'Name' of the service. the path used to identify the ServiceHandler. +

+

+ +
Returns:
the path used to identify the ServiceHandler.
+
+
+
+ +

+isDefault

+
+protected boolean isDefault()
+
+
Whether this is the default service. +

+

+ +
Returns:
is it?
+
+
+
+ +

+doGet

+
+public void doGet(javax.servlet.http.HttpServletRequest req,
+                  javax.servlet.http.HttpServletResponse res)
+
+
+
+
+
+
+ +

+forwardRequest

+
+public static void forwardRequest(javax.servlet.http.HttpServletRequest req,
+                                  javax.servlet.http.HttpServletResponse res,
+                                  IdPSite site)
+                           throws WayfException
+
+
Uses an HTTP Status 307 redirect to forward the user to the IdP or the SP. +

+

+
Parameters:
req - request under consideration
res - response under construction
site - The Idp +
Throws: +
WayfException - if bad things happen.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
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/HandlerConfig.html b/doc/api/edu/internet2/middleware/shibboleth/wayf/HandlerConfig.html new file mode 100644 index 0000000..7fcf436 --- /dev/null +++ b/doc/api/edu/internet2/middleware/shibboleth/wayf/HandlerConfig.html @@ -0,0 +1,414 @@ + + + + + + + +HandlerConfig (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 +
+Class HandlerConfig

+
+java.lang.Object
+  extended by edu.internet2.middleware.shibboleth.wayf.HandlerConfig
+
+
+
+
public class HandlerConfig
extends Object
+ + +

+Class used by the DiscoveryServiceHandler to handle run time behaviour. +

+ +

+

+ +

+ + + + + + + + + + + + + + +
+Constructor Summary
HandlerConfig() + +
+          Build the 'default default' configuation.
HandlerConfig(Element config, + HandlerConfig defaultValue) + +
+          Parse the Supplied XML element into a new WayfConfig Object.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ StringgetErrorJspFile() + +
+          Get the name of the error jsp File this instance uses.
+ StringgetJspFile() + +
+          Get the name of the jsp File this instance uses.
+ booleangetLookupSp() + +
+          Do we lookup the SP or just return all the IdPs?.
+ booleangetProvideList() + +
+          Do we provide a list of IdPs?.
+ booleangetProvideListOfLists() + +
+          Do we provide a list of lists of IdPs?.
+ booleangetWarnOnBadBinding() + +
+          Do ignore badly formed bindings or just warn
+ booleanisIgnoredForMatch(String str) + +
+          Determines if a particular string token should be used for matching when a user searches for origins.
+  + + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

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

+HandlerConfig

+
+public HandlerConfig()
+
+
Build the 'default default' configuation. +

+

+
+ +

+HandlerConfig

+
+public HandlerConfig(Element config,
+                     HandlerConfig defaultValue)
+              throws ShibbolethConfigurationException
+
+
Parse the Supplied XML element into a new WayfConfig Object. +

+

+
Parameters:
config - - The XML with the configuration info.
defaultValue - - The default if nothing is specified. +
Throws: +
ShibbolethConfigurationException - - if we see somethin wrong.
+
+ + + + + + + + +
+Method Detail
+ +

+isIgnoredForMatch

+
+public boolean isIgnoredForMatch(String str)
+
+
Determines if a particular string token should be used for matching when a user searches for origins. +

+

+
Parameters:
str - - The string to lookup. +
Returns:
whether it is or not.
+
+
+
+ +

+getJspFile

+
+public String getJspFile()
+
+
Get the name of the jsp File this instance uses. +

+

+ +
Returns:
the name.
+
+
+
+ +

+getErrorJspFile

+
+public String getErrorJspFile()
+
+
Get the name of the error jsp File this instance uses. +

+

+ +
Returns:
the name.
+
+
+
+ +

+getProvideListOfLists

+
+public boolean getProvideListOfLists()
+
+
Do we provide a list of lists of IdPs?. +

+

+ +
Returns:
whether we do or not.
+
+
+
+ +

+getProvideList

+
+public boolean getProvideList()
+
+
Do we provide a list of IdPs?. +

+

+ +
Returns:
whether we provide a list of IdPs?.
+
+
+
+ +

+getLookupSp

+
+public boolean getLookupSp()
+
+
Do we lookup the SP or just return all the IdPs?. +

+

+ +
Returns:
whether or not we lookup the SP
+
+
+
+ +

+getWarnOnBadBinding

+
+public boolean getWarnOnBadBinding()
+
+
Do ignore badly formed bindings or just warn +

+

+ +
Returns:
whether we warn.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
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/IdPSite.Compare.html b/doc/api/edu/internet2/middleware/shibboleth/wayf/IdPSite.Compare.html new file mode 100644 index 0000000..02959bf --- /dev/null +++ b/doc/api/edu/internet2/middleware/shibboleth/wayf/IdPSite.Compare.html @@ -0,0 +1,270 @@ + + + + + + + +IdPSite.Compare (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 +
+Class IdPSite.Compare

+
+java.lang.Object
+  extended by edu.internet2.middleware.shibboleth.wayf.IdPSite.Compare
+
+
+
All Implemented Interfaces:
Comparator<IdPSite>
+
+
+
Enclosing class:
IdPSite
+
+
+
+
public static class IdPSite.Compare
extends Object
implements Comparator<IdPSite>
+ + +

+

+ +

+ + + + + + + + + + + +
+Constructor Summary
IdPSite.Compare(javax.servlet.http.HttpServletRequest req) + +
+           
+  + + + + + + + + + + + +
+Method Summary
+ intcompare(IdPSite o1, + IdPSite o2) + +
+           
+  + + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  + + + + + + + +
Methods inherited from interface java.util.Comparator
equals
+  +

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

+IdPSite.Compare

+
+public IdPSite.Compare(javax.servlet.http.HttpServletRequest req)
+
+
+ + + + + + + + +
+Method Detail
+ +

+compare

+
+public int compare(IdPSite o1,
+                   IdPSite o2)
+
+
+
Specified by:
compare in interface Comparator<IdPSite>
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
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/IdPSite.html b/doc/api/edu/internet2/middleware/shibboleth/wayf/IdPSite.html new file mode 100644 index 0000000..b90486c --- /dev/null +++ b/doc/api/edu/internet2/middleware/shibboleth/wayf/IdPSite.html @@ -0,0 +1,396 @@ + + + + + + + +IdPSite (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 +
+Class IdPSite

+
+java.lang.Object
+  extended by edu.internet2.middleware.shibboleth.wayf.IdPSite
+
+
+
+
public class IdPSite
extends Object
+ + +

+A class which abstracts an IdP for the sake of the WAYF display. Given an EntityDescriptor as + input it provides bean style get functions for the name (EntityId), the display name + (a hybrid of Organization name or EntityId and the IdP's SSO connection point. +

+ +

+

+ +

+ + + + + + + + + + + +
+Nested Class Summary
+static classIdPSite.Compare + +
+           
+  + + + + + + + + + + +
+Constructor Summary
IdPSite(org.opensaml.saml2.metadata.EntityDescriptor entityParam) + +
+          Create a new element from the provided Entity.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+protected  intcompareTo(Object o, + javax.servlet.http.HttpServletRequest req) + +
+          Comparison so we can sort the output for jsp.
+ StringgetAddressForWAYF() + +
+          When a user has selected an IdP, this provides the address to which we redirect.
+ StringgetDisplayName() + +
+          Get the user friendly name for the entity, the language we previouslt set up
+ StringgetDisplayName(javax.servlet.http.HttpServletRequest req) + +
+          Get the user friendly name for the entity, collecting the locale from the + browser if possible
+ StringgetName() + +
+          Get the name for the enclosed entity.
+ voidsetDisplayLanguage(String lang) + +
+          Prior to display we set the display language from the + browser.
+  + + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

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

+IdPSite

+
+public IdPSite(org.opensaml.saml2.metadata.EntityDescriptor entityParam)
+
+
Create a new element from the provided Entity. +

+

+
Parameters:
entityParam - - What to create from
+
+ + + + + + + + +
+Method Detail
+ +

+getName

+
+public String getName()
+
+
Get the name for the enclosed entity. +

+

+ +
Returns:
the name for the enclosed entity.
+
+
+
+ +

+getDisplayName

+
+public String getDisplayName(javax.servlet.http.HttpServletRequest req)
+
+
Get the user friendly name for the entity, collecting the locale from the + browser if possible +

+

+
Parameters:
req - the request +
Returns:
a user friendly name.
+
+
+
+ +

+getDisplayName

+
+public String getDisplayName()
+
+
Get the user friendly name for the entity, the language we previouslt set up +

+

+
Parameters:
lang - the language. +
Returns:
a user friendly name.
+
+
+
+ +

+compareTo

+
+protected int compareTo(Object o,
+                        javax.servlet.http.HttpServletRequest req)
+
+
Comparison so we can sort the output for jsp. +

+

+
Parameters:
o - What to compare against +
Returns:
numeric encoding of comparison
See Also:
Comparator
+
+
+
+ +

+getAddressForWAYF

+
+public String getAddressForWAYF()
+
+
When a user has selected an IdP, this provides the address to which we redirect. +

+

+ +
Returns:
http address for the IdP this represents.
+
+
+
+ +

+setDisplayLanguage

+
+public void setDisplayLanguage(String lang)
+
+
Prior to display we set the display language from the + browser. There is probably a proper way to do this using + jsp, but I want to keep the API between JSP and java the same 1.3->2.0 +

+

+
Parameters:
lang - the language to set
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
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/IdPSiteSet.html b/doc/api/edu/internet2/middleware/shibboleth/wayf/IdPSiteSet.html new file mode 100644 index 0000000..2269d01 --- /dev/null +++ b/doc/api/edu/internet2/middleware/shibboleth/wayf/IdPSiteSet.html @@ -0,0 +1,514 @@ + + + + + + + +IdPSiteSet (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 +
+Class IdPSiteSet

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

+Represents a collection of related sites as desribed by a single soirce of metadata. + This is usually a federation. When the WAYF looks to see which IdP sites to show, + it trims the list so as to not show IdP's which do not trust the SP. + + This class is opaque outside this file. The three static methods getSitesLists, + searchForMatchingOrigins and lookupIdP provide mechansims for accessing + collections of IdPSiteSets. +

+ +

+

+ +

+ + + + + + + + + + + + +
+Constructor Summary
+protected IdPSiteSet(Element el, + org.opensaml.xml.parse.ParserPool parserPool, + boolean warnOnBadBinding) + +
+          Create a new IdPSiteSet as described by the supplied XML segment.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+protected  voidaddPlugin(Plugin plugin) + +
+          Declares a plugin to the siteset.
+protected  booleancontainsIdP(String IdPName) + +
+          For plugin handling we need to know quickly if a metadataset contains the idp.
+protected  booleancontainsSP(String SPName) + +
+          We do not need to look at a set if it doesn't know about the given SP.
+protected  StringgetDisplayName() + +
+          Return the human friendly name for this siteset.
+protected  org.opensaml.saml2.metadata.EntityDescriptorgetEntity(String name) + +
+           
+protected  StringgetIdentifier() + +
+          Return this sites (internal) identifier.
+protected  Map<String,IdPSite>getIdPSites(String searchString, + HandlerConfig config, + Collection<IdPSite> searchMatches) + +
+          Return all the Idp in the provided entities descriptor.
+protected  IdPSitegetSite(String idpName) + +
+          Return the idpSite for the given entity name.
+ voidonEvent(org.opensaml.saml2.metadata.provider.MetadataProvider provider) + +
+           
+protected  PluginMetadataParameterparamFor(Plugin plugin) + +
+          Return the parameter that this plugin uses.
+  + + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

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

+IdPSiteSet

+
+protected IdPSiteSet(Element el,
+                     org.opensaml.xml.parse.ParserPool parserPool,
+                     boolean warnOnBadBinding)
+              throws ShibbolethConfigurationException
+
+
Create a new IdPSiteSet as described by the supplied XML segment. +

+

+
Parameters:
el - - configuration details.
parserPool - - the parsers we initialized above.
warnOnBadBinding - if we just warn or give an error if an SP has bad entry points. +
Throws: +
ShibbolethConfigurationException - - if something goes wrong.
+
+ + + + + + + + +
+Method Detail
+ +

+getIdPSites

+
+protected Map<String,IdPSite> getIdPSites(String searchString,
+                                          HandlerConfig config,
+                                          Collection<IdPSite> searchMatches)
+
+
Return all the Idp in the provided entities descriptor. If SearchMatches + is non null it is populated with whatever of the IdPs matches the search string + (as noted above). +

+

+
+
+
+
Parameters:
searchString - to match with
config - parameter to mathing
searchMatches - if non null is filled with such of the sites which match the string +
Returns:
the sites which fit.
+
+
+
+ +

+getIdentifier

+
+protected String getIdentifier()
+
+
Return this sites (internal) identifier. +

+

+
+
+
+ +
Returns:
the identifier
+
+
+
+ +

+getDisplayName

+
+protected String getDisplayName()
+
+
Return the human friendly name for this siteset. +

+

+
+
+
+ +
Returns:
The friendly name
+
+
+
+ +

+containsSP

+
+protected boolean containsSP(String SPName)
+
+
We do not need to look at a set if it doesn't know about the given SP. However if + no SP is given (as per 1.1) then we do need to look. This calls lets us know whether + this set is a canddiate for looking into. +

+

+
+
+
+
Parameters:
SPName - the Sp we are interested in. +
Returns:
whether the site contains the SP.
+
+
+
+ +

+containsIdP

+
+protected boolean containsIdP(String IdPName)
+
+
For plugin handling we need to know quickly if a metadataset contains the idp. +

+

+
+
+
+
Parameters:
IdPName - the IdP we are interested in. +
Returns:
whether the site contains the IdP.
+
+
+
+ +

+addPlugin

+
+protected void addPlugin(Plugin plugin)
+
+
Declares a plugin to the siteset. +

+

+
+
+
+
Parameters:
plugin - what to declare
+
+
+
+ +

+paramFor

+
+protected PluginMetadataParameter paramFor(Plugin plugin)
+
+
Return the parameter that this plugin uses. +

+

+
+
+
+
Parameters:
plugin - +
Returns:
teh parameter.
+
+
+
+ +

+onEvent

+
+public void onEvent(org.opensaml.saml2.metadata.provider.MetadataProvider provider)
+
+
+
Specified by:
onEvent in interface org.opensaml.saml2.metadata.provider.ObservableMetadataProvider.Observer
+
+
+
+
+
+
+ +

+getSite

+
+protected IdPSite getSite(String idpName)
+                   throws WayfException
+
+
Return the idpSite for the given entity name. +

+

+
+
+
+
Parameters:
idpName - the entityname to look up +
Returns:
the associated idpSite +
Throws: +
WayfException
+
+
+
+ +

+getEntity

+
+protected org.opensaml.saml2.metadata.EntityDescriptor getEntity(String name)
+                                                          throws WayfException
+
+
+
+
+
+ +
Throws: +
WayfException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
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/IdPSiteSetEntry.html b/doc/api/edu/internet2/middleware/shibboleth/wayf/IdPSiteSetEntry.html new file mode 100644 index 0000000..f5bfd11 --- /dev/null +++ b/doc/api/edu/internet2/middleware/shibboleth/wayf/IdPSiteSetEntry.html @@ -0,0 +1,286 @@ + + + + + + + +IdPSiteSetEntry (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 +
+Class IdPSiteSetEntry

+
+java.lang.Object
+  extended by edu.internet2.middleware.shibboleth.wayf.IdPSiteSetEntry
+
+
+
+
public class IdPSiteSetEntry
extends Object
+ + +

+This is just a container class for tieing together a set of IdPs to a name - this being what + is sent to the JSP for display purposes. +

+ +

+

+ +

+ + + + + + + + + + + +
+Constructor Summary
IdPSiteSetEntry(IdPSiteSet siteSetParam, + Collection<IdPSite> sitesParam) + +
+          Create an object which contains just these two objects.
+  + + + + + + + + + + + + + + + +
+Method Summary
+ StringgetName() + +
+          Return something to display for this set of sites.
+ Collection<IdPSite>getSites() + +
+          Return the list of associated sites.
+  + + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

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

+IdPSiteSetEntry

+
+public IdPSiteSetEntry(IdPSiteSet siteSetParam,
+                       Collection<IdPSite> sitesParam)
+
+
Create an object which contains just these two objects. +

+

+
Parameters:
siteSetParam - the metadata provider.
sitesParam - the list of IdPs.
+
+ + + + + + + + +
+Method Detail
+ +

+getName

+
+public String getName()
+
+
Return something to display for this set of sites. +

+

+ +
Returns:
the name as defined in the configuration
+
+
+
+ +

+getSites

+
+public Collection<IdPSite> getSites()
+
+
Return the list of associated sites. +

+

+ +
Returns:
a collection of IdPs.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
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/LogbackConfigurationChangeListener.html b/doc/api/edu/internet2/middleware/shibboleth/wayf/LogbackConfigurationChangeListener.html new file mode 100644 index 0000000..5fcc6f9 --- /dev/null +++ b/doc/api/edu/internet2/middleware/shibboleth/wayf/LogbackConfigurationChangeListener.html @@ -0,0 +1,353 @@ + + + + + + + +LogbackConfigurationChangeListener (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 +
+Class LogbackConfigurationChangeListener

+
+java.lang.Object
+  extended by edu.internet2.middleware.shibboleth.wayf.LogbackConfigurationChangeListener
+
+
+
All Implemented Interfaces:
org.opensaml.util.resource.ResourceChangeListener
+
+
+
+
public class LogbackConfigurationChangeListener
extends Object
implements org.opensaml.util.resource.ResourceChangeListener
+ + +

+Callback that may be registered for a watch logback configuration file. +

+ +

+

+ +

+ + + + + + + +
+Nested Class Summary
+  + + + + + + + +
Nested classes/interfaces inherited from interface org.opensaml.util.resource.ResourceChangeListener
org.opensaml.util.resource.ResourceChangeListener.ResourceChange
+  + + + + + + + + + + + +
+Constructor Summary
LogbackConfigurationChangeListener() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+protected  voidconfigureLogback(org.opensaml.util.resource.Resource configuration) + +
+          Configures logback using the given resource as the Joran configuration file.
+ voidonResourceCreate(org.opensaml.util.resource.Resource resource) + +
+          
+ voidonResourceDelete(org.opensaml.util.resource.Resource resource) + +
+          
+ voidonResourceUpdate(org.opensaml.util.resource.Resource resource) + +
+          
+  + + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

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

+LogbackConfigurationChangeListener

+
+public LogbackConfigurationChangeListener()
+
+
+ + + + + + + + +
+Method Detail
+ +

+onResourceCreate

+
+public void onResourceCreate(org.opensaml.util.resource.Resource resource)
+
+
+

+

+
Specified by:
onResourceCreate in interface org.opensaml.util.resource.ResourceChangeListener
+
+
+
+
+
+
+ +

+onResourceDelete

+
+public void onResourceDelete(org.opensaml.util.resource.Resource resource)
+
+
+

+

+
Specified by:
onResourceDelete in interface org.opensaml.util.resource.ResourceChangeListener
+
+
+
+
+
+
+ +

+onResourceUpdate

+
+public void onResourceUpdate(org.opensaml.util.resource.Resource resource)
+
+
+

+

+
Specified by:
onResourceUpdate in interface org.opensaml.util.resource.ResourceChangeListener
+
+
+
+
+
+
+ +

+configureLogback

+
+protected void configureLogback(org.opensaml.util.resource.Resource configuration)
+
+
Configures logback using the given resource as the Joran configuration file. +

+

+
+
+
+
Parameters:
configuration - logback configuration file
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
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/LogbackLoggingService.html b/doc/api/edu/internet2/middleware/shibboleth/wayf/LogbackLoggingService.html new file mode 100644 index 0000000..80af937 --- /dev/null +++ b/doc/api/edu/internet2/middleware/shibboleth/wayf/LogbackLoggingService.html @@ -0,0 +1,232 @@ + + + + + + + +LogbackLoggingService (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 +
+Class LogbackLoggingService

+
+java.lang.Object
+  extended by edu.internet2.middleware.shibboleth.wayf.LogbackLoggingService
+
+
+
+
public class LogbackLoggingService
extends Object
+ + +

+Simple logging service that watches for logback configuration file changes and reloads the file when a change occurs. +

+ +

+

+ +

+ + + + + + + + + + + +
+Constructor Summary
LogbackLoggingService(String loggingConfigurationFile, + long pollingFrequency) + +
+          Constructor.
+  + + + + + + + +
+Method Summary
+  + + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

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

+LogbackLoggingService

+
+public LogbackLoggingService(String loggingConfigurationFile,
+                             long pollingFrequency)
+
+
Constructor. +

+

+
Parameters:
loggingConfigurationFile - logback configuration file
pollingFrequency - frequency the configuration file should be checked for changes
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
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/Version.html b/doc/api/edu/internet2/middleware/shibboleth/wayf/Version.html new file mode 100644 index 0000000..cf00218 --- /dev/null +++ b/doc/api/edu/internet2/middleware/shibboleth/wayf/Version.html @@ -0,0 +1,256 @@ + + + + + + + +Version (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 +
+Class Version

+
+java.lang.Object
+  extended by edu.internet2.middleware.shibboleth.wayf.Version
+
+
+
+
public class Version
extends Object
+ + +

+Class for printing the version of this library. +

+ +

+

+ +

+ + + + + + + + + + + +
+Constructor Summary
Version() + +
+           
+  + + + + + + + + + + + +
+Method Summary
+static voidmain(String[] args) + +
+          Main entry point to program.
+  + + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

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

+Version

+
+public Version()
+
+
+ + + + + + + + +
+Method Detail
+ +

+main

+
+public static void main(String[] args)
+
+
Main entry point to program. +

+

+
Parameters:
args - command line arguments
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
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/WayfException.html b/doc/api/edu/internet2/middleware/shibboleth/wayf/WayfException.html new file mode 100644 index 0000000..a7de7c4 --- /dev/null +++ b/doc/api/edu/internet2/middleware/shibboleth/wayf/WayfException.html @@ -0,0 +1,266 @@ + + + + + + + +WayfException (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 +
+Class WayfException

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

+Signals that an error has occurred while processing a Shibboleth WAYF request. +

+ +

+

+
See Also:
Serialized Form
+
+ +

+ + + + + + + + + + + + + + +
+Constructor Summary
WayfException(String s) + +
+          Constructure with just a description.
WayfException(String s, + Throwable e) + +
+          Constructor with a description and an exception.
+  + + + + + + + +
+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
+ +

+WayfException

+
+public WayfException(String s,
+                     Throwable e)
+
+
Constructor with a description and an exception. +

+

+
Parameters:
s - description
e - something bad having happened.
+
+
+ +

+WayfException

+
+public WayfException(String s)
+
+
Constructure with just a description. +

+

+
Parameters:
s - description
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
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/WayfService.html b/doc/api/edu/internet2/middleware/shibboleth/wayf/WayfService.html new file mode 100644 index 0000000..f083251 --- /dev/null +++ b/doc/api/edu/internet2/middleware/shibboleth/wayf/WayfService.html @@ -0,0 +1,316 @@ + + + + + + + +WayfService (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 +
+Class WayfService

+
+java.lang.Object
+  extended by javax.servlet.GenericServlet
+      extended by javax.servlet.http.HttpServlet
+          extended by edu.internet2.middleware.shibboleth.wayf.WayfService
+
+
+
All Implemented Interfaces:
Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig
+
+
+
+
public class WayfService
extends javax.servlet.http.HttpServlet
+ + +

+A servlet implementation of the Shibboleth WAYF service. Allows a browser + user to select from among a group of origin sites. User selection is + optionally cached and the user is forwarded to the HandleService appropriate + to his selection. +

+ +

+

+
See Also:
Serialized Form
+
+ +

+ + + + + + + + + + + +
+Constructor Summary
WayfService() + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+ voiddoGet(javax.servlet.http.HttpServletRequest req, + javax.servlet.http.HttpServletResponse res) + +
+          Handle an HTTP GET.
+ voidinit() + +
+          Initialize the Discovery Service.
+  + + + + + + + +
Methods inherited from class javax.servlet.http.HttpServlet
doDelete, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service, service
+  + + + + + + + +
Methods inherited from class javax.servlet.GenericServlet
destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log
+  + + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

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

+WayfService

+
+public WayfService()
+
+
+ + + + + + + + +
+Method Detail
+ +

+init

+
+public void init()
+          throws javax.servlet.ServletException
+
+
Initialize the Discovery Service. +

+

+
Overrides:
init in class javax.servlet.GenericServlet
+
+
+ +
Throws: +
javax.servlet.ServletException - in the case of something bad happening
See Also:
GenericServlet.init()
+
+
+
+ +

+doGet

+
+public void doGet(javax.servlet.http.HttpServletRequest req,
+                  javax.servlet.http.HttpServletResponse res)
+
+
Handle an HTTP GET. Just passes out to the appropriate handler. +

+

+
Overrides:
doGet in class javax.servlet.http.HttpServlet
+
+
+
Parameters:
req - described the request.
res - contains the response.
See Also:
HttpServlet.doGet(HttpServletRequest, HttpServletResponse)
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
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/XMLConstants.html b/doc/api/edu/internet2/middleware/shibboleth/wayf/XMLConstants.html new file mode 100644 index 0000000..af62eff --- /dev/null +++ b/doc/api/edu/internet2/middleware/shibboleth/wayf/XMLConstants.html @@ -0,0 +1,304 @@ + + + + + + + +XMLConstants (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 +
+Class XMLConstants

+
+java.lang.Object
+  extended by edu.internet2.middleware.shibboleth.wayf.XMLConstants
+
+
+
+
public class XMLConstants
extends Object
+ + +

+Holder class for various XML constants (namespaces and so forth). +

+ +

+

+ +

+ + + + + + + + + + + + + + + + + + + +
+Field Summary
+static StringCONFIG_NS + +
+          Namespace for Discovery Service configuration.
+static StringIDP_SSO_BINDING + +
+          SSO Binding name.
+static StringSHIB_NS + +
+          Shibboleth XML namespace.
+  + + + + + + + + + + +
+Constructor Summary
XMLConstants() + +
+           
+  + + + + + + + +
+Method Summary
+  + + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+SHIB_NS

+
+public static final String SHIB_NS
+
+
Shibboleth XML namespace. +

+

+
See Also:
Constant Field Values
+
+
+ +

+IDP_SSO_BINDING

+
+public static final String IDP_SSO_BINDING
+
+
SSO Binding name. +

+

+
See Also:
Constant Field Values
+
+
+ +

+CONFIG_NS

+
+public static final String CONFIG_NS
+
+
Namespace for Discovery Service configuration. +

+

+
See Also:
Constant Field Values
+
+ + + + + + + + +
+Constructor Detail
+ +

+XMLConstants

+
+public XMLConstants()
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
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/class-use/DiscoveryResponseBuilder.html b/doc/api/edu/internet2/middleware/shibboleth/wayf/class-use/DiscoveryResponseBuilder.html new file mode 100644 index 0000000..79c4c50 --- /dev/null +++ b/doc/api/edu/internet2/middleware/shibboleth/wayf/class-use/DiscoveryResponseBuilder.html @@ -0,0 +1,141 @@ + + + + + + + +Uses of Class edu.internet2.middleware.shibboleth.wayf.DiscoveryResponseBuilder (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.DiscoveryResponseBuilder

+
+No usage of edu.internet2.middleware.shibboleth.wayf.DiscoveryResponseBuilder +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
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/class-use/DiscoveryResponseImpl.html b/doc/api/edu/internet2/middleware/shibboleth/wayf/class-use/DiscoveryResponseImpl.html new file mode 100644 index 0000000..1fcfe7a --- /dev/null +++ b/doc/api/edu/internet2/middleware/shibboleth/wayf/class-use/DiscoveryResponseImpl.html @@ -0,0 +1,187 @@ + + + + + + + +Uses of Class edu.internet2.middleware.shibboleth.wayf.DiscoveryResponseImpl (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.DiscoveryResponseImpl

+
+ + + + + + + + + +
+Packages that use DiscoveryResponseImpl
edu.internet2.middleware.shibboleth.wayf  
+  +

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

+ + + + + + + + + + + + + +
Methods in edu.internet2.middleware.shibboleth.wayf that return DiscoveryResponseImpl
+ DiscoveryResponseImplDiscoveryResponseBuilder.buildObject() + +
+          
+ DiscoveryResponseImplDiscoveryResponseBuilder.buildObject(String namespaceURI, + String localName, + String namespacePrefix) + +
+          
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
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/class-use/DiscoveryResponseUnmarshaller.html b/doc/api/edu/internet2/middleware/shibboleth/wayf/class-use/DiscoveryResponseUnmarshaller.html new file mode 100644 index 0000000..106f7f3 --- /dev/null +++ b/doc/api/edu/internet2/middleware/shibboleth/wayf/class-use/DiscoveryResponseUnmarshaller.html @@ -0,0 +1,141 @@ + + + + + + + +Uses of Class edu.internet2.middleware.shibboleth.wayf.DiscoveryResponseUnmarshaller (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.DiscoveryResponseUnmarshaller

+
+No usage of edu.internet2.middleware.shibboleth.wayf.DiscoveryResponseUnmarshaller +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
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/class-use/DiscoveryServiceHandler.html b/doc/api/edu/internet2/middleware/shibboleth/wayf/class-use/DiscoveryServiceHandler.html new file mode 100644 index 0000000..e768d92 --- /dev/null +++ b/doc/api/edu/internet2/middleware/shibboleth/wayf/class-use/DiscoveryServiceHandler.html @@ -0,0 +1,141 @@ + + + + + + + +Uses of Class edu.internet2.middleware.shibboleth.wayf.DiscoveryServiceHandler (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.DiscoveryServiceHandler

+
+No usage of edu.internet2.middleware.shibboleth.wayf.DiscoveryServiceHandler +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
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/class-use/HandlerConfig.html b/doc/api/edu/internet2/middleware/shibboleth/wayf/class-use/HandlerConfig.html new file mode 100644 index 0000000..efda75e --- /dev/null +++ b/doc/api/edu/internet2/middleware/shibboleth/wayf/class-use/HandlerConfig.html @@ -0,0 +1,203 @@ + + + + + + + +Uses of Class edu.internet2.middleware.shibboleth.wayf.HandlerConfig (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.HandlerConfig

+
+ + + + + + + + + +
+Packages that use HandlerConfig
edu.internet2.middleware.shibboleth.wayf  
+  +

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

+ + + + + + + + + +
Methods in edu.internet2.middleware.shibboleth.wayf with parameters of type HandlerConfig
+protected  Map<String,IdPSite>IdPSiteSet.getIdPSites(String searchString, + HandlerConfig config, + Collection<IdPSite> searchMatches) + +
+          Return all the Idp in the provided entities descriptor.
+  +

+ + + + + + + + + + + +
Constructors in edu.internet2.middleware.shibboleth.wayf with parameters of type HandlerConfig
DiscoveryServiceHandler(Element config, + Hashtable<String,IdPSiteSet> federations, + Hashtable<String,Plugin> plugins, + HandlerConfig defaultConfig) + +
+          Constructor to create and configure the handler.
HandlerConfig(Element config, + HandlerConfig defaultValue) + +
+          Parse the Supplied XML element into a new WayfConfig Object.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
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/class-use/IdPSite.Compare.html b/doc/api/edu/internet2/middleware/shibboleth/wayf/class-use/IdPSite.Compare.html new file mode 100644 index 0000000..ae6550b --- /dev/null +++ b/doc/api/edu/internet2/middleware/shibboleth/wayf/class-use/IdPSite.Compare.html @@ -0,0 +1,141 @@ + + + + + + + +Uses of Class edu.internet2.middleware.shibboleth.wayf.IdPSite.Compare (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.IdPSite.Compare

+
+No usage of edu.internet2.middleware.shibboleth.wayf.IdPSite.Compare +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
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/class-use/IdPSite.html b/doc/api/edu/internet2/middleware/shibboleth/wayf/class-use/IdPSite.html new file mode 100644 index 0000000..b228fec --- /dev/null +++ b/doc/api/edu/internet2/middleware/shibboleth/wayf/class-use/IdPSite.html @@ -0,0 +1,447 @@ + + + + + + + +Uses of Class edu.internet2.middleware.shibboleth.wayf.IdPSite (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.IdPSite

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

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

+ + + + + + + + + +
Methods in edu.internet2.middleware.shibboleth.wayf that return IdPSite
+protected  IdPSiteIdPSiteSet.getSite(String idpName) + +
+          Return the idpSite for the given entity name.
+  +

+ + + + + + + + + + + + + +
Methods in edu.internet2.middleware.shibboleth.wayf that return types with arguments of type IdPSite
+protected  Map<String,IdPSite>IdPSiteSet.getIdPSites(String searchString, + HandlerConfig config, + Collection<IdPSite> searchMatches) + +
+          Return all the Idp in the provided entities descriptor.
+ Collection<IdPSite>IdPSiteSetEntry.getSites() + +
+          Return the list of associated sites.
+  +

+ + + + + + + + + + + + + +
Methods in edu.internet2.middleware.shibboleth.wayf with parameters of type IdPSite
+ intIdPSite.Compare.compare(IdPSite o1, + IdPSite o2) + +
+           
+static voidDiscoveryServiceHandler.forwardRequest(javax.servlet.http.HttpServletRequest req, + javax.servlet.http.HttpServletResponse res, + IdPSite site) + +
+          Uses an HTTP Status 307 redirect to forward the user to the IdP or the SP.
+  +

+ + + + + + + + + +
Method parameters in edu.internet2.middleware.shibboleth.wayf with type arguments of type IdPSite
+protected  Map<String,IdPSite>IdPSiteSet.getIdPSites(String searchString, + HandlerConfig config, + Collection<IdPSite> searchMatches) + +
+          Return all the Idp in the provided entities descriptor.
+  +

+ + + + + + + + +
Constructor parameters in edu.internet2.middleware.shibboleth.wayf with type arguments of type IdPSite
IdPSiteSetEntry(IdPSiteSet siteSetParam, + Collection<IdPSite> sitesParam) + +
+          Create an object which contains just these two objects.
+  +

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

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Method parameters in edu.internet2.middleware.shibboleth.wayf.plugins with type arguments of type IdPSite
+ 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.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.
+ 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.
+ 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 IdPSite in edu.internet2.middleware.shibboleth.wayf.plugins.provider
+  +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Method parameters in edu.internet2.middleware.shibboleth.wayf.plugins.provider with type arguments of type IdPSite
+ 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.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.
+ 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.
+ 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/class-use/IdPSiteSet.html b/doc/api/edu/internet2/middleware/shibboleth/wayf/class-use/IdPSiteSet.html new file mode 100644 index 0000000..62b8110 --- /dev/null +++ b/doc/api/edu/internet2/middleware/shibboleth/wayf/class-use/IdPSiteSet.html @@ -0,0 +1,193 @@ + + + + + + + +Uses of Class edu.internet2.middleware.shibboleth.wayf.IdPSiteSet (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.IdPSiteSet

+
+ + + + + + + + + +
+Packages that use IdPSiteSet
edu.internet2.middleware.shibboleth.wayf  
+  +

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

+ + + + + + + + +
Constructors in edu.internet2.middleware.shibboleth.wayf with parameters of type IdPSiteSet
IdPSiteSetEntry(IdPSiteSet siteSetParam, + Collection<IdPSite> sitesParam) + +
+          Create an object which contains just these two objects.
+  +

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

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
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/class-use/IdPSiteSetEntry.html b/doc/api/edu/internet2/middleware/shibboleth/wayf/class-use/IdPSiteSetEntry.html new file mode 100644 index 0000000..606ecb4 --- /dev/null +++ b/doc/api/edu/internet2/middleware/shibboleth/wayf/class-use/IdPSiteSetEntry.html @@ -0,0 +1,141 @@ + + + + + + + +Uses of Class edu.internet2.middleware.shibboleth.wayf.IdPSiteSetEntry (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.IdPSiteSetEntry

+
+No usage of edu.internet2.middleware.shibboleth.wayf.IdPSiteSetEntry +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
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/class-use/LogbackConfigurationChangeListener.html b/doc/api/edu/internet2/middleware/shibboleth/wayf/class-use/LogbackConfigurationChangeListener.html new file mode 100644 index 0000000..d5bac62 --- /dev/null +++ b/doc/api/edu/internet2/middleware/shibboleth/wayf/class-use/LogbackConfigurationChangeListener.html @@ -0,0 +1,141 @@ + + + + + + + +Uses of Class edu.internet2.middleware.shibboleth.wayf.LogbackConfigurationChangeListener (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.LogbackConfigurationChangeListener

+
+No usage of edu.internet2.middleware.shibboleth.wayf.LogbackConfigurationChangeListener +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
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/class-use/LogbackLoggingService.html b/doc/api/edu/internet2/middleware/shibboleth/wayf/class-use/LogbackLoggingService.html new file mode 100644 index 0000000..39f16bc --- /dev/null +++ b/doc/api/edu/internet2/middleware/shibboleth/wayf/class-use/LogbackLoggingService.html @@ -0,0 +1,141 @@ + + + + + + + +Uses of Class edu.internet2.middleware.shibboleth.wayf.LogbackLoggingService (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.LogbackLoggingService

+
+No usage of edu.internet2.middleware.shibboleth.wayf.LogbackLoggingService +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
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/class-use/Version.html b/doc/api/edu/internet2/middleware/shibboleth/wayf/class-use/Version.html new file mode 100644 index 0000000..4b8901d --- /dev/null +++ b/doc/api/edu/internet2/middleware/shibboleth/wayf/class-use/Version.html @@ -0,0 +1,141 @@ + + + + + + + +Uses of Class edu.internet2.middleware.shibboleth.wayf.Version (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.Version

+
+No usage of edu.internet2.middleware.shibboleth.wayf.Version +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
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/class-use/WayfException.html b/doc/api/edu/internet2/middleware/shibboleth/wayf/class-use/WayfException.html new file mode 100644 index 0000000..5794f6e --- /dev/null +++ b/doc/api/edu/internet2/middleware/shibboleth/wayf/class-use/WayfException.html @@ -0,0 +1,195 @@ + + + + + + + +Uses of Class edu.internet2.middleware.shibboleth.wayf.WayfException (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.WayfException

+
+ + + + + + + + + +
+Packages that use WayfException
edu.internet2.middleware.shibboleth.wayf  
+  +

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

+ + + + + + + + + + + + + + + + + +
Methods in edu.internet2.middleware.shibboleth.wayf that throw WayfException
+static voidDiscoveryServiceHandler.forwardRequest(javax.servlet.http.HttpServletRequest req, + javax.servlet.http.HttpServletResponse res, + IdPSite site) + +
+          Uses an HTTP Status 307 redirect to forward the user to the IdP or the SP.
+protected  org.opensaml.saml2.metadata.EntityDescriptorIdPSiteSet.getEntity(String name) + +
+           
+protected  IdPSiteIdPSiteSet.getSite(String idpName) + +
+          Return the idpSite for the given entity name.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
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/class-use/WayfService.html b/doc/api/edu/internet2/middleware/shibboleth/wayf/class-use/WayfService.html new file mode 100644 index 0000000..05a6f86 --- /dev/null +++ b/doc/api/edu/internet2/middleware/shibboleth/wayf/class-use/WayfService.html @@ -0,0 +1,141 @@ + + + + + + + +Uses of Class edu.internet2.middleware.shibboleth.wayf.WayfService (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.WayfService

+
+No usage of edu.internet2.middleware.shibboleth.wayf.WayfService +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
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/class-use/XMLConstants.html b/doc/api/edu/internet2/middleware/shibboleth/wayf/class-use/XMLConstants.html new file mode 100644 index 0000000..d3bf757 --- /dev/null +++ b/doc/api/edu/internet2/middleware/shibboleth/wayf/class-use/XMLConstants.html @@ -0,0 +1,141 @@ + + + + + + + +Uses of Class edu.internet2.middleware.shibboleth.wayf.XMLConstants (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.XMLConstants

+
+No usage of edu.internet2.middleware.shibboleth.wayf.XMLConstants +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
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/package-frame.html b/doc/api/edu/internet2/middleware/shibboleth/wayf/package-frame.html new file mode 100644 index 0000000..ff7b32d --- /dev/null +++ b/doc/api/edu/internet2/middleware/shibboleth/wayf/package-frame.html @@ -0,0 +1,70 @@ + + + + + + + +edu.internet2.middleware.shibboleth.wayf (Shibboleth Discovery Service 1.1.0 Java API.) + + + + + + + + + + + +edu.internet2.middleware.shibboleth.wayf + + + + +
+Classes  + +
+DiscoveryResponseBuilder +
+DiscoveryResponseImpl +
+DiscoveryResponseUnmarshaller +
+DiscoveryServiceHandler +
+HandlerConfig +
+IdPSite +
+IdPSite.Compare +
+IdPSiteSet +
+IdPSiteSetEntry +
+LogbackConfigurationChangeListener +
+LogbackLoggingService +
+Version +
+WayfService +
+XMLConstants
+ + + + + + +
+Exceptions  + +
+WayfException
+ + + + diff --git a/doc/api/edu/internet2/middleware/shibboleth/wayf/package-summary.html b/doc/api/edu/internet2/middleware/shibboleth/wayf/package-summary.html new file mode 100644 index 0000000..e506936 --- /dev/null +++ b/doc/api/edu/internet2/middleware/shibboleth/wayf/package-summary.html @@ -0,0 +1,223 @@ + + + + + + + +edu.internet2.middleware.shibboleth.wayf (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 +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Class Summary
DiscoveryResponseBuilderBuilder of SingleLogoutServiceImpl.
DiscoveryResponseImplThis plugs into the standard opensaml2 parser framework to allow us to get use DiscoverResponse + elements in our extensions.
DiscoveryResponseUnmarshallerA thread safe Unmarshaller for SingleLogoutService objects.
DiscoveryServiceHandlerSpecific handler for each version of the Discovery Service.
HandlerConfigClass used by the DiscoveryServiceHandler to handle run time behaviour.
IdPSiteA class which abstracts an IdP for the sake of the WAYF display.
IdPSite.Compare 
IdPSiteSetRepresents a collection of related sites as desribed by a single soirce of metadata.
IdPSiteSetEntryThis is just a container class for tieing together a set of IdPs to a name - this being what + is sent to the JSP for display purposes.
LogbackConfigurationChangeListenerCallback that may be registered for a watch logback configuration file.
LogbackLoggingServiceSimple logging service that watches for logback configuration file changes and reloads the file when a change occurs.
VersionClass for printing the version of this library.
WayfServiceA servlet implementation of the Shibboleth WAYF service.
XMLConstantsHolder class for various XML constants (namespaces and so forth).
+  + +

+ + + + + + + + + +
+Exception Summary
WayfExceptionSignals that an error has occurred while processing a Shibboleth WAYF request.
+  + +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
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/package-tree.html b/doc/api/edu/internet2/middleware/shibboleth/wayf/package-tree.html new file mode 100644 index 0000000..71d08c4 --- /dev/null +++ b/doc/api/edu/internet2/middleware/shibboleth/wayf/package-tree.html @@ -0,0 +1,194 @@ + + + + + + + +edu.internet2.middleware.shibboleth.wayf 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 +

+
+
+
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/package-use.html b/doc/api/edu/internet2/middleware/shibboleth/wayf/package-use.html new file mode 100644 index 0000000..217930a --- /dev/null +++ b/doc/api/edu/internet2/middleware/shibboleth/wayf/package-use.html @@ -0,0 +1,230 @@ + + + + + + + +Uses of Package edu.internet2.middleware.shibboleth.wayf (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

+
+ + + + + + + + + + + + + + + + + +
+Packages that use edu.internet2.middleware.shibboleth.wayf
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 used by edu.internet2.middleware.shibboleth.wayf
DiscoveryResponseImpl + +
+          This plugs into the standard opensaml2 parser framework to allow us to get use DiscoverResponse + elements in our extensions.
HandlerConfig + +
+          Class used by the DiscoveryServiceHandler to handle run time behaviour.
IdPSite + +
+          A class which abstracts an IdP for the sake of the WAYF display.
IdPSiteSet + +
+          Represents a collection of related sites as desribed by a single soirce of metadata.
WayfException + +
+          Signals that an error has occurred while processing a Shibboleth WAYF request.
+  +

+ + + + + + + + +
+Classes in edu.internet2.middleware.shibboleth.wayf used by edu.internet2.middleware.shibboleth.wayf.plugins
IdPSite + +
+          A class which abstracts an IdP for the sake of the WAYF display.
+  +

+ + + + + + + + +
+Classes in edu.internet2.middleware.shibboleth.wayf used by edu.internet2.middleware.shibboleth.wayf.plugins.provider
IdPSite + +
+          A class which abstracts an IdP for the sake of the WAYF display.
+  +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
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/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