Package eu.cloudnetservice.driver.permission

Class PermissionUser

java.lang.Object

eu.cloudnetservice.driver.permission.AbstractPermissible

eu.cloudnetservice.driver.permission.PermissionUser

All Implemented Interfaces:

eu.cloudnetservice.common.Named, DefaultedDocPropertyHolder, DocPropertyHolder, Permissible, Comparable<Permissible>

public class PermissionUser
extends AbstractPermissible

The permission user extends the permissible in that way that it has its own personal permissions. A permission user can belong to several permission groups and inherits the permissions of those groups.

Since:

4.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	PermissionUser.Builder	A builder for permission users.

Nested classes/interfaces inherited from interface eu.cloudnetservice.driver.document.property.DefaultedDocPropertyHolder

DefaultedDocPropertyHolder.Mutable<S extends DocPropertyHolder.Mutable<S>>

Nested classes/interfaces inherited from interface eu.cloudnetservice.driver.document.property.DocPropertyHolder

DocPropertyHolder.Mutable<S extends DocPropertyHolder.Mutable<S>>

Field Summary

Fields

Modifier and Type	Field	Description
private final Set<PermissionUserGroupInfo>	groups
private final String	hashedPassword
private final UUID	uniqueId

Fields inherited from class eu.cloudnetservice.driver.permission.AbstractPermissible

createdTime, groupPermissions, name, permissions, potency, properties

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PermissionUser(@NonNull UUID uniqueId, @Nullable String hashedPassword, @NonNull Set<PermissionUserGroupInfo> groups, @NonNull String name, int potency, long createdTime, @NonNull Set<Permission> permissions, @NonNull Map<String,Set<Permission>> groupPermissions, @NonNull Document properties)	Constructs a new permission group.

Method Summary

Modifier and Type	Method	Description
@NonNull PermissionUser	addGroup(@NonNull PermissionUserGroupInfo groupInfo)	Adds the given group user info to this permission user.
@NonNull PermissionUser	addGroup(@NonNull String group)	Adds the given group without any time-out to this permission user.
@NonNull PermissionUser	addGroup(@NonNull String group, long timeOutMillis)	Adds the given group with the given time-out to this permission user.
static @NonNull PermissionUser.Builder	builder()	Creates a new permission user builder instance with all default values.
static @NonNull PermissionUser.Builder	builder(@NonNull PermissionUser user)	Creates a new permission user builder instance and copies all values from the given permission user.
boolean	checkPassword(@Nullable String password)	Checks if the given password matches the stored password.
@Nullable PermissionUserGroupInfo	findAssignedGroup(@NonNull String group)	Searches for any of the users groups with the given name.
@NonNull Collection<String>	groupNames()	Gets the name of all groups the user is in.
@NonNull Collection<PermissionUserGroupInfo>	groups()	Gets all groups that the user belongs to.
@Nullable String	hashedPassword()	Gets the password of the user hashed with sha 256.
boolean	inGroup(@NonNull String group)	Checks if the user is in a permission group that has the given name.
boolean	removeGroup(@NonNull String group)	Removes every group that has the given name.
@NonNull UUID	uniqueId()	Gets the unique id of the permission user.

Methods inherited from class eu.cloudnetservice.driver.permission.AbstractPermissible

addPermission, addPermission, creationTime, groupPermissions, name, permissions, potency, propertyHolder, removePermission, removePermission

Methods inherited from class java.lang.Object

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

Methods inherited from interface eu.cloudnetservice.driver.document.property.DefaultedDocPropertyHolder

propertyAbsent, propertyPresent, readProperty, readPropertyOrDefault, readPropertyOrGet, readPropertyOrThrow, readPropertyOrThrow

Methods inherited from interface eu.cloudnetservice.driver.permission.Permissible

addPermission, addPermission, compareTo, findMatchingPermission, hasPermission, hasPermission, hasPermission, hasPermission, isPermissionSet, permission, permissionNames

Field Details

uniqueId

private final UUID uniqueId

hashedPassword

private final String hashedPassword

groups

private final Set<PermissionUserGroupInfo> groups

Constructor Details

PermissionUser

protected PermissionUser(@NonNull
 @NonNull UUID uniqueId,
 @Nullable
 @Nullable String hashedPassword,
 @NonNull
 @NonNull Set<PermissionUserGroupInfo> groups,
 @NonNull
 @NonNull String name,
 int potency,
 long createdTime,
 @NonNull
 @NonNull Set<Permission> permissions,
 @NonNull
 @NonNull Map<String,Set<Permission>> groupPermissions,
 @NonNull
 @NonNull Document properties)

