Class UserIdentity

java.lang.Object

de.xima.cmn.dao.model.AEntity<Long>

de.xima.fc.entities.AbstractEntity

de.xima.fc.entities.AbstractLockableEntity

de.xima.fc.entities.UserIdentity

All Implemented Interfaces:

de.xima.cmn.dao.interfaces.IEntity<Long>, de.xima.cmn.dao.interfaces.ILockableEntity<Long>, ILockingVersionProviding, ITransferable, ITransferableEntity, ITransferableLockableEntity, IUserIdentity, IUUIDEntity, Serializable, Comparable<de.xima.cmn.dao.interfaces.IEntity<Long>>

@Entity
public class UserIdentity
extends AbstractLockableEntity
implements IUserIdentity

User identities are the connection between SystemAuthenticators and UserProfiles. They identify profiles within a specified authenticator. UserProfile may have multiple identities.

Since:

8.0.0

Author:

XIMA Media GmbH

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ATTR_AUTHENTICATOR_TYPE
static final String	ATTR_CLIENT_AUTHENTICATOR
static final String	ATTR_CREATED_INSTANT
static final String	ATTR_IDENTIFIER
static final String	ATTR_PROFILE
static final String	ATTR_REMOVE_EXPIRE_INSTANT
static final String	ATTR_REMOVE_UUID
static final String	ATTR_SYSTEM_AUTHENTICATOR
static final String	COL_AUTHENTICATOR	Deprecated. Use COL_SYSTEM_AUTHENTICATOR_ID instead.
static final String	COL_AUTHENTICATOR_TYPE
static final String	COL_CLIENT_AUTHENTICATOR_ID
static final String	COL_CREATED_TIMESTAMP
static final String	COL_IDENTIFIER
static final String	COL_PROFILE
static final String	COL_REMOVE_EXPIRE_TIMESTAMP
static final String	COL_REMOVE_UUID
static final String	COL_SYSTEM_AUTHENTICATOR_ID

Fields inherited from class AbstractLockableEntity

COL_LOCKINGVERSION, lockingVersion

Fields inherited from class AbstractEntity

COL_ID, id

Fields inherited from interface de.xima.cmn.dao.interfaces.IEntity

ATTR_ID

Fields inherited from interface de.xima.cmn.dao.interfaces.ILockableEntity

ATTR_LOCKINGVERSION

Fields inherited from interface ITransferableEntity

IMPORT_ID, INVALID_ID

Fields inherited from interface IUUIDEntity

ATTR_UUID, COL_UUID, INVALID_UUID, INVALID_UUID_OBJECT, NULL_SAFE_UUID_TYPE, NULLABLE_UUID_TYPE, TYPE_NAME_UUID

Constructor Summary

Constructors

Constructor	Description
UserIdentity()

Method Summary

Modifier and Type	Method	Description
EAuthClientType	getAuthenticatorType()
ClientAuthenticator	getClientAuthenticator()	Deprecated. Use getClientDescriptor() and IClientDescriptor.getAuthenticator() instead.
@NotNull IClientDescriptor	getClientDescriptor()
String	getClientIdentifier()
String	getClientName()
String	getClientScope()
Instant	getCreatedInstant()
Long	getId()
String	getIdentifier()
Instant	getRemoveExpireInstant()
UUID	getRemoveUuid()
SystemAuthenticator	getSystemAuthenticator()	Deprecated. Use getClientDescriptor() and IClientDescriptor.getAuthenticator() instead.
UserProfile	getUserProfile()
String	getUUID()	Gets the UUID (universal unique identifier) that uniquely identifies this type of entity.
UUID	getUUIDObject()	Gets the UUID (universal unique identifier) that uniquely identifies this type of entity.
void	setAuthenticatorType(EAuthClientType authenticatorType)	Deprecated. Us setClientDescriptor(IClientDescriptor) instead.
void	setClientAuthenticator(ClientAuthenticator clientAuthenticator)	Deprecated. Us setClientDescriptor(IClientDescriptor) instead.
void	setClientDescriptor(IClientDescriptor clientDescriptor)
void	setCreatedInstant(Instant createdInstant)
void	setId(Long id)	!!!
void	setIdentifier(String identifier)
void	setRemoveExpireInstant(Instant removeExpireInstant)
void	setRemoveUuid(UUID removeUuid)
void	setSystemAuthenticator(SystemAuthenticator systemAuthenticator)	Deprecated. Us setClientDescriptor(IClientDescriptor) instead.
void	setUserProfile(UserProfile profile)
void	setUUID(String uuid)	Sets the UUID (universal unique identifier) that uniquely identifies this type of entity.
void	setUUIDObject(UUID uuid)

