Nested and Inner Type Summary

Modifier and Type	Class and Description
private class	SecurityContextImpl.AuthAttempter
pack-priv static enum	SecurityContextImpl.AuthenticationState Representation of the current authentication state of the SecurityContext.
private class	SecurityContextImpl.ChallengeSender Class responsible for sending the authentication challenges.
private static class	SecurityContextImpl.Node<T> To reduce allocations we use a custom linked list data structure

Field Summary

Modifier and Type	Field and Description
private final AuthenticationMode	authenticationMode
private SecurityContextImpl.AuthenticationState	authenticationState
private SecurityContextImpl.Node<AuthenticationMechanism>	authMechanisms the authentication mechanisms.
private final IdentityManager	identityManager
private static final RuntimePermission	PERMISSION
private String	programaticMechName

Inherited from io.undertow.security.impl.AbstractSecurityContext:: exchange

Constructor Summary

Access	Constructor and Description
public	SecurityContextImpl(final HttpServerExchange exchange, final IdentityManager identityManager)
public	SecurityContextImpl(final HttpServerExchange exchange, final AuthenticationMode authenticationMode, final IdentityManager identityManager)

Method Summary

Modifier and Type	Method and Description
public void	addAuthenticationMechanism(final AuthenticationMechanism The mechanism to add handler) Implements io.undertow.security.api.AuthenticationMechanismContext.addAuthenticationMechanism, io.undertow.security.api.SecurityContext.addAuthenticationMechanism. Adds an authentication mechanism to this context.
private SecurityContextImpl.AuthenticationState	attemptAuthentication()
public boolean	authenticate() Implements io.undertow.security.api.SecurityContext.authenticate. Performs authentication on the request.
private boolean	authTransition()
private boolean	authTransitionRequired()
public List<AuthenticationMechanism>	getAuthenticationMechanisms() Implements io.undertow.security.api.SecurityContext.getAuthenticationMechanisms. Deprecated
public IdentityManager	getIdentityManager() Implements io.undertow.security.api.SecurityContext.getIdentityManager. Deprecated Obtain the associated `IdentityManager` to use to make account verification decisions.
public boolean	login(final String The username username, final String The password password) Implements io.undertow.security.api.SecurityContext.login. Attempts to log the user in using the provided credentials.
public void	logout() Overrides io.undertow.security.impl.AbstractSecurityContext.logout. Implements io.undertow.security.api.SecurityContext.logout. de-authenticates the current exchange.
private SecurityContextImpl.AuthenticationState	sendChallenges()
public void	setProgramaticMechName(final String programaticMechName) Set the name of the mechanism used for authentication to be reported if authentication was handled programatically.

Inherited from io.undertow.security.impl.AbstractSecurityContext:: authenticationComplete authenticationComplete authenticationFailed getAuthenticatedAccount getMechanismName isAuthenticated isAuthenticationRequired registerNotificationReceiver removeNotificationReceiver setAuthenticationRequired

Field Detail

authenticationMode	back to summary
private final AuthenticationMode authenticationMode

authenticationState	back to summary
private SecurityContextImpl.AuthenticationState authenticationState

authMechanisms	back to summary
private SecurityContextImpl.Node<AuthenticationMechanism> authMechanisms the authentication mechanisms. Note that in order to reduce the allocation of list and iterator structures we use a custom linked list structure.

identityManager	back to summary
private final IdentityManager identityManager

PERMISSION	back to summary
private static final RuntimePermission PERMISSION

programaticMechName	back to summary
private String programaticMechName

Constructor Detail

SecurityContextImpl	back to summary
public SecurityContextImpl(final HttpServerExchange exchange, final IdentityManager identityManager)

SecurityContextImpl	back to summary
public SecurityContextImpl(final HttpServerExchange exchange, final AuthenticationMode authenticationMode, final IdentityManager identityManager)

Method Detail

addAuthenticationMechanism back to summary

addAuthenticationMechanism	back to summary
public void addAuthenticationMechanism(final AuthenticationMechanism handler) Implements io.undertow.security.api.AuthenticationMechanismContext.addAuthenticationMechanism, io.undertow.security.api.SecurityContext.addAuthenticationMechanism. Doc from io.undertow.security.api.AuthenticationMechanismContext.addAuthenticationMechanism. Adds an authentication mechanism to this context. When `authenticate()` is called mechanisms will be iterated over in the order they are added, and given a chance to authenticate the user. Parameters handler:AuthenticationMechanism The mechanism to add Annotations @Override

public void addAuthenticationMechanism(final AuthenticationMechanism handler)

Implements io.undertow.security.api.AuthenticationMechanismContext.addAuthenticationMechanism, io.undertow.security.api.SecurityContext.addAuthenticationMechanism.

Doc from io.undertow.security.api.AuthenticationMechanismContext.addAuthenticationMechanism.

Adds an authentication mechanism to this context. When authenticate() is called mechanisms will be iterated over in the order they are added, and given a chance to authenticate the user.

