net.leanix.dropkit.oauth.models

Interface Principal

All Superinterfaces:

Principal

public interface Principal
extends Principal

Interface to identify an authenticated user.

Method Summary

Modifier and Type	Method and Description
String	getAccessToken()
Account	getAccount() Returns the account (=company).
UUID	getId() Returns the UUID string representation for regular users or a resource server key or a client key.
String	getName()
Permission	getPermission() Returns the permission for the active workspace
UserRole	getRole() Returns the role of the user in his company.
UserStatus	getStatus() Return the status of the user.
String	getUsername() Returns the username.
boolean	hasPermission(UUID workspaceId)
boolean	hasPermission(UUID workspaceId, PermissionRole role) Convenience method to check is user has permission with given role
boolean	isActive(UserRole role) Convenience method to check if user is active and has the given role.

Methods inherited from interface java.security.Principal

equals, hashCode, implies, toString

Method Detail

getId

UUID getId()

Returns the UUID string representation for regular users or a resource server key or a client key.

Returns:

getUsername

String getUsername()

Returns the username.

Returns:

getAccount

Account getAccount()

Returns the account (=company).

Returns:

getRole

UserRole getRole()

Returns the role of the user in his company.

Returns:

getStatus

UserStatus getStatus()

Return the status of the user.

Returns:

isActive

boolean isActive(UserRole role)

Convenience method to check if user is active and has the given role.

Parameters:

role -

Returns:

getPermission

Permission getPermission()

Returns the permission for the active workspace

Returns:

hasPermission

boolean hasPermission(UUID workspaceId,
                      PermissionRole role)

Convenience method to check is user has permission with given role

Parameters:

role -

Returns:

hasPermission

boolean hasPermission(UUID workspaceId)

getAccessToken

String getAccessToken()

getName

String getName()

Specified by:

getName in interface Principal