Methods inherited from class AbstractLockableEntity

entityHasChanged, getLockingVersion, setLockingVersion, toString

Methods inherited from class AbstractEntity

asIntValue, isPersisted, setId

Methods inherited from class de.xima.cmn.dao.model.AEntity

compareTo, equals, getDBTableName, hashCode

Methods inherited from class Object

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

Methods inherited from interface Comparable

compareTo

Methods inherited from interface de.xima.cmn.dao.interfaces.IEntity

isPersisted

Field Details

COL_IDENTIFIER

public static final String COL_IDENTIFIER

See Also:

• Constant Field Values

COL_AUTHENTICATOR_TYPE

public static final String COL_AUTHENTICATOR_TYPE

See Also:

• Constant Field Values

COL_SYSTEM_AUTHENTICATOR_ID

public static final String COL_SYSTEM_AUTHENTICATOR_ID

See Also:

• Constant Field Values

COL_CLIENT_AUTHENTICATOR_ID

public static final String COL_CLIENT_AUTHENTICATOR_ID

See Also:

• Constant Field Values

COL_PROFILE

public static final String COL_PROFILE

See Also:

• Constant Field Values

COL_REMOVE_UUID

public static final String COL_REMOVE_UUID

See Also:

• Constant Field Values

COL_REMOVE_EXPIRE_TIMESTAMP

public static final String COL_REMOVE_EXPIRE_TIMESTAMP

See Also:

• Constant Field Values

COL_CREATED_TIMESTAMP

public static final String COL_CREATED_TIMESTAMP

See Also:

• Constant Field Values

ATTR_IDENTIFIER

public static final String ATTR_IDENTIFIER

See Also:

• Constant Field Values

ATTR_AUTHENTICATOR_TYPE

public static final String ATTR_AUTHENTICATOR_TYPE

See Also:

• Constant Field Values

ATTR_SYSTEM_AUTHENTICATOR

public static final String ATTR_SYSTEM_AUTHENTICATOR

See Also:

• Constant Field Values

ATTR_CLIENT_AUTHENTICATOR

public static final String ATTR_CLIENT_AUTHENTICATOR

See Also:

• Constant Field Values

ATTR_PROFILE

public static final String ATTR_PROFILE

See Also:

• Constant Field Values

ATTR_REMOVE_UUID

public static final String ATTR_REMOVE_UUID

See Also:

• Constant Field Values

ATTR_REMOVE_EXPIRE_INSTANT

public static final String ATTR_REMOVE_EXPIRE_INSTANT

See Also:

• Constant Field Values

ATTR_CREATED_INSTANT

public static final String ATTR_CREATED_INSTANT

See Also:

• Constant Field Values

COL_AUTHENTICATOR

@Deprecated
public static final String COL_AUTHENTICATOR

Deprecated.

Use COL_SYSTEM_AUTHENTICATOR_ID instead.

See Also:

• COL_SYSTEM_AUTHENTICATOR_ID
• Constant Field Values

Constructor Details

UserIdentity

public UserIdentity()

Method Details

getId

public Long getId()

Specified by:

getId in interface de.xima.cmn.dao.interfaces.IEntity<Long>

setId

public void setId(Long id)

