Package net.shibboleth.oidc.profile.encoding.impl

Class HTTPPostAuthnRequestEncoder

java.lang.Object

net.shibboleth.shared.component.AbstractInitializableComponent

org.opensaml.messaging.encoder.AbstractMessageEncoder

org.opensaml.messaging.encoder.servlet.AbstractHttpServletResponseMessageEncoder

net.shibboleth.oidc.profile.encoding.impl.AbstractOIDCMessageEncoder

net.shibboleth.oidc.profile.encoding.impl.HTTPPostAuthnRequestEncoder

All Implemented Interfaces:

Predicate<OAuth2AuthorizationProfileConfiguration.HttpRequestMethod>, OIDCMessageEncoder, Component, DestructableComponent, InitializableComponent, UnmodifiableComponent, MessageEncoder, HttpServletResponseMessageEncoder

@Deprecated(since="3.4.0",
            forRemoval=true)
public class HTTPPostAuthnRequestEncoder
extends AbstractOIDCMessageEncoder

Deprecated, for removal: This API element is subject to removal in a future version.

Use HTTPPostRequestEncoder, which now handles both authentication and logout requests.

A message encoder that encodes an OpenID authentication request by HTTP Form POST Serialization.

Field Summary

Fields

Modifier and Type	Field	Description
private StringDigester	cspDigester	Deprecated, for removal: This API element is subject to removal in a future version. CSP digester for generating CSP hashes.
private IdentifierGenerationStrategy	cspNonceGenerator	Deprecated, for removal: This API element is subject to removal in a future version. CSP nonce generator.
static final String	DEFAULT_TEMPLATE_ID	Deprecated, for removal: This API element is subject to removal in a future version. Default template ID for using FORM POST request type.
private final org.slf4j.Logger	log	Deprecated, for removal: This API element is subject to removal in a future version. Class logger.
private org.apache.velocity.app.VelocityEngine	velocityEngine	Deprecated, for removal: This API element is subject to removal in a future version. Velocity engine used to evaluate the template when using FORM POST response mode.
private String	velocityTemplateId	Deprecated, for removal: This API element is subject to removal in a future version. ID of the Velocity template used when using FORM POST response mode.

Fields inherited from class org.opensaml.messaging.encoder.AbstractMessageEncoder

BASE_PROTOCOL_MESSAGE_LOGGER_CATEGORY

Constructor Summary

Constructors

Constructor	Description
HTTPPostAuthnRequestEncoder()	Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

Modifier and Type	Method	Description
protected void	doEncode()	Deprecated, for removal: This API element is subject to removal in a future version.
private org.apache.velocity.VelocityContext	doPostEncode(OIDCAuthenticationRequest request, HttpServletResponse httpResponse)	Deprecated, for removal: This API element is subject to removal in a future version. Construct form POST.
void	setCSPDigester(StringDigester digester)	Deprecated, for removal: This API element is subject to removal in a future version. Sets a StringDigester to use in computing CSP digests in views.
void	setCSPNonceGenerator(IdentifierGenerationStrategy strategy)	Deprecated, for removal: This API element is subject to removal in a future version. Sets an IdentifierGenerationStrategy to use in computing CSP nonces in views.
void	setVelocityEngine(org.apache.velocity.app.VelocityEngine newVelocityEngine)	Deprecated, for removal: This API element is subject to removal in a future version. Set the VelocityEngine instance.
void	setVelocityTemplateId(String newVelocityTemplateId)	Deprecated, for removal: This API element is subject to removal in a future version. Set the Velocity template id.
boolean	test(OAuth2AuthorizationProfileConfiguration.HttpRequestMethod requestMethod)	Deprecated, for removal: This API element is subject to removal in a future version.

Methods inherited from class net.shibboleth.oidc.profile.encoding.impl.AbstractOIDCMessageEncoder

createParametersFromRequest, createParametersFromRequest, serializeAuthorizationParamsToQueryString, serializeAuthorizationParamsToUrl, serializeLogoutParamsToUrl, serializeMessageForLogging, setAuthorizationParamsAreValidPredicate, validateParams

Methods inherited from class org.opensaml.messaging.encoder.servlet.AbstractHttpServletResponseMessageEncoder

doInitialize, getHttpServletResponse, getHttpServletResponseSupplier, setHttpServletResponseSupplier

Methods inherited from class org.opensaml.messaging.encoder.AbstractMessageEncoder