Parameters

handler:AuthenticationMechanism: The mechanism to add

Annotations

@Override

attemptAuthentication	back to summary
private SecurityContextImpl.AuthenticationState attemptAuthentication()

authenticate back to summary

authenticate	back to summary
public boolean authenticate() Implements io.undertow.security.api.SecurityContext.authenticate. Doc from io.undertow.security.api.SecurityContext.authenticate. Performs authentication on the request. If authentication is REQUIRED then setAuthenticationRequired() should be called before calling this method. If the result indicates that a response has been sent to the client then no further attempts should be made to modify the response. The caller of this method is responsible for ending the exchange. If this method returns `true` it can still have committed the response (e.g. form auth redirects back to the original page). Callers should check that the exchange has not been ended before proceeding. Returns:boolean `true` if either the request is successfully authenticated or if there is no failure validating the current request so that the request should continue to be processed, `false` if authentication was not completed and challenge has been prepared for the client. Annotations @Override

public boolean authenticate()

Implements io.undertow.security.api.SecurityContext.authenticate.

Doc from io.undertow.security.api.SecurityContext.authenticate.

Performs authentication on the request. If authentication is REQUIRED then setAuthenticationRequired() should be called before calling this method. If the result indicates that a response has been sent to the client then no further attempts should be made to modify the response. The caller of this method is responsible for ending the exchange. If this method returns true it can still have committed the response (e.g. form auth redirects back to the original page). Callers should check that the exchange has not been ended before proceeding.

Returns:boolean

true if either the request is successfully authenticated or if there is no failure validating the current request so that the request should continue to be processed, false if authentication was not completed and challenge has been prepared for the client.

Annotations

@Override

authTransition	back to summary
private boolean authTransition()

authTransitionRequired	back to summary
private boolean authTransitionRequired()

getAuthenticationMechanisms	back to summary
public List<AuthenticationMechanism> getAuthenticationMechanisms() Implements io.undertow.security.api.SecurityContext.getAuthenticationMechanisms. Deprecated Returns:List<AuthenticationMechanism> Doc from io.undertow.security.api.SecurityContext.getAuthenticationMechanisms. A list of all authentication mechanisms in this context Annotations @Override @Deprecated

getAuthenticationMechanisms

back to summary

public List<AuthenticationMechanism> getAuthenticationMechanisms()

Implements io.undertow.security.api.SecurityContext.getAuthenticationMechanisms.

Deprecated

Returns:List<AuthenticationMechanism>

Doc from io.undertow.security.api.SecurityContext.getAuthenticationMechanisms.

A list of all authentication mechanisms in this context

Annotations

@Override
@Deprecated

getIdentityManager back to summary

getIdentityManager	back to summary
public IdentityManager getIdentityManager() Implements io.undertow.security.api.SecurityContext.getIdentityManager. Doc from io.undertow.security.api.SecurityContext.getIdentityManager. Deprecated Obtain the associated `IdentityManager` to use to make account verification decisions. Returns:IdentityManager The associated `IdentityManager` Annotations @Override @Deprecated

public IdentityManager getIdentityManager()

Implements io.undertow.security.api.SecurityContext.getIdentityManager.

Doc from io.undertow.security.api.SecurityContext.getIdentityManager.

Deprecated

Obtain the associated IdentityManager to use to make account verification decisions.

Returns:IdentityManager

The associated IdentityManager

Annotations

@Override
@Deprecated

login	back to summary
public boolean login(final String username, final String password) Implements io.undertow.security.api.SecurityContext.login. Doc from io.undertow.security.api.SecurityContext.login. Attempts to log the user in using the provided credentials. This result will be stored in the current `AuthenticatedSessionManager` (if any), so subsequent requests will automatically be authenticated as this user. This operation may block Parameters username:String The username password:String The password Returns:boolean `true` if the login succeeded, false otherwise Annotations @Override

public boolean login(final String username, final String password)

Implements io.undertow.security.api.SecurityContext.login.

Doc from io.undertow.security.api.SecurityContext.login.

Attempts to log the user in using the provided credentials. This result will be stored in the current AuthenticatedSessionManager (if any), so subsequent requests will automatically be authenticated as this user.

This operation may block

Parameters

username:String: The username
password:String: The password

Returns:boolean

true if the login succeeded, false otherwise

Annotations

@Override

logout	back to summary
public void logout() Overrides io.undertow.security.impl.AbstractSecurityContext.logout. Implements io.undertow.security.api.SecurityContext.logout. Doc from io.undertow.security.api.SecurityContext.logout. de-authenticates the current exchange. Annotations @Override

logout

back to summary

public void logout()

Overrides io.undertow.security.impl.AbstractSecurityContext.logout.

Implements io.undertow.security.api.SecurityContext.logout.

Doc from io.undertow.security.api.SecurityContext.logout.

de-authenticates the current exchange.

Annotations

@Override

