Package io.bdeploy.common.security

Class ApiAccessToken

java.lang.Object

io.bdeploy.common.security.ApiAccessToken

public class ApiAccessToken
extends Object

Represents a secure access token. Whoever has a correctly signed token of this type has access to the remote API.

A token may be weak, in which case it allows access only to endpoints which allow weak tokens explicitly.

This mechanism is used to provide tokens which are allowed solely for automated applications like the client launcher, so it can fetch updates and applications.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ApiAccessToken.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final ScopedPermission	ADMIN_PERMISSION
static final String	SYSTEM_USER

Constructor Summary

Constructors

Constructor	Description
ApiAccessToken()

Method Summary

Modifier and Type	Method	Description
String	getIssuedTo()
Collection<ScopedPermission>	getPermissions()
boolean	isSystem()
boolean	isValid()
boolean	isWeak()

Methods inherited from class java.lang.Object

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

Field Details

SYSTEM_USER

public static final String SYSTEM_USER

See Also:

• Constant Field Values

ADMIN_PERMISSION

public static final ScopedPermission ADMIN_PERMISSION

Constructor Details

ApiAccessToken

public ApiAccessToken()

Method Details

getIssuedTo

public String getIssuedTo()

isValid

public boolean isValid()

isWeak

public boolean isWeak()

isSystem

public boolean isSystem()

getPermissions

public Collection<ScopedPermission> getPermissions()