Tomcat 10.1.19 · jakarta.security.auth.message.ClientAuth

Method Summary

Modifier and Type	Method and Description
public default void	cleanSubject(MessageInfo The associated request and response messageInfo, Subject The subject to clean subject) Remove principals and/or credentials from the subject that were previously added by this authentication mechanism.
public AuthStatus	Returns: An AuthStatus instance that represents the result of the authentication secureRequest(MessageInfo The associated request and response messageInfo, Subject The subject that represents the source of the request clientSubject) Secure (authenticate) the request.
public default AuthStatus	Returns: An AuthStatus instance that represents the result of the validation validateResponse(MessageInfo The associated request and response messageInfo, Subject The subject that represents the recipient of the response clientSubject, Subject The subject that represents the source of the response serviceSubject) Validate a response.

cleanSubject	back to summary
public default void cleanSubject(MessageInfo messageInfo, Subject subject) throws AuthException 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 Exceptions AuthException: If the a failure occurred

cleanSubject

public default void cleanSubject(MessageInfo messageInfo, Subject subject) throws AuthException

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

Parameters

Exceptions

secureRequest	back to summary
public AuthStatus secureRequest(MessageInfo messageInfo, Subject clientSubject) throws AuthException Secure (authenticate) the request. Parameters messageInfo:MessageInfo The associated request and response clientSubject:Subject The subject that represents the source of the request Returns:AuthStatus An AuthStatus instance that represents the result of the authentication Exceptions AuthException: If the a failure occurred in a manner that prevented the failure from being communicated via messageInfo

secureRequest

public AuthStatus secureRequest(MessageInfo messageInfo, Subject clientSubject) throws AuthException

Secure (authenticate) the request.

Parameters

messageInfo:MessageInfo: The associated request and response
clientSubject:Subject: The subject that represents the source of the request

An AuthStatus instance that represents the result of the authentication

Exceptions

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

validateResponse	back to summary
public default AuthStatus validateResponse(MessageInfo messageInfo, Subject clientSubject, Subject serviceSubject) throws AuthException Validate a response. Parameters messageInfo:MessageInfo The associated request and response clientSubject:Subject The subject that represents the recipient of the response serviceSubject:Subject The subject that represents the source of the response Returns:AuthStatus An AuthStatus instance that represents the result of the validation Exceptions AuthException: If the a failure occurred in a manner that prevented the failure from being communicated via messageInfo

validateResponse

public default AuthStatus validateResponse(MessageInfo messageInfo, Subject clientSubject, Subject serviceSubject) throws AuthException

Validate a response.

Parameters

messageInfo:MessageInfo: The associated request and response
clientSubject:Subject: The subject that represents the recipient of the response
serviceSubject:Subject: The subject that represents the source of the response

An AuthStatus instance that represents the result of the validation

Exceptions

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