com.hivemq.spi.callback.security

Interface OnAuthorizationCallback

All Superinterfaces:

Callback, SynchronousCallback

public interface OnAuthorizationCallback
extends SynchronousCallback

This callback returns a list of MqttTopicPermissions.

When more OnAuthorizationCallbacks are added only one must return a permission, which matches the required permission to successfully authorize the client action.

It is highly recommended to use proper caching as this callback is called every time HiveMQ asks for the client permissions.

Since:

1.4

Author:

Christian Goetz, Christoph Schäbel

Method Summary

Methods

Modifier and Type	Method and Description
AuthorizationBehaviour	getDefaultBehaviour() Declares the default behaviour to use if none of the MqttTopicPermissions returned by getPermissionForClient matches an activity.
List<MqttTopicPermission>	getPermissionsForClient(ClientData clientData) Returns a list of MqttTopicPermissions for this client.

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

priority

Method Detail

getPermissionsForClient

List<MqttTopicPermission> getPermissionsForClient(ClientData clientData)

Returns a list of MqttTopicPermissions for this client.

Make sure you use proper caching of the returned values as this method will be called very often

Parameters:

clientData - information about the client

Returns:

a list of MqttTopicPermissions for the given client

getDefaultBehaviour

AuthorizationBehaviour getDefaultBehaviour()

Declares the default behaviour to use if none of the MqttTopicPermissions returned by getPermissionForClient matches an activity. The default behaviour should be AuthorizationBehaviour.NEXT in most cases.

Returns:

the default behaviour to use if none of the MqttTopicPermissions matches an activity.