net.leanix.dropkit.oauth.models

Class Permission

java.lang.Object

net.leanix.dropkit.oauth.models.Permission

All Implemented Interfaces:

Serializable

public class Permission
extends Object
implements Serializable

This class is a Data Transfer Object (DTO) representing a permission for a user to access a workspace (Defaults to active contact). In most of the cases the user is representing a persisted MTM user and the ID of the permission equals the ID from the corresponding MTM permission on the workspace. Also then the permission not only includes a workspace ID & name but also the customer roles and access control entities (ACE). The role of this permission should be one of ADMIN, MEMBER, VIEWER or CONTACT. In some cases the user may represent a SYSTEM user (e.g. one of our microservices). A permission for this user to access a workspace is generated "on the fly" and is not persisted within MTM. Therefor the permission will not have an ID, nor customer roles or access control entities. The permission will only hold a workspace ID & name. The role of this permission should be one of SYSTEM_READ, SYSTEM_WRITE or SYSTEM_AS_USER (although the other roles may still make sense). Only in case the permission has the role SYSTEM_AS_USER the property "asUser" should be set. It will then hold a user representing on of the persisted MTM users. This user again might reference a permission for which the "persisted MTM user" paragraph above applies.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Permission()

Method Summary

Modifier and Type	Method and Description
String[]	getAccessControlEntities()
User	getAsUser()
String[]	getCustomerRoles()
UUID	getId()
PermissionRole	getRole()
PermissionStatus	getStatus()
UUID	getWorkspaceId()
String	getWorkspaceName()
boolean	hasRole(PermissionRole role) Checks if the permission has the given role.
boolean	isActive()
boolean	isActive(PermissionRole role)
void	setAccessControlEntities(String[] accessControlEntities)
void	setAsUser(User asUser)
void	setCustomerRoles(String[] customerRoles)
void	setId(UUID id)
void	setRole(PermissionRole role)
void	setStatus(PermissionStatus status)
void	setWorkspaceId(UUID workspaceId)
void	setWorkspaceName(String workspaceName)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Permission

public Permission()

Method Detail

setId

public void setId(UUID id)

getId

public UUID getId()

getWorkspaceId

public UUID getWorkspaceId()

setWorkspaceId

public void setWorkspaceId(UUID workspaceId)

getWorkspaceName

public String getWorkspaceName()

setWorkspaceName

public void setWorkspaceName(String workspaceName)

getStatus

public PermissionStatus getStatus()

setStatus

public void setStatus(PermissionStatus status)

isActive

public boolean isActive()

isActive

public boolean isActive(PermissionRole role)

getRole

public PermissionRole getRole()

setRole

public void setRole(PermissionRole role)

getCustomerRoles

public String[] getCustomerRoles()

setCustomerRoles

public void setCustomerRoles(String[] customerRoles)

getAccessControlEntities

public String[] getAccessControlEntities()

setAccessControlEntities

public void setAccessControlEntities(String[] accessControlEntities)

hasRole

public boolean hasRole(PermissionRole role)

Checks if the permission has the given role.

Parameters:

role -

Returns:

getAsUser

public User getAsUser()

setAsUser

public void setAsUser(User asUser)

toString

public String toString()

Overrides:

toString in class Object