Package de.dytanic.cloudnet.driver.permission

Interface DefaultSynchronizedPermissionManagement

All Superinterfaces:

IPermissionManagement

public interface DefaultSynchronizedPermissionManagement
extends IPermissionManagement

Method Summary

Modifier and Type	Method	Description
default IPermissionGroup	addGroup(@NotNull IPermissionGroup permissionGroup)	Adds a new permission group to the list of groups.
default IPermissionGroup	addGroup(@NotNull java.lang.String role, int potency)	Adds a new permission group if it does not already exists.
default IPermissionUser	addUser(@NotNull IPermissionUser permissionUser)	Adds a new user to the database.
default IPermissionUser	addUser(@NotNull java.lang.String name, @NotNull java.lang.String password, int potency)	Adds a new permission user if it does not already exists.
default boolean	containsGroup(@NotNull java.lang.String group)	Checks if a specific group exists.
default boolean	containsUser(@NotNull java.lang.String name)	Checks if at least one user with the given name is stored in the database.
default boolean	containsUser(@NotNull java.util.UUID uniqueId)	Checks if a user with the given uniqueId is stored in the database.
default void	deleteGroup(@NotNull IPermissionGroup permissionGroup)	Deletes a group by its name out of the list of groups.
default void	deleteGroup(@NotNull java.lang.String name)	Deletes a group by its name out of the list of groups.
default boolean	deleteUser(@NotNull IPermissionUser permissionUser)	Deletes one user with the uniqueId of the given user.
default boolean	deleteUser(@NotNull java.lang.String name)	Deletes all users in the database matching the given name.
default IPermissionGroup	getDefaultPermissionGroup()	Gets the default permission group.
default IPermissionUser	getFirstUser(java.lang.String name)	Gets the first permission user with the given name.
default @Nullable IPermissionGroup	getGroup(@NotNull java.lang.String name)	Gets a specific group by its name.
default @NotNull IPermissionUser	getOrCreateUser(@NotNull java.util.UUID uniqueId, @NotNull java.lang.String name)	Gets a user with the given uniqueId out of the database or creates a new one if the database contains no such entry.
default @Nullable IPermissionUser	getUser(@NotNull java.util.UUID uniqueId)	Gets a user with the given uniqueId out of the database.
default @NotNull java.util.Collection<IPermissionUser>	getUsers()	Gets a list of all users stored in the database.
default @NotNull java.util.List<IPermissionUser>	getUsers(@NotNull java.lang.String name)	Gets a list of all users with the given name out of the database.
default java.util.Collection<IPermissionUser>	getUsersByGroup(@NotNull java.lang.String group)	Gets a list of all users stored in the database with the given group.
default IPermissionGroup	modifyGroup(@NotNull java.lang.String name, @NotNull java.util.function.Consumer<IPermissionGroup> modifier)	Gets the permission group with the given name by using IPermissionManagement.getGroup(String) and, if not null, puts it into the consumer, after that, the group will be updated by using IPermissionManagement.updateGroup(IPermissionGroup).
default IPermissionUser	modifyUser(@NotNull java.util.UUID uniqueId, @NotNull java.util.function.Consumer<IPermissionUser> modifier)	Gets the permission user with the given uniqueId by using IPermissionManagement.getUser(UUID) and, if not null, puts them into the consumer, after that, the user will be updated by using IPermissionManagement.updateUser(IPermissionUser).
default java.util.List<IPermissionUser>	modifyUsers(@NotNull java.lang.String name, @NotNull java.util.function.Consumer<IPermissionUser> modifier)	Gets every user matching the given name by using IPermissionManagement.getUsers(String) and puts them into the consumer, after that, every user will be updated by using IPermissionManagement.updateUser(IPermissionUser).
default void	setGroups(java.util.Collection<? extends IPermissionGroup> groups)	Clears all groups in the Cloud and sets given groups.
default void	setUsers(@NotNull java.util.Collection<? extends IPermissionUser> users)	Clears all users stored in the database and inserts the given list.
default void	updateGroup(@NotNull IPermissionGroup permissionGroup)	Updates a permission group in the list of groups.
default void	updateUser(@NotNull IPermissionUser permissionUser)	Updates an already existing user in the database.

