Class JoinPermissionProvider

java.lang.Object

com.hypixel.hytale.server.core.modules.accesscontrol.provider.JoinPermissionProvider

All Implemented Interfaces:

AccessProvider

public class JoinPermissionProvider
extends Object
implements AccessProvider

Refuses a player who does not hold HytalePermissions.SERVER_JOIN while the server requires it, which is what the whitelist of a server is.

The permission belongs to no group, so a server that turns the requirement on refuses everyone until it grants it. An operator keeps their way in, because the admin group holds every permission.

Constructor Summary

Constructors

Constructor	Description
JoinPermissionProvider()

Method Summary

Modifier and Type	Method	Description
CompletableFuture<Optional<Message>>	getDisconnectReason(UUID uuid)	Returns an Optional of type Message that provides a disconnect reason.

Methods inherited from class Object

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

Constructor Details

JoinPermissionProvider

public JoinPermissionProvider()

Method Details

getDisconnectReason

@Nonnull
public CompletableFuture<Optional<Message>> getDisconnectReason(@Nonnull
 UUID uuid)

Description copied from interface: AccessProvider

Returns an Optional of type Message that provides a disconnect reason.

If the Optional contains a Message, the connection will be terminated with that message as the reason. An empty Optional will be ignored and the connection proceeds.

Specified by:

getDisconnectReason in interface AccessProvider

Parameters:

uuid - The UUID of the player to check.

Returns:

the disconnect reason, Optional.empty() for no reason.