Package javax.security.auth.message
Interface ClientAuth
- All Known Subinterfaces:
ClientAuthContext
,ClientAuthModule
public interface ClientAuth
-
Method Summary
Modifier and TypeMethodDescriptionvoid
cleanSubject
(MessageInfo messageInfo, Subject subject) Remove principals and/or credentials from the subject that were previously added by this authentication mechanism.secureRequest
(MessageInfo messageInfo, Subject clientSubject) Secure (authenticate) the request.validateResponse
(MessageInfo messageInfo, Subject clientSubject, Subject serviceSubject) Validate a response.
-
Method Details
-
secureRequest
Secure (authenticate) the request.- Parameters:
messageInfo
- The associated request and responseclientSubject
- The subject that represents the source of the request- Returns:
- An AuthStatus instance that represents the result of the authentication
- Throws:
AuthException
- If the a failure occurred in a manner that prevented the failure from being communicated via messageInfo
-
validateResponse
AuthStatus validateResponse(MessageInfo messageInfo, Subject clientSubject, Subject serviceSubject) throws AuthException Validate a response.- Parameters:
messageInfo
- The associated request and responseclientSubject
- The subject that represents the recipient of the responseserviceSubject
- The subject that represents the source of the response- Returns:
- An AuthStatus instance that represents the result of the validation
- Throws:
AuthException
- If the a failure occurred in a manner that prevented the failure from being communicated via messageInfo
-
cleanSubject
Remove principals and/or credentials from the subject that were previously added by this authentication mechanism.- Parameters:
messageInfo
- The associated request and responsesubject
- The subject to clean- Throws:
AuthException
- If the a failure occurred
-