+Index (Shibboleth Discovery Service 1.1.0 Java API.) +

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 --- doc/api/index-all.html | 472 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 472 insertions(+) create mode 100644 doc/api/index-all.html (limited to 'doc/api/index-all.html') diff --git a/doc/api/index-all.html b/doc/api/index-all.html new file mode 100644 index 0000000..e53d492 --- /dev/null +++ b/doc/api/index-all.html @@ -0,0 +1,472 @@ + + + + + + + +Index (Shibboleth Discovery Service 1.1.0 Java API.) + + + + + + + + + + + + + + + + + + + + + + + + + + +

+ + + + + + + + + + + + +

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

+ +

+ PREV + NEXT

+ FRAMES + NO FRAMES + + + + +

+ + + +A B C D E F G H I L M O P R S V W X

+A

addPlugin(Plugin) - +Method in class edu.internet2.middleware.shibboleth.wayf.IdPSiteSet +: Declares a plugin to the siteset. +

+B

BindingFilter - Class in edu.internet2.middleware.shibboleth.wayf.plugins.provider: See SDSJ-48.
BindingFilter(boolean) - +Constructor for class edu.internet2.middleware.shibboleth.wayf.plugins.provider.BindingFilter +: Initialize the filter. +
buildObject() - +Method in class edu.internet2.middleware.shibboleth.wayf.DiscoveryResponseBuilder +: +
buildObject(String, String, String) - +Method in class edu.internet2.middleware.shibboleth.wayf.DiscoveryResponseBuilder +: +

+C

compare(IdPSite, IdPSite) - +Method in class edu.internet2.middleware.shibboleth.wayf.IdPSite.Compare +: +
compareTo(Object, HttpServletRequest) - +Method in class edu.internet2.middleware.shibboleth.wayf.IdPSite +: Comparison so we can sort the output for jsp. +
CONFIG_NS - +Static variable in class edu.internet2.middleware.shibboleth.wayf.XMLConstants +: Namespace for Discovery Service configuration. +
configureLogback(Resource) - +Method in class edu.internet2.middleware.shibboleth.wayf.LogbackConfigurationChangeListener +: Configures logback using the given resource as the Joran configuration file. +
containsIdP(String) - +Method in class edu.internet2.middleware.shibboleth.wayf.IdPSiteSet +: For plugin handling we need to know quickly if a metadataset contains the idp. +
containsSP(String) - +Method in class edu.internet2.middleware.shibboleth.wayf.IdPSiteSet +: We do not need to look at a set if it doesn't know about the given SP. +

+D

DEFAULT_ELEMENT_LOCAL_NAME - +Static variable in class edu.internet2.middleware.shibboleth.wayf.DiscoveryResponseImpl +: Name of the element inside the Extensions. +
deleteIdPName(String, int) - +Method in class edu.internet2.middleware.shibboleth.wayf.plugins.provider.SamlCookiePlugin.SamlIdPCookie +: Remove origin from the cachedata and write it back. +
DiscoveryResponseBuilder - Class in edu.internet2.middleware.shibboleth.wayf: Builder of SingleLogoutServiceImpl.
DiscoveryResponseBuilder() - +Constructor for class edu.internet2.middleware.shibboleth.wayf.DiscoveryResponseBuilder +: Constructor +
DiscoveryResponseImpl - Class in edu.internet2.middleware.shibboleth.wayf: This plugs into the standard opensaml2 parser framework to allow us to get use DiscoverResponse + elements in our extensions.
DiscoveryResponseImpl(String, String, String) - +Constructor for class edu.internet2.middleware.shibboleth.wayf.DiscoveryResponseImpl +: Constructor. +
DiscoveryResponseUnmarshaller - Class in edu.internet2.middleware.shibboleth.wayf: A thread safe Unmarshaller for SingleLogoutService objects.
DiscoveryResponseUnmarshaller() - +Constructor for class edu.internet2.middleware.shibboleth.wayf.DiscoveryResponseUnmarshaller +: +
DiscoveryServiceHandler - Class in edu.internet2.middleware.shibboleth.wayf: Specific handler for each version of the Discovery Service.
DiscoveryServiceHandler(Element, Hashtable<String, IdPSiteSet>, Hashtable<String, Plugin>, HandlerConfig) - +Constructor for class edu.internet2.middleware.shibboleth.wayf.DiscoveryServiceHandler +: Constructor to create and configure the handler. +
doFilter(XMLObject) - +Method in class edu.internet2.middleware.shibboleth.wayf.plugins.provider.BindingFilter +: Apply the filter. +
doFilter(XMLObject) - +Method in class edu.internet2.middleware.shibboleth.wayf.plugins.provider.ListFilter +: Apply the filter. +
doGet(HttpServletRequest, HttpServletResponse) - +Method in class edu.internet2.middleware.shibboleth.wayf.DiscoveryServiceHandler +: +
doGet(HttpServletRequest, HttpServletResponse) - +Method in class edu.internet2.middleware.shibboleth.wayf.WayfService +: Handle an HTTP GET. +

