Top Description Fields Constructors Methods
org.apache.catalina.authenticator.jaspic

public Class SimpleServerAuthContext

extends Object
implements ServerAuthContext
Class Inheritance
All Implemented Interfaces
jakarta.security.auth.message.config.ServerAuthContext, jakarta.security.auth.message.ServerAuth
Imports
java.util.List, javax.security.auth.Subject, jakarta.security.auth.message.AuthException, .AuthStatus, .MessageInfo, jakarta.security.auth.message.config.ServerAuthContext, jakarta.security.auth.message.module.ServerAuthModule
Basic implementation primarily intended for use when using third-party ServerAuthModule implementations that only provide the module. This implementation supports multiple modules and will treat the user as authenticated if any one module is able to authenticate the user.

Field Summary

Modifier and TypeField and Description
private final List<ServerAuthModule>
modules

Constructor Summary

AccessConstructor and Description
public
SimpleServerAuthContext(List<ServerAuthModule> modules)

Method Summary

Modifier and TypeMethod and Description
public void
cleanSubject(MessageInfo
The associated request and response
messageInfo, Subject
The subject to clean
subject)

Overrides default jakarta.security.auth.message.ServerAuth.cleanSubject.

Remove principals and/or credentials from the subject that were previously added by this authentication mechanism.

public AuthStatus
secureResponse(MessageInfo
The associated request and response
messageInfo, Subject
The subject that represents the source of the response
serviceSubject)

Overrides default jakarta.security.auth.message.ServerAuth.secureResponse.

Secure (authenticate) the response.

public AuthStatus
validateRequest(MessageInfo
The associated request and response
messageInfo, Subject
The subject that represents the source of the request
clientSubject, Subject
The subject that represents the recipient of the request
serviceSubject)

Implements jakarta.security.auth.message.ServerAuth.validateRequest.

Validate the request.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

modulesback to summary
private final List<ServerAuthModule> modules

Constructor Detail

SimpleServerAuthContextback to summary
public SimpleServerAuthContext(List<ServerAuthModule> modules)

Method Detail

cleanSubjectback to summary
public void cleanSubject(MessageInfo messageInfo, Subject subject) throws AuthException

Overrides default jakarta.security.auth.message.ServerAuth.cleanSubject.

Doc from jakarta.security.auth.message.ServerAuth.cleanSubject.

Remove principals and/or credentials from the subject that were previously added by this authentication mechanism.

Parameters
messageInfo:MessageInfo

The associated request and response

subject:Subject

The subject to clean

Annotations
@Override
Exceptions
AuthException:
If the a failure occurred
secureResponseback to summary
public AuthStatus secureResponse(MessageInfo messageInfo, Subject serviceSubject) throws AuthException

Overrides default jakarta.security.auth.message.ServerAuth.secureResponse.

Doc from jakarta.security.auth.message.ServerAuth.secureResponse.

Secure (authenticate) the response.

Parameters
messageInfo:MessageInfo

The associated request and response

serviceSubject:Subject

The subject that represents the source of the response

Returns:AuthStatus

An AuthStatus instance that represents the result of the authentication

Annotations
@Override
Exceptions
AuthException:
If the a failure occurred in a manner that prevented the failure from being communicated via messageInfo
validateRequestback to summary
public AuthStatus validateRequest(MessageInfo messageInfo, Subject clientSubject, Subject serviceSubject) throws AuthException

Implements jakarta.security.auth.message.ServerAuth.validateRequest.

Doc from jakarta.security.auth.message.ServerAuth.validateRequest.

Validate the request.

Parameters
messageInfo:MessageInfo

The associated request and response

clientSubject:Subject

The subject that represents the source of the request

serviceSubject:Subject

The subject that represents the recipient of the request

Returns:AuthStatus

An AuthStatus instance that represents the result of the validation

Annotations
@Override
Exceptions
AuthException:
If the a failure occurred in a manner that prevented the failure from being communicated via messageInfo