Package de.xima.fc.handler.interfaces.entity

Interface IUserIdentityHandler

All Superinterfaces:

IAPIHandler, IGenericHandler, Serializable

All Known Implementing Classes:

UserIdentityHandler

public interface IUserIdentityHandler
extends IGenericHandler

Handler for UserIdentity entities

Since:

8.0.0

Author:

XIMA Media GmbH

Method Summary

Modifier and Type	Method	Description
UserIdentity	getByCallback(UserContext uc, String identifier, String clientName)	Finds the user identity by the given callback information.
UserIdentity	getByRemovalUuid(UserContext uc, UUID removalUuid)	Finds the user identity with the given removal UUID.
UserIdentity	getExisting(UserContext uc, UserIdentity identity)	Gets another user identity with the same identifier information (client/identifier) if it exists.
boolean	isExisting(UserContext uc, UserIdentity identity)	Checks whether or not another user identity exists with the same identifier information (client/identifier).

Methods inherited from interface de.xima.fc.com.interfaces.IAPIHandler

getName

Methods inherited from interface de.xima.fc.handler.interfaces.entity.IGenericHandler

create, create, delete, delete, deleteBy, deleteById, deleteById, getAll, getAllBy, getAttributes, getAttributes, getBy, getById, getById, getById, getEntityRefs, getSingleAttributes, getSingleAttributes, resultTotalCount, update, update

Method Detail

getByCallback

@Nullable
UserIdentity getByCallback(UserContext uc,
                           String identifier,
                           String clientName)

Finds the user identity by the given callback information. The callback information includes the client name which identifies the SystemAuthenticator or authenticator type and the user identity identifier.

Parameters:

uc - User context for accessing the database.

identifier - Identifier of the user identity.

clientName - Identifies the SystemAuthenticator or authenticator type.

Returns:

The user identity matching the callback information.

getByRemovalUuid

@Nullable
UserIdentity getByRemovalUuid(UserContext uc,
                              UUID removalUuid)

Finds the user identity with the given removal UUID.

Parameters:

uc - User context for accessing the database.

removalUuid - of the user identity to be removed

Returns:

the user identity with the given removal UUID or null if no user identity was found for the given removal UUID.

getExisting

@Nullable
UserIdentity getExisting(UserContext uc,
                         UserIdentity identity)

Gets another user identity with the same identifier information (client/identifier) if it exists.

Parameters:

uc - User context for accessing the database.

identity - to check.

Returns:

the user identity with the same identifier information (client/identifier) if it exists and null otherwise.

isExisting

boolean isExisting(UserContext uc,
                   UserIdentity identity)

Checks whether or not another user identity exists with the same identifier information (client/identifier).

Parameters:

uc - User context for accessing the database.

identity - to check.

Returns:

true if there exists another user identity with the same identifier information (client/identifier) and false otherwise.