+E

edu.internet2.middleware.shibboleth.common - package edu.internet2.middleware.shibboleth.common
edu.internet2.middleware.shibboleth.wayf - package edu.internet2.middleware.shibboleth.wayf
edu.internet2.middleware.shibboleth.wayf.plugins - package edu.internet2.middleware.shibboleth.wayf.plugins
edu.internet2.middleware.shibboleth.wayf.plugins.provider - package edu.internet2.middleware.shibboleth.wayf.plugins.provider

+F

forwardRequest(HttpServletRequest, HttpServletResponse, IdPSite) - +Static method in class edu.internet2.middleware.shibboleth.wayf.DiscoveryServiceHandler +: Uses an HTTP Status 307 redirect to forward the user to the IdP or the SP. +

+G

getAddressForWAYF() - +Method in class edu.internet2.middleware.shibboleth.wayf.IdPSite +: When a user has selected an IdP, this provides the address to which we redirect. +
getDisplayName(HttpServletRequest) - +Method in class edu.internet2.middleware.shibboleth.wayf.IdPSite +: Get the user friendly name for the entity, collecting the locale from the + browser if possible +
getDisplayName() - +Method in class edu.internet2.middleware.shibboleth.wayf.IdPSite +: Get the user friendly name for the entity, the language we previouslt set up +
getDisplayName() - +Method in class edu.internet2.middleware.shibboleth.wayf.IdPSiteSet +: Return the human friendly name for this siteset. +
getEntity(String) - +Method in class edu.internet2.middleware.shibboleth.wayf.IdPSiteSet +: +
getErrorJspFile() - +Method in class edu.internet2.middleware.shibboleth.wayf.HandlerConfig +: Get the name of the error jsp File this instance uses. +
getIdentifier() - +Method in class edu.internet2.middleware.shibboleth.wayf.IdPSiteSet +: Return this sites (internal) identifier. +
getIdPList() - +Method in class edu.internet2.middleware.shibboleth.wayf.plugins.provider.SamlCookiePlugin.SamlIdPCookie +: Return the list of Idps for this cookie. +
getIdPSites(String, HandlerConfig, Collection<IdPSite>) - +Method in class edu.internet2.middleware.shibboleth.wayf.IdPSiteSet +: Return all the Idp in the provided entities descriptor. +
getJspFile() - +Method in class edu.internet2.middleware.shibboleth.wayf.HandlerConfig +: Get the name of the jsp File this instance uses. +
getLocation() - +Method in class edu.internet2.middleware.shibboleth.wayf.DiscoveryServiceHandler +: The 'Name' of the service. +
getLookupSp() - +Method in class edu.internet2.middleware.shibboleth.wayf.HandlerConfig +: Do we lookup the SP or just return all the IdPs?. +
getName() - +Method in class edu.internet2.middleware.shibboleth.wayf.IdPSite +: Get the name for the enclosed entity. +
getName() - +Method in class edu.internet2.middleware.shibboleth.wayf.IdPSiteSetEntry +: Return something to display for this set of sites. +
getProvideList() - +Method in class edu.internet2.middleware.shibboleth.wayf.HandlerConfig +: Do we provide a list of IdPs?. +
getProvideListOfLists() - +Method in class edu.internet2.middleware.shibboleth.wayf.HandlerConfig +: Do we provide a list of lists of IdPs?. +
getSite(String) - +Method in class edu.internet2.middleware.shibboleth.wayf.IdPSiteSet +: Return the idpSite for the given entity name. +
getSites() - +Method in class edu.internet2.middleware.shibboleth.wayf.IdPSiteSetEntry +: Return the list of associated sites. +
getWarnOnBadBinding() - +Method in class edu.internet2.middleware.shibboleth.wayf.HandlerConfig +: Do ignore badly formed bindings or just warn +

+H

HandlerConfig - Class in edu.internet2.middleware.shibboleth.wayf: Class used by the DiscoveryServiceHandler to handle run time behaviour.
HandlerConfig() - +Constructor for class edu.internet2.middleware.shibboleth.wayf.HandlerConfig +: Build the 'default default' configuation. +
HandlerConfig(Element, HandlerConfig) - +Constructor for class edu.internet2.middleware.shibboleth.wayf.HandlerConfig +: Parse the Supplied XML element into a new WayfConfig Object. +

+I

