Package com.flowable.idm.engine.impl

Class AccessTokenBuilderImpl

java.lang.Object

com.flowable.idm.engine.impl.AccessTokenBuilderImpl

All Implemented Interfaces:

AccessTokenBuilder, Command<NewAccessToken>

public class AccessTokenBuilderImpl
extends Object
implements AccessTokenBuilder, Command<NewAccessToken>

Author:

Filip Hrisafov

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	AccessTokenBuilderImpl.GeneratedToken

Field Summary

Fields

Modifier and Type	Field	Description
protected final CommandExecutor	commandExecutor
protected String	description
protected String	name
protected String	tenantId
protected String	userId
protected Duration	validFor
protected Instant	validUntil

Constructor Summary

Constructors

Constructor	Description
AccessTokenBuilderImpl(CommandExecutor commandExecutor)

Method Summary

Modifier and Type	Method	Description
NewAccessToken	create()	Create the token.
AccessTokenBuilder	description(String description)	The optional description that should be used for the token.
NewAccessToken	execute(CommandContext commandContext)
AccessTokenBuilder	name(String name)	The name that should be used for the token.
AccessTokenBuilder	tenantId(String tenantId)	The id of the tenant to which the token belongs.
AccessTokenBuilder	userId(String userId)	The id of the user to which the token belongs.
AccessTokenBuilder	validFor(Duration validityDuration)	The duration for which the token is valid.
AccessTokenBuilder	validUntil(Instant validUntil)	Until when the token is valid.

Methods inherited from class java.lang.Object

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

Field Details

commandExecutor

protected final CommandExecutor commandExecutor

userId

protected String userId

tenantId

protected String tenantId

name

protected String name

description

protected String description

validFor

protected Duration validFor

validUntil

protected Instant validUntil

Constructor Details

AccessTokenBuilderImpl

public AccessTokenBuilderImpl(CommandExecutor commandExecutor)

Method Details

userId

public AccessTokenBuilder userId(String userId)

Description copied from interface: AccessTokenBuilder

The id of the user to which the token belongs. This can be any user which isn't part of the Identity Service.

Specified by:

userId in interface AccessTokenBuilder

Parameters:

userId - the id of the user

tenantId

public AccessTokenBuilder tenantId(String tenantId)

Description copied from interface: AccessTokenBuilder

The id of the tenant to which the token belongs.

Specified by:

tenantId in interface AccessTokenBuilder

Parameters:

tenantId - the id of the user

name

public AccessTokenBuilder name(String name)

Description copied from interface: AccessTokenBuilder

The name that should be used for the token.

Specified by:

name in interface AccessTokenBuilder

Parameters:

name - the name for the token

description

public AccessTokenBuilder description(String description)

Description copied from interface: AccessTokenBuilder

The optional description that should be used for the token.

Specified by:

description in interface AccessTokenBuilder

Parameters:

description - the description for the token

validFor

public AccessTokenBuilder validFor(Duration validityDuration)

Description copied from interface: AccessTokenBuilder

The duration for which the token is valid. It must be a positive duration. This is mutually exclusive with AccessTokenBuilder.validUntil(Instant).

Specified by:

validFor in interface AccessTokenBuilder

Parameters:

validityDuration - the positive duration

validUntil

public AccessTokenBuilder validUntil(Instant validUntil)

Description copied from interface: AccessTokenBuilder

Until when the token is valid. This is mutually exclusive with AccessTokenBuilder.validFor(Duration).

Specified by:

validUntil in interface AccessTokenBuilder

Parameters:

validUntil - the date until the token is valid

create

public NewAccessToken create()

Description copied from interface: AccessTokenBuilder

Create the token. The user visible value of the token should be retrieved through NewAccessToken.getPlainTextValue().

Specified by:

create in interface AccessTokenBuilder

Returns:

the created token

execute

public NewAccessToken execute(CommandContext commandContext)

Specified by:

execute in interface Command<NewAccessToken>