sirius.biz.jdbc.tenants

Class UserAccount

java.lang.Object

sirius.kernel.di.transformers.Composable

sirius.db.mixing.Mixable

sirius.db.mixing.BaseEntity<Long>

sirius.db.jdbc.SQLEntity

sirius.biz.jdbc.model.BizEntity

sirius.biz.jdbc.tenants.SQLTenantAware

sirius.biz.jdbc.tenants.UserAccount

All Implemented Interfaces:

Journaled, TenantAware, sirius.kernel.di.transformers.Transformable, sirius.web.security.MessageProvider

public class UserAccount
extends SQLTenantAware
implements Journaled, sirius.web.security.MessageProvider

Represents a user account which can log into the system.

Serveral users are grouped together by their company, which is referred to as Tenant.

Field Summary

Fields

Modifier and Type	Field and Description
static sirius.db.mixing.Mapping	EMAIL Contains the email address of the user.
static sirius.db.mixing.Mapping	EXTERNAL_LOGIN_REQUIRED Determines if an external login is required from time to time.
static sirius.db.mixing.Mapping	JOURNAL Used to record changes on fields of the user.
static sirius.db.mixing.Mapping	LOGIN Contains the login data used to authenticate the user.
static sirius.db.mixing.Mapping	PERMISSIONS Contains the permissions granted to the user and the custom configuration.
static sirius.db.mixing.Mapping	PERSON Contains the personal information of the user.

Fields inherited from class sirius.biz.jdbc.tenants.SQLTenantAware

TENANT

Fields inherited from class sirius.biz.jdbc.model.BizEntity

TRACE

Fields inherited from class sirius.db.jdbc.SQLEntity

fetchRow, id, ID, NON_PERSISTENT_ENTITY_ID, oma

Fields inherited from class sirius.db.mixing.BaseEntity

mixing, NEW, persistedData, version

Fields inherited from class sirius.db.mixing.Mixable

elastic, mango

Fields inherited from class sirius.kernel.di.transformers.Composable

components

Constructor Summary

Constructors

Constructor and Description
UserAccount()

Method Summary

Modifier and Type	Method and Description
void	addMessages(Consumer<sirius.web.controller.Message> messageConsumer)
String	getEmail()
JournalData	getJournal() Returns the journal of this entity.
LoginData	getLogin()
int	getMinPasswordLength() Contains the minimal length of a password to be accepted.
PermissionData	getPermissions()
PersonData	getPerson()
int	getSanePasswordLength() Contains the minimal length of a sane password.
boolean	hasName() Determines if the user has a real name.
boolean	is(Class<?> type)
boolean	isExternalLoginRequired()
boolean	isPasswordGenerationPossible() Determines if the current user is able to generate the password for this user.
protected void	onDelete()
protected void	onModify()
void	setEmail(String email)
void	setExternalLoginRequired(boolean externalLoginRequired)
boolean	shouldSendGeneratedPassword() Determines if generated passwords should be sent to this user.
String	toString()
<A> Optional<A>	tryAs(Class<A> adapterType)
protected void	verifyData()

Methods inherited from class sirius.biz.jdbc.tenants.SQLTenantAware

getTenant, getTenantAsString, setCurrentTenant

Methods inherited from class sirius.biz.jdbc.model.BizEntity

getTrace, isAnyColumnChangedExceptNoJournal

Methods inherited from class sirius.db.jdbc.SQLEntity

equals, getFetchRow, getId, getMapper, hashCode, isNew, isUnique, setId

Methods inherited from class sirius.db.mixing.BaseEntity

assertUnique, getDescriptor, getIdAsString, getTypeName, getUniqueName, getVersion, isAnyMappingChanged, isChanged, setVersion

Methods inherited from class sirius.db.mixing.Mixable

makeNewInstance

Methods inherited from class sirius.kernel.di.transformers.Composable

as, attach, attach

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface sirius.biz.web.TenantAware

assertSameTenant

Field Detail

EMAIL

public static final sirius.db.mixing.Mapping EMAIL

Contains the email address of the user.

PERSON

public static final sirius.db.mixing.Mapping PERSON

Contains the personal information of the user.

LOGIN

public static final sirius.db.mixing.Mapping LOGIN

Contains the login data used to authenticate the user.

PERMISSIONS

public static final sirius.db.mixing.Mapping PERMISSIONS

Contains the permissions granted to the user and the custom configuration.

JOURNAL

public static final sirius.db.mixing.Mapping JOURNAL

Used to record changes on fields of the user.

EXTERNAL_LOGIN_REQUIRED

public static final sirius.db.mixing.Mapping EXTERNAL_LOGIN_REQUIRED

Determines if an external login is required from time to time.

Constructor Detail

UserAccount

public UserAccount()

Method Detail

verifyData

protected void verifyData()

onModify

protected void onModify()

onDelete

protected void onDelete()

getMinPasswordLength

public int getMinPasswordLength()

Contains the minimal length of a password to be accepted.

Returns:

the minimal length of a password to be accepted

getSanePasswordLength

public int getSanePasswordLength()

Contains the minimal length of a sane password.

Returns:

the minimal length for a password to be considered sane / good / not totally unsafe

tryAs

public <A> Optional<A> tryAs(Class<A> adapterType)

Specified by:

tryAs in interface sirius.kernel.di.transformers.Transformable

Overrides:

tryAs in class sirius.db.mixing.Mixable

is

public boolean is(Class<?> type)

Specified by:

is in interface sirius.kernel.di.transformers.Transformable

Overrides:

is in class sirius.db.mixing.Mixable

toString

public String toString()

Overrides:

toString in class sirius.db.mixing.BaseEntity<Long>

hasName

public boolean hasName()

Determines if the user has a real name.

Returns:

true if a real name was provided, false otherwise

addMessages

public void addMessages(Consumer<sirius.web.controller.Message> messageConsumer)

Specified by:

addMessages in interface sirius.web.security.MessageProvider

isPasswordGenerationPossible

public boolean isPasswordGenerationPossible()

Determines if the current user is able to generate the password for this user.

Returns:

true if the current user can generate a password, false otherwise

shouldSendGeneratedPassword

public boolean shouldSendGeneratedPassword()

Determines if generated passwords should be sent to this user.

Returns:

true if generated passwords should be sent to the user, false otherwise

getPerson

public PersonData getPerson()

getLogin

public LoginData getLogin()

getPermissions

public PermissionData getPermissions()

getEmail

public String getEmail()

setEmail

public void setEmail(String email)

getJournal

public JournalData getJournal()

Description copied from interface: Journaled

Returns the journal of this entity.

Specified by:

getJournal in interface Journaled

Returns:

the journal of this entity

isExternalLoginRequired

public boolean isExternalLoginRequired()

setExternalLoginRequired

public void setExternalLoginRequired(boolean externalLoginRequired)