IDP_SSO_BINDING - +Static variable in class edu.internet2.middleware.shibboleth.wayf.XMLConstants +: SSO Binding name. +
IdPSite - Class in edu.internet2.middleware.shibboleth.wayf: A class which abstracts an IdP for the sake of the WAYF display.
IdPSite(EntityDescriptor) - +Constructor for class edu.internet2.middleware.shibboleth.wayf.IdPSite +: Create a new element from the provided Entity. +
IdPSite.Compare - Class in edu.internet2.middleware.shibboleth.wayf
IdPSite.Compare(HttpServletRequest) - +Constructor for class edu.internet2.middleware.shibboleth.wayf.IdPSite.Compare +: +
IdPSiteSet - Class in edu.internet2.middleware.shibboleth.wayf: Represents a collection of related sites as desribed by a single soirce of metadata.
IdPSiteSet(Element, ParserPool, boolean) - +Constructor for class edu.internet2.middleware.shibboleth.wayf.IdPSiteSet +: Create a new IdPSiteSet as described by the supplied XML segment. +
IdPSiteSetEntry - Class in edu.internet2.middleware.shibboleth.wayf: 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.
IdPSiteSetEntry(IdPSiteSet, Collection<IdPSite>) - +Constructor for class edu.internet2.middleware.shibboleth.wayf.IdPSiteSetEntry +: Create an object which contains just these two objects. +
init() - +Method in class edu.internet2.middleware.shibboleth.wayf.WayfService +: Initialize the Discovery Service. +
isDefault() - +Method in class edu.internet2.middleware.shibboleth.wayf.DiscoveryServiceHandler +: Whether this is the default service. +
isIgnoredForMatch(String) - +Method in class edu.internet2.middleware.shibboleth.wayf.HandlerConfig +: Determines if a particular string token should be used for matching when a user searches for origins. +

+L

ListFilter - Class in edu.internet2.middleware.shibboleth.wayf.plugins.provider: See SDSJ-57.
ListFilter(Element) - +Constructor for class edu.internet2.middleware.shibboleth.wayf.plugins.provider.ListFilter +: Initialize the filter. +
LogbackConfigurationChangeListener - Class in edu.internet2.middleware.shibboleth.wayf: Callback that may be registered for a watch logback configuration file.
LogbackConfigurationChangeListener() - +Constructor for class edu.internet2.middleware.shibboleth.wayf.LogbackConfigurationChangeListener +: +
LogbackLoggingService - Class in edu.internet2.middleware.shibboleth.wayf: Simple logging service that watches for logback configuration file changes and reloads the file when a change occurs.
LogbackLoggingService(String, long) - +Constructor for class edu.internet2.middleware.shibboleth.wayf.LogbackLoggingService +: Constructor. +
lookup(HttpServletRequest, HttpServletResponse, PluginMetadataParameter, Map<String, IdPSite>, PluginContext, List<IdPSite>) - +Method in interface edu.internet2.middleware.shibboleth.wayf.plugins.Plugin +: The WAYF calls each plugin at this entry point when it is first contacted. +
lookup(HttpServletRequest, HttpServletResponse, PluginMetadataParameter, Map<String, IdPSite>, PluginContext, List<IdPSite>) - +Method in class edu.internet2.middleware.shibboleth.wayf.plugins.provider.SamlCookiePlugin +: This is the 'hook' in the lookup part of Discovery Service processing. +

+M

main(String[]) - +Static method in class edu.internet2.middleware.shibboleth.wayf.Version +: Main entry point to program. +
METADATA_NS - +Static variable in class edu.internet2.middleware.shibboleth.wayf.DiscoveryResponseImpl +: Namespace for Discovery Service metadata extensions. +

+O

onEvent(MetadataProvider) - +Method in class edu.internet2.middleware.shibboleth.wayf.IdPSiteSet +: +
onResourceCreate(Resource) - +Method in class edu.internet2.middleware.shibboleth.wayf.LogbackConfigurationChangeListener +: +
onResourceDelete(Resource) - +Method in class edu.internet2.middleware.shibboleth.wayf.LogbackConfigurationChangeListener +: +
onResourceUpdate(Resource) - +Method in class edu.internet2.middleware.shibboleth.wayf.LogbackConfigurationChangeListener +: +

+P

paramFor(Plugin) - +Method in class edu.internet2.middleware.shibboleth.wayf.IdPSiteSet +: Return the parameter that this plugin uses. +
Plugin - Interface in edu.internet2.middleware.shibboleth.wayf.plugins: The Plugin interface is used to affect the 'hints' that the WAYF offers to the users.
PluginContext - Interface in edu.internet2.middleware.shibboleth.wayf.plugins: This is a marker interface.
PluginMetadataParameter - Interface in edu.internet2.middleware.shibboleth.wayf.plugins: The PluginParameter is a marker interface which a WAYF Plugin can use to associate extra information + with the metadata.
processAttribute(XMLObject, Attr) - +Method in class edu.internet2.middleware.shibboleth.wayf.DiscoveryResponseUnmarshaller +: +