encode, getMessageContext, getMessageToLog, getProtocolMessageLogger, getProtocolMessageLoggerSubCategory, logEncodedMessage, prepareContext, setMessageContext, setProtocolMessageLoggerSubCategory

Methods inherited from class net.shibboleth.shared.component.AbstractInitializableComponent

checkComponentActive, checkSetterPreconditions, destroy, doDestroy, ifDestroyedThrowDestroyedComponentException, ifInitializedThrowUnmodifiabledComponentException, ifNotInitializedThrowUninitializedComponentException, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.shibboleth.shared.component.DestructableComponent

destroy, isDestroyed

Methods inherited from interface net.shibboleth.shared.component.InitializableComponent

initialize, isInitialized

Methods inherited from interface org.opensaml.messaging.encoder.MessageEncoder

encode, prepareContext, setMessageContext

Methods inherited from interface java.util.function.Predicate

and, negate, or

Field Details

DEFAULT_TEMPLATE_ID

@Nonnull
@NotEmpty
public static final String DEFAULT_TEMPLATE_ID

Deprecated, for removal: This API element is subject to removal in a future version.

Default template ID for using FORM POST request type.

See Also:

• Constant Field Values

log

@Nonnull
private final org.slf4j.Logger log

Deprecated, for removal: This API element is subject to removal in a future version.

Class logger.

velocityEngine

@Nullable
private org.apache.velocity.app.VelocityEngine velocityEngine

Deprecated, for removal: This API element is subject to removal in a future version.

Velocity engine used to evaluate the template when using FORM POST response mode.

velocityTemplateId

@Nonnull
@NotEmpty
private String velocityTemplateId

Deprecated, for removal: This API element is subject to removal in a future version.

ID of the Velocity template used when using FORM POST response mode.

cspDigester

@Nullable
private StringDigester cspDigester

Deprecated, for removal: This API element is subject to removal in a future version.

CSP digester for generating CSP hashes.

cspNonceGenerator

@Nullable
private IdentifierGenerationStrategy cspNonceGenerator

Deprecated, for removal: This API element is subject to removal in a future version.

CSP nonce generator.

Constructor Details

HTTPPostAuthnRequestEncoder

public HTTPPostAuthnRequestEncoder()

Deprecated, for removal: This API element is subject to removal in a future version.

Method Details

setCSPDigester

public void setCSPDigester(@Nullable
 StringDigester digester)

Deprecated, for removal: This API element is subject to removal in a future version.

Sets a StringDigester to use in computing CSP digests in views.

Parameters:

digester - digester to set

Since:

3.1.0

setCSPNonceGenerator

public void setCSPNonceGenerator(@Nullable
 IdentifierGenerationStrategy strategy)

Deprecated, for removal: This API element is subject to removal in a future version.

Sets an IdentifierGenerationStrategy to use in computing CSP nonces in views.

Parameters:

strategy - nonce strategy

Since:

3.1.0

setVelocityTemplateId

public void setVelocityTemplateId(@Nonnull @NotEmpty
 String newVelocityTemplateId)

Deprecated, for removal: This API element is subject to removal in a future version.

Set the Velocity template id.

Defaults to DEFAULT_TEMPLATE_ID.

Parameters:

newVelocityTemplateId - the new Velocity template id

setVelocityEngine

public void setVelocityEngine(@Nonnull
 org.apache.velocity.app.VelocityEngine newVelocityEngine)

Deprecated, for removal: This API element is subject to removal in a future version.

Set the VelocityEngine instance.

Parameters:

newVelocityEngine - the new VelocityEngine instane

test

public boolean test(@Nullable
 OAuth2AuthorizationProfileConfiguration.HttpRequestMethod requestMethod)

Deprecated, for removal: This API element is subject to removal in a future version.

doPostEncode

private org.apache.velocity.VelocityContext doPostEncode(@Nonnull
 OIDCAuthenticationRequest request,
 @Nonnull
 HttpServletResponse httpResponse)
                                                  throws MessageEncodingException

Deprecated, for removal: This API element is subject to removal in a future version.

Construct form POST.

Parameters:

request - the authentication request.

httpResponse - the httpResponse.

Returns:

response message as velocity context.

Throws:

MessageEncodingException - on error building the parameters

doEncode

protected void doEncode()
                 throws MessageEncodingException

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

doEncode in class AbstractMessageEncoder

Throws:

MessageEncodingException