Methods inherited from interface de.dytanic.cloudnet.driver.permission.IPermissionManagement

addGroupAsync, addGroupAsync, addUserAsync, addUserAsync, canBeOverwritten, containsGroupAsync, containsUserAsync, containsUserAsync, deleteGroupAsync, deleteGroupAsync, deleteUserAsync, deleteUserAsync, findHighestPermission, getAllPermissions, getAllPermissions, getChildPermissionManagement, getDefaultPermissionGroupAsync, getExtendedGroups, getFirstUserAsync, getGroupAsync, getGroups, getGroups, getGroupsAsync, getGroupsAsync, getHighestPermissionGroup, getOrCreateUserAsync, getPermissionResult, getPermissionResult, getPermissionResult, getPermissionResult, getPermissionResult, getUser, getUserAsync, getUsersAsync, getUsersAsync, getUsersByGroupAsync, hasPermission, hasPermission, hasPermission, init, modifyGroupAsync, modifyUserAsync, modifyUsersAsync, reload, setGroupsAsync, setUsersAsync, testPermissible, testPermissionGroup, testPermissionUser, updateGroupAsync, updateUserAsync

Method Detail

getFirstUser

default IPermissionUser getFirstUser(java.lang.String name)

Description copied from interface: IPermissionManagement

Gets the first permission user with the given name.

Specified by:

getFirstUser in interface IPermissionManagement

Parameters:

name - the name of the user to get.

Returns:

the first permission user or null if no user with this name exists.

getDefaultPermissionGroup

default IPermissionGroup getDefaultPermissionGroup()

Description copied from interface: IPermissionManagement

Gets the default permission group.

Specified by:

getDefaultPermissionGroup in interface IPermissionManagement

Returns:

the default permission group.

addUser

default IPermissionUser addUser(@NotNull
                                @NotNull java.lang.String name,
                                @NotNull
                                @NotNull java.lang.String password,
                                int potency)

Description copied from interface: IPermissionManagement

Adds a new permission user if it does not already exists.

Specified by:

addUser in interface IPermissionManagement

Parameters:

name - the name of the new user.

password - the password of the new user.

potency - the potency of the new user.

Returns:

the newly created permission user.

addGroup

default IPermissionGroup addGroup(@NotNull
                                  @NotNull java.lang.String role,
                                  int potency)

Description copied from interface: IPermissionManagement

Adds a new permission group if it does not already exists.

Specified by:

addGroup in interface IPermissionManagement

Parameters:

role - the case-sensitive name of the new group

potency - the potency of the new group

Returns:

the newly created permission group

addUser

default IPermissionUser addUser(@NotNull
                                @NotNull IPermissionUser permissionUser)

Description copied from interface: IPermissionManagement

Adds a new user to the database.

Specified by:

addUser in interface IPermissionManagement

Parameters:

permissionUser - the user to be added

Returns:

the new user

updateUser

default void updateUser(@NotNull
                        @NotNull IPermissionUser permissionUser)

Description copied from interface: IPermissionManagement

Updates an already existing user in the database.

Specified by:

updateUser in interface IPermissionManagement

Parameters:

permissionUser - the user to be updated

deleteUser

default boolean deleteUser(@NotNull
                           @NotNull java.lang.String name)

Description copied from interface: IPermissionManagement

Deletes all users in the database matching the given name. This method is case-sensitive.

Specified by:

deleteUser in interface IPermissionManagement

Parameters:

name - the name of the users to be deleted

deleteUser

default boolean deleteUser(@NotNull
                           @NotNull IPermissionUser permissionUser)

Description copied from interface: IPermissionManagement

Deletes one user with the uniqueId of the given user.

Specified by:

deleteUser in interface IPermissionManagement

Parameters:

permissionUser - the user to be deleted

containsUser