Constructs a new permission group. The group is not saved or updated in any way before PermissionManagement.addPermissionUser(PermissionUser) is called.

Parameters:

uniqueId - the unique id of the user.

hashedPassword - the hashed password of the user.

groups - all groups the user is in.

name - the name of the user.

potency - the potency of the user.

createdTime - the creation timestamp.

permissions - all permissions of the user.

groupPermissions - all group specific permissions of the user.

properties - extra properties for the permission user.

Throws:

NullPointerException - if any of the given parameters except the hashed password is null.

Method Details

builder

@NonNull
public static @NonNull PermissionUser.Builder builder()

Creates a new permission user builder instance with all default values.

Returns:

the new builder instance.

builder

@NonNull
public static @NonNull PermissionUser.Builder builder(@NonNull
 @NonNull PermissionUser user)

Creates a new permission user builder instance and copies all values from the given permission user.

Parameters:

user - the group to copy from.

Returns:

the new builder instance.

Throws:

NullPointerException - if the given user is null.

checkPassword

public boolean checkPassword(@Nullable
 @Nullable String password)

Checks if the given password matches the stored password. The input is hashed using sha 256 and encoded using base64 and then compared to the stored value.

Parameters:

password - the password to compare.

Returns:

true if the password matches, false otherwise.

uniqueId

@NonNull
public @NonNull UUID uniqueId()

Gets the unique id of the permission user.

Returns:

the unique id of the user.

groups

@NonNull
public @NonNull Collection<PermissionUserGroupInfo> groups()

Gets all groups that the user belongs to.

Returns:

all groups of the user.

hashedPassword

@Nullable
public @Nullable String hashedPassword()

Gets the password of the user hashed with sha 256. If no password is set null is returned.

Returns:

the hashed password.

groupNames

@NonNull
public @NonNull Collection<String> groupNames()

Gets the name of all groups the user is in.

Returns:

the name of all groups of the user.

findAssignedGroup

@Nullable
public @Nullable PermissionUserGroupInfo findAssignedGroup(@NonNull
 @NonNull String group)

Searches for any of the users groups with the given name.

Parameters:

group - the group to search for.

Returns:

the information about the assigned group, null if not assigned to this user.

Throws:

NullPointerException - if the given group is null.

addGroup

@NonNull
public @NonNull PermissionUser addGroup(@NonNull
 @NonNull String group)

Adds the given group without any time-out to this permission user.

Note: No update is done until the user is manually updated using PermissionManagement.updateUser(PermissionUser).

Parameters:

group - the group to add to the user.

Returns:

the same user instance for chaining.

Throws:

NullPointerException - if the given group is null.

addGroup

@NonNull
public @NonNull PermissionUser addGroup(@NonNull
 @NonNull String group,
 long timeOutMillis)

Adds the given group with the given time-out to this permission user. The given time-out should be a unix timestamp in the future or any negative int if the group should not expire.

Note: No update is done until the user is manually updated using PermissionManagement.updateUser(PermissionUser).

Parameters:

group - the group to add to the user.

timeOutMillis - the timestamp for the group expiry.

Returns:

the same usr instance for chaining.

Throws:

NullPointerException - if the given group is null.

addGroup

@NonNull
public @NonNull PermissionUser addGroup(@NonNull
 @NonNull PermissionUserGroupInfo groupInfo)

Adds the given group user info to this permission user. Other groups with the same name are replaced by the given group info.

Note: No update is done until the user is manually updated using PermissionManagement.updateUser(PermissionUser).

Parameters:

groupInfo - the group info of the new group for the user.

Returns:

the same user instance for chaining.

Throws:

NullPointerException - if the given group is null.

removeGroup

public boolean removeGroup(@NonNull
 @NonNull String group)

Removes every group that has the given name.

Note: No update is done until the user is manually updated using PermissionManagement.updateUser(PermissionUser).

Parameters:

group - the group to remove.

Returns:

true if any group was removed, false otherwise.

Throws:

NullPointerException - if the given group is null.

inGroup

public boolean inGroup(@NonNull
 @NonNull String group)

Checks if the user is in a permission group that has the given name.

Parameters:

group - the group to check if the user is in.

Returns:

true if the user is in any group with the given name, false otherwise.

Throws:

NullPointerException - if the given group is null.