Package com.baidu.bifromq.plugin.authprovider

Interface IAuthProvider

All Superinterfaces:

org.pf4j.ExtensionPoint

public interface IAuthProvider
extends org.pf4j.ExtensionPoint

Method Summary

Modifier and Type	Method	Description
CompletableFuture<MQTT3AuthResult>	auth(MQTT3AuthData authData)	Implement this method to hook authentication logic of mqtt3 client into BifroMQ.
default CompletableFuture<MQTT5AuthResult>	auth(MQTT5AuthData authData)	Implement this method to hook authentication logic of mqtt5 client into BifroMQ.
CompletableFuture<Boolean>	check(ClientInfo client, MQTTAction action)	Deprecated.
default CompletableFuture<CheckResult>	checkPermission(ClientInfo client, MQTTAction action)	Implement this method to hook action permission check logic.
default void	close()	This method will be called during broker shutdown
default CompletableFuture<MQTT5ExtendedAuthResult>	extendedAuth(MQTT5ExtendedAuthData authData)	Implement this method to hook extended authentication logic of mqtt5 client into BifroMQ.

Method Details

auth

CompletableFuture<MQTT3AuthResult> auth(MQTT3AuthData authData)

Implement this method to hook authentication logic of mqtt3 client into BifroMQ.

Parameters:

authData - the authentication data

auth

default CompletableFuture<MQTT5AuthResult> auth(MQTT5AuthData authData)

Implement this method to hook authentication logic of mqtt5 client into BifroMQ. The default implementation will delegate to the auth method of mqtt3.

Parameters:

authData - the authentication data

Returns:

the authentication result

extendedAuth

default CompletableFuture<MQTT5ExtendedAuthResult> extendedAuth(MQTT5ExtendedAuthData authData)

Implement this method to hook extended authentication logic of mqtt5 client into BifroMQ.

Parameters:

authData - the extended authentication data

Returns:

the authentication result

check

@Deprecated(since="3.0")
CompletableFuture<Boolean> check(ClientInfo client,
 MQTTAction action)

Deprecated.

Implement this method to hook action permission check logic.

Parameters:

client - the client to check permission

action - the action

Returns:

true if the client is allowed to perform the action, false otherwise

checkPermission

default CompletableFuture<CheckResult> checkPermission(ClientInfo client,
 MQTTAction action)

Implement this method to hook action permission check logic.

Parameters:

client - the client to check permission

action - the action

Returns:

CheckResult

close

default void close()

This method will be called during broker shutdown