default boolean containsUser(@NotNull
                             @NotNull java.util.UUID uniqueId)

Description copied from interface: IPermissionManagement

Checks if a user with the given uniqueId is stored in the database.

Specified by:

containsUser in interface IPermissionManagement

Parameters:

uniqueId - the uniqueId of the user

Returns:

true if there is a user with that uniqueId, false otherwise

containsUser

default boolean containsUser(@NotNull
                             @NotNull java.lang.String name)

Description copied from interface: IPermissionManagement

Checks if at least one user with the given name is stored in the database. This method is case-sensitive.

Specified by:

containsUser in interface IPermissionManagement

Parameters:

name - the name of the user

Returns:

true if there is a user with that name, false otherwise

getUser

@Nullable
default @Nullable IPermissionUser getUser(@NotNull
                                          @NotNull java.util.UUID uniqueId)

Description copied from interface: IPermissionManagement

Gets a user with the given uniqueId out of the database.

Specified by:

getUser in interface IPermissionManagement

Parameters:

uniqueId - the uniqueId of the user

Returns:

the IPermissionUser from the database or null if there is no user with that uniqueId stored

getOrCreateUser

@NotNull
default @NotNull IPermissionUser getOrCreateUser(@NotNull
                                                 @NotNull java.util.UUID uniqueId,
                                                 @NotNull
                                                 @NotNull java.lang.String name)

Description copied from interface: IPermissionManagement

Gets a user with the given uniqueId out of the database or creates a new one if the database contains no such entry.

Specified by:

getOrCreateUser in interface IPermissionManagement

Parameters:

uniqueId - the uniqueId of the user

name - the name of the permission user

Returns:

the IPermissionUser from the database or a newly created one.

getUsers

@NotNull
default @NotNull java.util.List<IPermissionUser> getUsers(@NotNull
                                                          @NotNull java.lang.String name)

Description copied from interface: IPermissionManagement

Gets a list of all users with the given name out of the database. This can only return null when the connection to the database (or when it is executed in a Wrapper instance the connection to the cloud) times out.

Specified by:

getUsers in interface IPermissionManagement

Parameters:

name - the name of the users

Returns:

a list of all IPermissionUsers stored in the database or an empty list if there is no user with that name stored.

getUsers

@NotNull
default @NotNull java.util.Collection<IPermissionUser> getUsers()

Description copied from interface: IPermissionManagement

Gets a list of all users stored in the database. This can only return null when the connection to the database (or when it is executed in a Wrapper instance the connection to the cloud) times out.

This method shouldn't be used when there are many users stored in the database, because that takes a lot of memory.

Specified by:

getUsers in interface IPermissionManagement

Returns:

a list of all IPermissionUsers stored in the database or an empty list if there is no user with that name stored.

setUsers

default void setUsers(@NotNull
                      @NotNull java.util.Collection<? extends IPermissionUser> users)

Description copied from interface: IPermissionManagement

Clears all users stored in the database and inserts the given list.

Specified by:

setUsers in interface IPermissionManagement

Parameters:

users - the new IPermissionUsers to be stored in the database

getUsersByGroup

default java.util.Collection<IPermissionUser> getUsersByGroup(@NotNull
                                                              @NotNull java.lang.String group)

Description copied from interface: IPermissionManagement

Gets a list of all users stored in the database with the given group. This can only return null when the connection to the database (or when it is executed in a Wrapper instance the connection to the cloud) times out.

This method shouldn't be used when there are many users with that group stored in the database, because that takes a lot of memory.

Specified by:

getUsersByGroup in interface IPermissionManagement

Returns:

a list of all IPermissionUsers stored in the database or an empty list if there is no user with that name stored.

addGroup

default IPermissionGroup addGroup(@NotNull
                                  @NotNull IPermissionGroup permissionGroup)

Description copied from interface: IPermissionManagement

Adds a new permission group to the list of groups. If a group with that name already exists, it will be deleted and created again.

Specified by:

addGroup in interface IPermissionManagement

Parameters:

permissionGroup - the IPermissionGroup to be added