sendChallenges	back to summary
private SecurityContextImpl.AuthenticationState sendChallenges()

setProgramaticMechName	back to summary
public void setProgramaticMechName(final String programaticMechName) Set the name of the mechanism used for authentication to be reported if authentication was handled programatically.

io.undertow.security.impl back to summary

private Class SecurityContextImpl.AuthAttempter

Class Inheritance

extends Object

java.lang.Object
io.undertow.security.impl.SecurityContextImpl.AuthAttempter

Field Summary

Modifier and Type	Field and Description
private SecurityContextImpl.Node<AuthenticationMechanism>	currentMethod
private final HttpServerExchange	exchange

Constructor Summary

Access	Constructor and Description
private	AuthAttempter(SecurityContextImpl.Node<AuthenticationMechanism> currentMethod, final HttpServerExchange exchange)

Method Summary

Modifier and Type	Method and Description
private SecurityContextImpl.AuthenticationState	transition()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

currentMethod	back to summary
private SecurityContextImpl.Node<AuthenticationMechanism> currentMethod

exchange	back to summary
private final HttpServerExchange exchange

Constructor Detail

AuthAttempter	back to summary
private AuthAttempter(SecurityContextImpl.Node<AuthenticationMechanism> currentMethod, final HttpServerExchange exchange)

Method Detail

transition	back to summary
private SecurityContextImpl.AuthenticationState transition()

Field Summary

Modifier and Type	Field and Description
public static final SecurityContextImpl.AuthenticationState	ATTEMPTED
public static final SecurityContextImpl.AuthenticationState	AUTHENTICATED
public static final SecurityContextImpl.AuthenticationState	CHALLENGE_SENT
public static final SecurityContextImpl.AuthenticationState	NOT_ATTEMPTED

Constructor Summary

Access	Constructor and Description
private	AuthenticationState()

Modifier and Type	Method and Description
public static SecurityContextImpl.AuthenticationState	valueOf(String name)
public static SecurityContextImpl.AuthenticationState[]	values()

Field Detail

ATTEMPTED	back to summary
public static final SecurityContextImpl.AuthenticationState ATTEMPTED

AUTHENTICATED	back to summary
public static final SecurityContextImpl.AuthenticationState AUTHENTICATED

CHALLENGE_SENT	back to summary
public static final SecurityContextImpl.AuthenticationState CHALLENGE_SENT

NOT_ATTEMPTED	back to summary
public static final SecurityContextImpl.AuthenticationState NOT_ATTEMPTED

Constructor Detail

AuthenticationState	back to summary
private AuthenticationState()

Method Detail

valueOf	back to summary
public static SecurityContextImpl.AuthenticationState valueOf(String name)

values	back to summary
public static SecurityContextImpl.AuthenticationState[] values()

io.undertow.security.impl back to summary

private Class SecurityContextImpl.ChallengeSender

Class Inheritance

extends Object

java.lang.Object
io.undertow.security.impl.SecurityContextImpl.ChallengeSender

Class responsible for sending the authentication challenges.

Field Summary

Modifier and Type	Field and Description
private boolean	challengeSent
private Integer	chosenStatusCode
private SecurityContextImpl.Node<AuthenticationMechanism>	currentMethod
private final HttpServerExchange	exchange

Constructor Summary

Access	Constructor and Description
private	ChallengeSender(SecurityContextImpl.Node<AuthenticationMechanism> currentMethod, final HttpServerExchange exchange)

Method Summary

Modifier and Type	Method and Description
private SecurityContextImpl.AuthenticationState	transition()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

challengeSent	back to summary
private boolean challengeSent

chosenStatusCode	back to summary
private Integer chosenStatusCode

currentMethod	back to summary
private SecurityContextImpl.Node<AuthenticationMechanism> currentMethod

exchange	back to summary
private final HttpServerExchange exchange

Constructor Detail

ChallengeSender	back to summary
private ChallengeSender(SecurityContextImpl.Node<AuthenticationMechanism> currentMethod, final HttpServerExchange exchange)

Method Detail

transition	back to summary
private SecurityContextImpl.AuthenticationState transition()

io.undertow.security.impl back to summary

private final Class SecurityContextImpl.Node<T>

Class Inheritance

extends Object

java.lang.Object
io.undertow.security.impl.SecurityContextImpl.Node

To reduce allocations we use a custom linked list data structure

Field Summary

Modifier and Type	Field and Description
pack-priv final T	item
pack-priv SecurityContextImpl.Node<T>	next

Constructor Summary

Access	Constructor and Description
private	Node(T item)

Method Summary

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

item	back to summary
pack-priv final T item

next	back to summary
pack-priv SecurityContextImpl.Node<T> next

Constructor Detail

Node	back to summary
private Node(T item)

public Class SecurityContextImpl

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class SecurityContextImpl.AuthAttempter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv final Enum SecurityContextImpl.AuthenticationState

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class SecurityContextImpl.ChallengeSender

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class SecurityContextImpl.Node<T>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail