Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

PropertyDescription
encoderAn HTMLEncoder object (javadoc here). This allows safe HTML encoding of various types. This is further described here.
profileRequestContext

A ProfileRequestContext (javadoc here). This is primarily used to locate subsidiary contexts:
#set ($rpContext = $profileRequestContext.getSubcontext('net.shibboleth.idp.profile.context.RelyingPartyContext'))
This is an advanced topic and out of scope for this page.

environmentThe Spring Environment (javadoc here). This will be most frequently used to resolve properties (defined in idp.properties or other files), by calling the getProperty method. For instance
environment.getProperty("idp.whatever","default")
customThe Spring bean with id "shibboleth.CustomViewContext". This can be whatever you define it to be (in global.xml)
requestThe HttpServletRequest (javadoc here). This is an advanced topic and out of scope for this page.
responseThe HttpServletResponse (javadoc here). This is an advanced topic and out of scope for this page.
flowRequestContextThe Spring Web Flow RequestContext (javadoc here). This is an advanced topic and out of scope for this page.
springMacroRequestContextA help context supplied by Spring. Primarily used to render language specific resources from the message bundles. For instance
$springMacroRequestContext.getMessage("idp.message", "An unidentified error occurred."))

...

PropertyDescription
rpUIContextRelyingPartyUIContext object. This object allows language sensitive rendering of specific information about the relying party (logos and so forth). This is described further here.
attributeDisplayNameFunction

A class (javadoc here) with one method 'apply'. This takes an IdPAttribute (usually from $attributeReleaseContext.getConsentableAttributes().values()) and outputs the DisplayName appropriate to the browser locales.

attributeDisplayDescriptionFunction 3.2

A class (javadoc here) with one method 'apply'. This takes an IdPAttribute (usually from $attributeReleaseContext.getConsentableAttributes().values()) and outputs the DisplayDescription appropriate to the browser locales.

consentContextA ConsentContext (javadoc here). A context representing the state of a consent flow (current and previous consents). Further information TBD.
attributeReleaseContext

An AttributeReleaseContext (javadoc here). This can be used to provide an iterable group of those attributes to which consent can be applied via the call $attributeReleaseContext.getConsentableAttributes().values().
Specific attributes can be found by direct lookup $attributeReleaseContext.getConsentableAttributes().get($attributeId).
In Java terms, $attributeReleaseContext.getConsentableAttributes() is a Map.

...

PropertyDescription
logoutContextA LogoutContext (javadoc here). This contains information to list the services accessed during the session that has been terminated
multi-rpContextA MultiRelyingPartyContext (javadoc here). This allows lookup of the RelyingPartyContext (javadoc here) for each service listed in the logoutContext

...

  • rpUIContext as used in the login case
  • termsOfUseId.  A ConsentContext (javadoc here). A context representing the state of a consent flow (current and previous consents). Further information TBD.

...

The EntityDescriptor (Javadoc here) is located in the MetadataContext.  Finding this requires some navigation:

...