Package org.wildfly.security.http.util.sso

Class ProgrammaticSingleSignOnCache.SSOHttpServerRequest

java.lang.Object

org.wildfly.security.http.impl.BaseHttpServerRequest

org.wildfly.security.http.util.sso.ProgrammaticSingleSignOnCache.SSOHttpServerRequest

All Implemented Interfaces:

HttpServerRequest, HttpServerScopes

Enclosing class:

ProgrammaticSingleSignOnCache

private static class ProgrammaticSingleSignOnCache.SSOHttpServerRequest
extends BaseHttpServerRequest

An implementation of HttpServerRequest which can be used with the {link SingleSignOnSessionFactory}. As this is only expected to be used for programmatic authentication the callback methods are not supported.

Constructor Summary

Constructors

Constructor	Description
SSOHttpServerRequest(HttpExchangeSpi httpExchangeSpi)

Method Summary

Modifier and Type	Method	Description
void	authenticationComplete(HttpServerMechanismsResponder responder)	Notification that authentication is now complete.
void	authenticationComplete(HttpServerMechanismsResponder responder, Runnable logoutHandler)	Notification that authentication is now complete.
void	authenticationFailed(String message, HttpServerMechanismsResponder responder)	Notification that authentication failes.
void	authenticationInProgress(HttpServerMechanismsResponder responder)	Notification that this mechanism has commenced but not completed authentication, typically because another challenge / response round trip is required.
void	badRequest(HttpAuthenticationException failure, HttpServerMechanismsResponder responder)	Notification to indicate that this was a bad request.
void	noAuthenticationInProgress(HttpServerMechanismsResponder responder)	Notification from the mechanism to state no authentication is in progress whilst evaluating the current request.
boolean	resumeRequest()	Resume any previously suspended request.
boolean	suspendRequest()	Suspend the current request so that it can be subsequently resumed.

Methods inherited from class org.wildfly.security.http.impl.BaseHttpServerRequest

getCookies, getFirstParameterValue, getFirstRequestHeaderValue, getInputStream, getParameterNames, getParameters, getParameterValues, getPeerCertificates, getRemoteUser, getRequestHeaderValues, getRequestMethod, getRequestPath, getRequestURI, getScope, getScope, getScopeIds, getSourceAddress, getSSLSession

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.wildfly.security.http.HttpServerRequest

authenticationComplete, authenticationFailed, badRequest, noAuthenticationInProgress, setRequestInputStreamSupplier

Constructor Detail

SSOHttpServerRequest

SSOHttpServerRequest(HttpExchangeSpi httpExchangeSpi)

Method Detail

noAuthenticationInProgress

public void noAuthenticationInProgress(HttpServerMechanismsResponder responder)

Description copied from interface: HttpServerRequest

Notification from the mechanism to state no authentication is in progress whilst evaluating the current request.

Parameters:

responder - a HttpServerMechanismsResponder that can send a challenge should it be required.

authenticationInProgress

public void authenticationInProgress(HttpServerMechanismsResponder responder)

Description copied from interface: HttpServerRequest

Notification that this mechanism has commenced but not completed authentication, typically because another challenge / response round trip is required.

Parameters:

responder - a HttpServerMechanismsResponder that can send a challenge should it be required.

authenticationComplete

public void authenticationComplete(HttpServerMechanismsResponder responder)

Description copied from interface: HttpServerRequest

Notification that authentication is now complete. After this point the framework will perform an authorization check for the authenticated user and if successful establish the identity of the request.

Parameters:

responder - a HttpServerMechanismsResponder that can send a response.

authenticationComplete

public void authenticationComplete(HttpServerMechanismsResponder responder,
                                   Runnable logoutHandler)

Description copied from interface: HttpServerRequest

Notification that authentication is now complete.

This method behaves exactly like {@link #authenticationComplete(HttpServerMechanismsResponder)}, allowing mechanisms to register a logout handler which should be called when a logout request is received by the underlying container.

Parameters:

responder - a HttpServerMechanismsResponder that can send a response.

logoutHandler - a Runnable that can handle logout

authenticationFailed

public void authenticationFailed(String message,
                                 HttpServerMechanismsResponder responder)

Description copied from interface: HttpServerRequest

Notification that authentication failes.

Parameters:

message - an error message describing the failure.

responder - a HttpServerMechanismsResponder that can send a challenge should it be required.

badRequest

public void badRequest(HttpAuthenticationException failure,
                       HttpServerMechanismsResponder responder)

Description copied from interface: HttpServerRequest

Notification to indicate that this was a bad request.

Parameters:

failure - an HttpAuthenticationException to describe the error.

responder - a HttpServerMechanismsResponder that can send a challenge should it be required.

suspendRequest

public boolean suspendRequest()

Description copied from interface: HttpServerRequest

Suspend the current request so that it can be subsequently resumed.

Returns:

true if suspending requests is supported, false otherwise.

resumeRequest

public boolean resumeRequest()

Description copied from interface: HttpServerRequest

Resume any previously suspended request.

Returns:

true if resuming requests is supported, false otherwise.