Skip to content

Commit

Permalink
Add overload authenticateSuccessfully of SimpleAuthOutput with parame…
Browse files Browse the repository at this point in the history
…ter to clear auth passws after authentication
  • Loading branch information
marregui committed Oct 24, 2024
1 parent 3997add commit 9ac06f7
Showing 1 changed file with 14 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,20 @@ public interface SimpleAuthOutput extends AsyncOutput<SimpleAuthOutput> {
*/
void authenticateSuccessfully();

/**
* Successfully authenticates the client.
* <p>
* A CONNACK packet with reason code {@link ConnackReasonCode#SUCCESS SUCCESS} is sent to the client.
* <p>
* This is a final decision, authenticators of the next extensions (with lower priority) are not called.
*
* @param clearPasswordAfterAuth defines if the password will be cleared after authentication. Default is false
* @throws UnsupportedOperationException When authenticateSuccessfully, failAuthentication or nextExtensionOrDefault
* has already been called.
* @since 4.30.0, CE 2019.1
*/
void authenticateSuccessfully(boolean clearPasswordAfterAuth);

/**
* Fails the authentication of the client.
* <p>
Expand Down

0 comments on commit 9ac06f7

Please sign in to comment.