Class PermissionsMiddleware

java.lang.Object

com.github.kaktushose.jda.commands.dispatching.middleware.impl.PermissionsMiddleware

All Implemented Interfaces:

Middleware, Consumer<InvocationContext<?>>

public class PermissionsMiddleware
extends Object
implements Middleware

A Middleware implementation that will check permissions. The default implementation can only handle discord permissions. However, the PermissionsProvider can be used for own implementations. This filter will first check against PermissionsProvider.hasPermission(User,InvocationContext) with a User object. This can be used for global permissions. Afterward PermissionsProvider.hasPermission(User,InvocationContext) will be called. Since the Member is available this might be used for guild related permissions.

See Also:

• Permissions
• PermissionsProvider

Constructor Summary

Constructors

Constructor	Description
PermissionsMiddleware(PermissionsProvider permissionsProvider, ErrorMessageFactory errorMessageFactory)

Method Summary

Modifier and Type	Method	Description
void	accept(@NotNull InvocationContext<?> context)	Checks if the User and respectively the Member has the permission to execute the command.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.function.Consumer

andThen

Constructor Details

PermissionsMiddleware

public PermissionsMiddleware(PermissionsProvider permissionsProvider,
 ErrorMessageFactory errorMessageFactory)

Method Details

accept

public void accept(@NotNull
 @NotNull InvocationContext<?> context)

Checks if the User and respectively the Member has the permission to execute the command.

Specified by:

accept in interface Consumer<InvocationContext<?>>

Specified by:

accept in interface Middleware

Parameters:

context - the InvocationContext to filter