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

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 default AuthStatus	Returns: An AuthStatus instance that represents the result of the authentication secureResponse(MessageInfo The associated request and response messageInfo, Subject The subject that represents the source of the response serviceSubject) Secure (authenticate) the response.
public AuthStatus	Returns: An AuthStatus instance that represents the result of the validation 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) Validate the request.

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

secureResponse	back to summary
public default AuthStatus secureResponse(MessageInfo messageInfo, Subject serviceSubject) throws AuthException 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 Exceptions AuthException: If the a failure occurred in a manner that prevented the failure from being communicated via messageInfo

secureResponse

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

Secure (authenticate) the response.

Parameters

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

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

validateRequest	back to summary
public AuthStatus validateRequest(MessageInfo messageInfo, Subject clientSubject, Subject serviceSubject) throws AuthException 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 Exceptions AuthException: If the a failure occurred in a manner that prevented the failure from being communicated via messageInfo

validateRequest

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

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

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