Returns:

the new group

updateGroup

default void updateGroup(@NotNull
                         @NotNull IPermissionGroup permissionGroup)

Description copied from interface: IPermissionManagement

Updates a permission group in the list of groups. If a group with that name doesn't exist, it will be created.

Specified by:

updateGroup in interface IPermissionManagement

Parameters:

permissionGroup - the IPermissionGroup to be updated

deleteGroup

default void deleteGroup(@NotNull
                         @NotNull java.lang.String name)

Description copied from interface: IPermissionManagement

Deletes a group by its name out of the list of groups. If a group with that name doesn't exist, nothing happens.

Specified by:

deleteGroup in interface IPermissionManagement

Parameters:

name - the case-sensitive name of the group

deleteGroup

default void deleteGroup(@NotNull
                         @NotNull IPermissionGroup permissionGroup)

Description copied from interface: IPermissionManagement

Deletes a group by its name out of the list of groups. If a group with that name doesn't exist, nothing happens.

Specified by:

deleteGroup in interface IPermissionManagement

Parameters:

permissionGroup - the IPermissionGroup to be deleted

containsGroup

default boolean containsGroup(@NotNull
                              @NotNull java.lang.String group)

Description copied from interface: IPermissionManagement

Checks if a specific group exists.

Specified by:

containsGroup in interface IPermissionManagement

Parameters:

group - the case-sensitive name of the group

Returns:

true if the group exists, false otherwise

getGroup

@Nullable
default @Nullable IPermissionGroup getGroup(@NotNull
                                            @NotNull java.lang.String name)

Description copied from interface: IPermissionManagement

Gets a specific group by its name.

Specified by:

getGroup in interface IPermissionManagement

Parameters:

name - the case-sensitive name of the group

Returns:

the IPermissionUser if it exists, null otherwise

setGroups

default void setGroups(java.util.Collection<? extends IPermissionGroup> groups)

Description copied from interface: IPermissionManagement

Clears all groups in the Cloud and sets given groups.

Specified by:

setGroups in interface IPermissionManagement

Parameters:

groups - the new groups

modifyGroup

default IPermissionGroup modifyGroup(@NotNull
                                     @NotNull java.lang.String name,
                                     @NotNull
                                     @NotNull java.util.function.Consumer<IPermissionGroup> modifier)

Description copied from interface: IPermissionManagement

Gets the permission group with the given name by using IPermissionManagement.getGroup(String) and, if not null, puts it into the consumer, after that, the group will be updated by using IPermissionManagement.updateGroup(IPermissionGroup).

Specified by:

modifyGroup in interface IPermissionManagement

Parameters:

name - the name of the group

modifier - the Consumer to modify the user

Returns:

the modified user

modifyUsers

default java.util.List<IPermissionUser> modifyUsers(@NotNull
                                                    @NotNull java.lang.String name,
                                                    @NotNull
                                                    @NotNull java.util.function.Consumer<IPermissionUser> modifier)

Description copied from interface: IPermissionManagement

Gets every user matching the given name by using IPermissionManagement.getUsers(String) and puts them into the consumer, after that, every user will be updated by using IPermissionManagement.updateUser(IPermissionUser).

Specified by:

modifyUsers in interface IPermissionManagement

Parameters:

name - the name of the users

modifier - the Consumer to modify the available users

Returns:

a list of all modified users

modifyUser

default IPermissionUser modifyUser(@NotNull
                                   @NotNull java.util.UUID uniqueId,
                                   @NotNull
                                   @NotNull java.util.function.Consumer<IPermissionUser> modifier)

Description copied from interface: IPermissionManagement

Gets the permission user with the given uniqueId by using IPermissionManagement.getUser(UUID) and, if not null, puts them into the consumer, after that, the user will be updated by using IPermissionManagement.updateUser(IPermissionUser).

Specified by:

modifyUser in interface IPermissionManagement

Parameters:

uniqueId - the uniqueId of the user

modifier - the Consumer to modify the user

Returns:

the modified user