Versions Compared

Key

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

...

Property

Description

encoder

An HTMLEncoder, allows safe HTML encoding of various types. This is further described under HtmlEncoder.

cspDigester 5.1

A StringDigester configured to produce base64-encoded SHA-256 hashes, suitable for use in generating CSP hashes

cspNonce 5.1

An IdentifierGenerationStrategy that produces nonces suitable for use with CSP

profileRequestContext

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

environment

The 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")

request

The HttpServletRequest.

response

The HttpServletResponse

flowRequestContext

The Spring Web Flow RequestContext (javadoc here). This is an advanced topic and out of scope for this page.

flowExecutionUrl

The URL to redirect to in order to advance the flow (you’ll see this in form actions, typically)

springMacroRequestContext

A 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."))

custom

The Spring bean named shibboleth.CustomViewContext. This can be whatever you define it to be (in global.xml). That bean and its content should be treated as immutable.

...

  • rpUIContext as used in the login case

  • termsOfUseId - a ConsentContext representing the state of a consent flow (current and previous consents). Further information TBD.

  • attributeHelper - see below

...

This variable is present in the ‘hello flow’ and the following intercept flows: attribute-release, expiring-password, impersonate, terms-of-use, warning-flow. It is also available in the error views for the CAS, SAML and Admin flows. By default this is of type AttributeHelper but this can be set to be any bean via the property name idp.attribute.helper. The default implementation gives easy access to the first attribute value for the specified attribute.

...

Code Block
languagexml
#set ($spEntityId = $profileRequestContext.getSubcontext('net.shibboleth.profile.context.RelyingPartyContext').getRelyingPartyId())
...
 #if ($spEntityId.equals("https://sp.examle.org/shibboleth"))
	<a>particular HTML element</a>
 #end

Display

...

the first value of an attribute

...

or a default value

Code Block
languagexml
$attributeHelper.getFirstAttributeValuegetFirstAttributeDisplayValue($profileRequestContext, "eppn", "Jane Doe")