Package io.openems.backend.common.metadata

Class User

java.lang.Object

io.openems.common.session.AbstractUser

io.openems.backend.common.metadata.User

Direct Known Subclasses:

MyUser

public class User
extends AbstractUser

A User used by OpenEMS Backend.

Constructor Summary

Constructors

Constructor	Description
User(String id, String name, String token, Language language, Role globalRole)
User(String id, String name, String token, Language language, Role globalRole, NavigableMap<String,Role> roles)

Method Summary

Modifier and Type	Method	Description
Role	assertEdgeRoleIsAtLeast(String resource, String edgeId, Role role)	Throws an exception if the current Role is equal or more privileged than the given Role.
static List<GetEdgesResponse.EdgeMetadata>	generateEdgeMetadatas(User user, Metadata metadataService)	Gets the Metadata information of the accessible Edges.
String	getToken()	Gets the login token.

Methods inherited from class io.openems.common.session.AbstractUser

getEdgeRoles, getGlobalRole, getId, getLanguage, getName, getRole, setLanguage, setRole

Methods inherited from class java.lang.Object

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

Constructor Details

User

public User(String id,
 String name,
 String token,
 Language language,
 Role globalRole)

User

public User(String id,
 String name,
 String token,
 Language language,
 Role globalRole,
 NavigableMap<String,Role> roles)

Method Details

getToken

public String getToken()

Gets the login token.

Returns:

the token

assertEdgeRoleIsAtLeast

public Role assertEdgeRoleIsAtLeast(String resource,
 String edgeId,
 Role role)
                             throws OpenemsError.OpenemsNamedException

Throws an exception if the current Role is equal or more privileged than the given Role.

Parameters:

resource - a resource identifier; used for the exception

edgeId - the Edge-ID

role - the compared Role

Returns:

the current Role

Throws:

OpenemsError.OpenemsNamedException - if the current Role privileges are less

generateEdgeMetadatas

public static List<GetEdgesResponse.EdgeMetadata> generateEdgeMetadatas(User user,
 Metadata metadataService)

Gets the Metadata information of the accessible Edges.

Parameters:

user - the User

metadataService - a Metadata provider

Returns:

a list of GetEdgesResponse.EdgeMetadata