Package com.hivemq.extension.sdk.api.packets.auth

Interface ModifiableDefaultPermissions

public interface ModifiableDefaultPermissions

Default permissions enable the authorization of PUBLISH/Subscriptions if no Authorizer is used.

The default permissions can be different for each client.

Since:

4.0.0, CE 2019.1

Method Summary

Modifier and Type	Method	Description
void	add(@NotNull TopicPermission permission)	Adds a TopicPermission to the default permissions for this client.
void	addAll(@NotNull Collection<? extends TopicPermission> permissions)	Adds all passed TopicPermissions to the default permissions for this client.
@Immutable @NotNull List<@NotNull TopicPermission>	asList()	All default permissions for this client.
void	clear()	Removes all TopicPermission for this client.
@NotNull DefaultAuthorizationBehaviour	getDefaultBehaviour()	The default behaviour that is used when none of the default permissions matches a PUBLISH topic or a topic filter from a Subscription.
void	remove(@NotNull TopicPermission permission)	Removes a specific TopicPermission from the default permission for this client.
void	setDefaultBehaviour(@NotNull DefaultAuthorizationBehaviour defaultBehaviour)	Overrides the default behaviour that is used when none of the default permissions matches a PUBLISH topic or a topic filter from a Subscription.

Method Details

asList

@Immutable @NotNull @Immutable @NotNull List<@NotNull TopicPermission> asList()

All default permissions for this client.

Returns:

An immutable List with all default permissions for this client.

Since:

4.0.0, CE 2019.1

add

void add(@NotNull TopicPermission permission)

Adds a TopicPermission to the default permissions for this client.

Parameters:

permission - The TopicPermission to add.

Throws:

DoNotImplementException - If TopicPermission is implemented by the extension and not created by Builders.topicPermission().

Since:

4.0.0, CE 2019.1

addAll

void addAll(@NotNull Collection<? extends TopicPermission> permissions)

Adds all passed TopicPermissions to the default permissions for this client.

Parameters:

permissions - A Collection of TopicPermissions to add.

Throws:

NullPointerException - If permissions is null.

DoNotImplementException - If TopicPermission is implemented by the extension and not created by Builders.topicPermission().

Since:

4.0.0, CE 2019.1

remove

void remove(@NotNull TopicPermission permission)

Removes a specific TopicPermission from the default permission for this client.

Parameters:

permission - The TopicPermission to remove.

Throws:

DoNotImplementException - If TopicPermission is implemented by the extension and not created by Builders.topicPermission().

Since:

4.0.0, CE 2019.1

clear

void clear()

Removes all TopicPermission for this client.

Since:

4.0.0, CE 2019.1

getDefaultBehaviour

@NotNull @NotNull DefaultAuthorizationBehaviour getDefaultBehaviour()

The default behaviour that is used when none of the default permissions matches a PUBLISH topic or a topic filter from a Subscription.

Returns:

The current DefaultAuthorizationBehaviour.

Since:

4.0.0, CE 2019.1

setDefaultBehaviour

void setDefaultBehaviour(@NotNull DefaultAuthorizationBehaviour defaultBehaviour)

Overrides the default behaviour that is used when none of the default permissions matches a PUBLISH topic or a topic filter from a Subscription.

Defaults to DefaultAuthorizationBehaviour.ALLOW if no permissions are added, defaults to DefaultAuthorizationBehaviour.DENY if permissions are added.

If the value is overridden with this method, the value does not change automatically on add(TopicPermission) or addAll(Collection).

Parameters:

defaultBehaviour - The default behaviour to use.

Since:

4.0.0, CE 2019.1