com.hivemq.spi.callback.security

Interface OnAuthenticationCallback

All Superinterfaces:

Callback, SynchronousCallback

public interface OnAuthenticationCallback
extends SynchronousCallback

This callback gets called when a CONNECT message arrives and is meant to perform the authentication of a client.

When more OnAuthenticationCallbacks are added only one must return a positive result to successfully authenticate the client.

If an AuthenticationException is thrown, no additional credentials checks in other plugins are made and the client is disconnected immediately with an CONNACK with the given return code.

Note: It's your responsibility to use proper caching in the checkCredentials method

Since:

1.4

Author:

Christian Goetz

Method Summary

Methods

Modifier and Type	Method and Description
Boolean	checkCredentials(ClientCredentialsData clientData) Checks the credentials after a CONNECT message arrives.

Methods inherited from interface com.hivemq.spi.callback.SynchronousCallback

priority

Method Detail

checkCredentials

Boolean checkCredentials(ClientCredentialsData clientData)
                         throws AuthenticationException

Checks the credentials after a CONNECT message arrives.

return true when the authentication with the credentials was successful, false otherwise

Parameters:

clientData - the client credentials

Returns:

true when the authentication was successful

Throws:

AuthenticationException - when you want the client to disconnect immediately with a given return code