Description copied from class: AbstractEntity

!!!WARNING: Currently values bigger Integer.MAX_VALUE or lower then Integer.MIN_VALUE will be altered to null!!!

Specified by:

setId in interface de.xima.cmn.dao.interfaces.IEntity<Long>

Overrides:

setId in class AbstractEntity

Parameters:

id - Long the database-id to set

getUUID

public String getUUID()

Description copied from interface: IUUIDEntity

Gets the UUID (universal unique identifier) that uniquely identifies this type of entity. Whether the UUID must be globally unique or only with within a context depends on the type of entity. Common contexts are for example client scopes or project scope.

Specified by:

getUUID in interface IUUIDEntity

Returns:

The UUID of the entity.

setUUID

public void setUUID(String uuid)

Description copied from interface: IUUIDEntity

Sets the UUID (universal unique identifier) that uniquely identifies this type of entity. Whether the UUID must be globally unique or only with within a context depends on the type of entity. Common contexts are for example client scopes or project scope.

Specified by:

setUUID in interface IUUIDEntity

Parameters:

uuid - The UUID of the entity.

getUUIDObject

public UUID getUUIDObject()

Description copied from interface: IUUIDEntity

Gets the UUID (universal unique identifier) that uniquely identifies this type of entity. Whether the UUID must be globally unique or only with within a context depends on the type of entity. Common contexts are for example client scopes or project scope.

Specified by:

getUUIDObject in interface IUUIDEntity

Returns:

The UUID of the entity.

setUUIDObject

public void setUUIDObject(UUID uuid)

getIdentifier

public String getIdentifier()

Specified by:

getIdentifier in interface IUserIdentity

Returns:

a string that uniquely identifies a user within the client of this user identity.

setIdentifier

public void setIdentifier(String identifier)

getAuthenticatorType

public EAuthClientType getAuthenticatorType()

getClientIdentifier

public String getClientIdentifier()

getClientScope

public String getClientScope()

getClientName

public String getClientName()

getClientDescriptor

@NotNull
public @NotNull IClientDescriptor getClientDescriptor()

Specified by:

getClientDescriptor in interface IUserIdentity

Returns:

the client descriptor that is used for signing in.

setClientDescriptor

public void setClientDescriptor(IClientDescriptor clientDescriptor)

getUserProfile

public UserProfile getUserProfile()

Specified by:

getUserProfile in interface IUserIdentity

Returns:

the user profile this identity is connected to.

setUserProfile

public void setUserProfile(UserProfile profile)

getRemoveUuid

public UUID getRemoveUuid()

setRemoveUuid

public void setRemoveUuid(UUID removeUuid)

getRemoveExpireInstant

public Instant getRemoveExpireInstant()

setRemoveExpireInstant

public void setRemoveExpireInstant(Instant removeExpireInstant)

getCreatedInstant

public Instant getCreatedInstant()

setCreatedInstant

public void setCreatedInstant(Instant createdInstant)

setAuthenticatorType

@Deprecated
public void setAuthenticatorType(EAuthClientType authenticatorType)

Deprecated.

Us setClientDescriptor(IClientDescriptor) instead.

getSystemAuthenticator

@Deprecated
public SystemAuthenticator getSystemAuthenticator()

Deprecated.

Use getClientDescriptor() and IClientDescriptor.getAuthenticator() instead.

setSystemAuthenticator

@Deprecated
public void setSystemAuthenticator(SystemAuthenticator systemAuthenticator)

Deprecated.

Us setClientDescriptor(IClientDescriptor) instead.

getClientAuthenticator

@Deprecated
public ClientAuthenticator getClientAuthenticator()

Deprecated.

Use getClientDescriptor() and IClientDescriptor.getAuthenticator() instead.

setClientAuthenticator

@Deprecated
public void setClientAuthenticator(ClientAuthenticator clientAuthenticator)

Deprecated.

Us setClientDescriptor(IClientDescriptor) instead.