Package com.flowable.idm.engine.impl

Class PlatformUserBuilderImpl

java.lang.Object

com.flowable.idm.engine.impl.PlatformUserBuilderImpl

All Implemented Interfaces:

PlatformUserBuilder

public class PlatformUserBuilderImpl
extends Object
implements PlatformUserBuilder

Author:

Filip Hrisafov, Joram Barrez

Field Summary

Fields

Modifier and Type	Field	Description
protected String	avatarId
protected Map<String,Object>	customInfo
protected String	displayName
protected String	email
protected String	firstName
protected final CoreIdmEngineConfiguration	idmEngineConfiguration
protected final boolean	isUpdate
protected String	language
protected String	lastName
protected Set<String>	modifiedProperties
protected PlatformUserEntity	originalPlatformUser
protected String	password
protected PlatformUserEntity	platformUser
protected String	presence
protected String	state
protected String	subState
protected String	subType
protected String	tenantId
protected String	theme
protected String	type
protected String	userDefinitionId
protected String	userDefinitionKey
protected final String	userId

Constructor Summary

Constructors

Constructor	Description
PlatformUserBuilderImpl(CoreIdmEngineConfiguration idmEngineConfiguration, String userId, boolean isUpdate)

Method Summary

Modifier and Type	Method	Description
PlatformUserBuilder	avatarId(String avatarId)
PlatformUserBuilder	displayName(String displayName)
PlatformUserBuilder	email(String email)
protected PlatformUser	executeSave(CommandContext commandContext)
PlatformUserBuilder	firstName(String firstName)
PlatformUserEntity	getOriginalPlatformUser()
PlatformUserEntity	getPlatformUser()
protected boolean	isPropertyModified(String property)
PlatformUserBuilder	language(String language)
PlatformUserBuilder	lastName(String lastName)
PlatformUserBuilder	password(String password)
PlatformUserBuilder	presence(String presence)	Setting the presence is only possible for new users.
PlatformUser	save()	Performs the save of the user
PlatformUserBuilder	setInfo(String name, Object value)
PlatformUserBuilder	state(String state)
PlatformUserBuilder	subState(String subState)
PlatformUserBuilder	subType(String subType)
PlatformUserBuilder	tenantId(String tenantId)
PlatformUserBuilder	theme(String theme)
PlatformUserBuilder	type(String type)	Set the type of the user.
PlatformUserBuilder	userDefinitionId(String userDefinitionId)
PlatformUserBuilder	userDefinitionKey(String userDefinitionKey)

Methods inherited from class java.lang.Object

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

Field Details

idmEngineConfiguration

protected final CoreIdmEngineConfiguration idmEngineConfiguration

userId

protected final String userId

isUpdate

protected final boolean isUpdate

tenantId

protected String tenantId

userDefinitionId

protected String userDefinitionId

userDefinitionKey

protected String userDefinitionKey

type

protected String type

subType

protected String subType

presence

protected String presence

state

protected String state

subState

protected String subState

firstName

protected String firstName

lastName

protected String lastName

displayName

protected String displayName

avatarId

protected String avatarId

email

protected String email

password

protected String password

language

protected String language

theme

protected String theme

customInfo

protected Map<String,Object> customInfo

modifiedProperties

protected Set<String> modifiedProperties

originalPlatformUser

protected PlatformUserEntity originalPlatformUser

platformUser

protected PlatformUserEntity platformUser

Constructor Details

PlatformUserBuilderImpl

public PlatformUserBuilderImpl(CoreIdmEngineConfiguration idmEngineConfiguration,
 String userId,
 boolean isUpdate)

Method Details

tenantId

public PlatformUserBuilder tenantId(String tenantId)

Specified by:

tenantId in interface PlatformUserBuilder

userDefinitionId

public PlatformUserBuilder userDefinitionId(String userDefinitionId)

Specified by:

userDefinitionId in interface PlatformUserBuilder

userDefinitionKey

public PlatformUserBuilder userDefinitionKey(String userDefinitionKey)

Specified by:

userDefinitionKey in interface PlatformUserBuilder

type

public PlatformUserBuilder type(String type)

Description copied from interface: PlatformUserBuilder

Set the type of the user.

Specified by:

type in interface PlatformUserBuilder

Parameters:

type - that the user should have

See Also:

• for known types

subType

public PlatformUserBuilder subType(String subType)

Specified by:

subType in interface PlatformUserBuilder

presence

public PlatformUserBuilder presence(String presence)

Description copied from interface: PlatformUserBuilder

Setting the presence is only possible for new users. Updating a user presence should happen over PlatformIdentityService.updateUserPresence(String, String, String)

Specified by:

presence in interface PlatformUserBuilder

Parameters:

presence - that the user should have

See Also:

• for known states

state

public PlatformUserBuilder state(String state)

Specified by:

state in interface PlatformUserBuilder

subState

public PlatformUserBuilder subState(String subState)

Specified by:

subState in interface PlatformUserBuilder

firstName

public PlatformUserBuilder firstName(String firstName)

Specified by:

firstName in interface PlatformUserBuilder

lastName

public PlatformUserBuilder lastName(String lastName)

Specified by:

lastName in interface PlatformUserBuilder

displayName

public PlatformUserBuilder displayName(String displayName)

Specified by:

displayName in interface PlatformUserBuilder

avatarId

public PlatformUserBuilder avatarId(String avatarId)

Specified by:

avatarId in interface PlatformUserBuilder

email

public PlatformUserBuilder email(String email)

Specified by:

email in interface PlatformUserBuilder

password

public PlatformUserBuilder password(String password)

Specified by:

password in interface PlatformUserBuilder

language

public PlatformUserBuilder language(String language)

Specified by:

language in interface PlatformUserBuilder

theme

public PlatformUserBuilder theme(String theme)

Specified by:

theme in interface PlatformUserBuilder

setInfo

public PlatformUserBuilder setInfo(String name,
 Object value)

Specified by:

setInfo in interface PlatformUserBuilder

save

public PlatformUser save()

Description copied from interface: PlatformUserBuilder

Performs the save of the user

Specified by:

save in interface PlatformUserBuilder

Returns:

the saved PlatformUser

executeSave

protected PlatformUser executeSave(CommandContext commandContext)

isPropertyModified

protected boolean isPropertyModified(String property)

getOriginalPlatformUser

public PlatformUserEntity getOriginalPlatformUser()

getPlatformUser

public PlatformUserEntity getPlatformUser()