com.hivemq.spi.callback.webui

Interface WebUIAuthenticationCallback

All Superinterfaces:

Callback, SynchronousCallback

public interface WebUIAuthenticationCallback
extends SynchronousCallback

This callback is called, when a web ui user is trying to log in. Use the CallbackRegistry.addCallback(Callback) method to add a WebUIAuthenticationCallback to HiveMQ. If multiple callbacks are registered, only the one with the highest priority is used. If no callback is registered, the credentials are validated against HiveMQ's config.xml

Since:

3.4.2

Author:

Florian Limpöck

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	WebUIAuthenticationCallback.AuthenticationState

Method Summary

Methods

Modifier and Type	Method and Description
WebUIAuthenticationCallback.AuthenticationState	checkCredentials(String username, String password) Checks the credentials for a WebUI login.

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

priority

Method Detail

checkCredentials

@NotNull
WebUIAuthenticationCallback.AuthenticationState checkCredentials(@NotNull
                                                                       String username,
                                                                       @NotNull
                                                                       String password)

Checks the credentials for a WebUI login. return WebUIAuthenticationCallback.AuthenticationState.SUCCESS when the authentication with the credentials was successful, WebUIAuthenticationCallback.AuthenticationState.FAILED otherwise.

Parameters:

username - the username to check

password - the password to check