+R

refreshMetadata(MetadataProvider) - +Method in interface edu.internet2.middleware.shibboleth.wayf.plugins.Plugin +: Whenever the WAYF discoveres that the metadata is stale, it reloads it and calls each plugin at this method. +
refreshMetadata(MetadataProvider) - +Method in class edu.internet2.middleware.shibboleth.wayf.plugins.provider.SamlCookiePlugin +: Plugin point which is called when the data is refreshed. +

+S

SamlCookiePlugin - Class in edu.internet2.middleware.shibboleth.wayf.plugins.provider: This is a test implementation of the saml cookie lookup stuff to + see whether it fits the plugin architecture.
SamlCookiePlugin(Element) - +Constructor for class edu.internet2.middleware.shibboleth.wayf.plugins.provider.SamlCookiePlugin +: This constructor is called during wayf initialization with it's + own little bit of XML config. +
SamlCookiePlugin.SamlIdPCookie - Class in edu.internet2.middleware.shibboleth.wayf.plugins.provider: Class to abstract away the saml cookie for us.
search(HttpServletRequest, HttpServletResponse, PluginMetadataParameter, String, Map<String, IdPSite>, PluginContext, Collection<IdPSite>, List<IdPSite>) - +Method in interface edu.internet2.middleware.shibboleth.wayf.plugins.Plugin +: This method is called when the user specified a search operation. +
search(HttpServletRequest, HttpServletResponse, PluginMetadataParameter, String, Map<String, IdPSite>, PluginContext, Collection<IdPSite>, List<IdPSite>) - +Method in class edu.internet2.middleware.shibboleth.wayf.plugins.provider.SamlCookiePlugin +: Plgin point for searching. +
selected(HttpServletRequest, HttpServletResponse, PluginMetadataParameter, String) - +Method in interface edu.internet2.middleware.shibboleth.wayf.plugins.Plugin +: This method is called, for every plugin, after a user has selected an IdP. +
selected(HttpServletRequest, HttpServletResponse, PluginMetadataParameter, String) - +Method in class edu.internet2.middleware.shibboleth.wayf.plugins.provider.SamlCookiePlugin +: Plugin point for selection. +
setDisplayLanguage(String) - +Method in class edu.internet2.middleware.shibboleth.wayf.IdPSite +: Prior to display we set the display language from the + browser. +
SHIB_NS - +Static variable in class edu.internet2.middleware.shibboleth.wayf.XMLConstants +: Shibboleth XML namespace. +
ShibbolethConfigurationException - Exception in edu.internet2.middleware.shibboleth.common: Signals that the a Shibboleth component has been given insufficient or improper runtime configuration paramerts.
ShibbolethConfigurationException(String) - +Constructor for exception edu.internet2.middleware.shibboleth.common.ShibbolethConfigurationException +: Build an object embedding a String message. +
ShibbolethConfigurationException(String, Throwable) - +Constructor for exception edu.internet2.middleware.shibboleth.common.ShibbolethConfigurationException +: Build an object which embeds an message an exception. +

+V

Version - Class in edu.internet2.middleware.shibboleth.wayf: Class for printing the version of this library.
Version() - +Constructor for class edu.internet2.middleware.shibboleth.wayf.Version +: +

+W

WayfException - Exception in edu.internet2.middleware.shibboleth.wayf: Signals that an error has occurred while processing a Shibboleth WAYF request.
WayfException(String, Throwable) - +Constructor for exception edu.internet2.middleware.shibboleth.wayf.WayfException +: Constructor with a description and an exception. +
WayfException(String) - +Constructor for exception edu.internet2.middleware.shibboleth.wayf.WayfException +: Constructure with just a description. +
WayfRequestHandled - Exception in edu.internet2.middleware.shibboleth.wayf.plugins: This Exception can be signalled by a plugin to indicate to the WAYF that it has handled the + request and all processing should stop.
WayfRequestHandled() - +Constructor for exception edu.internet2.middleware.shibboleth.wayf.plugins.WayfRequestHandled +: +
WayfService - Class in edu.internet2.middleware.shibboleth.wayf: A servlet implementation of the Shibboleth WAYF service.
WayfService() - +Constructor for class edu.internet2.middleware.shibboleth.wayf.WayfService +: +

+X

XMLConstants - Class in edu.internet2.middleware.shibboleth.wayf: Holder class for various XML constants (namespaces and so forth).
XMLConstants() - +Constructor for class edu.internet2.middleware.shibboleth.wayf.XMLConstants +: +

+A B C D E F G H I L M O P R S V W X + + + + + + + + + + + + + + +