Package de.xima.fc.api.entity
Class UserIdentityAPI
- java.lang.Object
-
- de.xima.fc.api.ASubAPI
-
- de.xima.fc.api.entity.AEntityAPI<UserIdentity>
-
- de.xima.fc.api.entity.UserIdentityAPI
-
public class UserIdentityAPI extends AEntityAPI<UserIdentity>
API class for reading and writingUserIdentity
entities.- Since:
- 8.0.0
- Author:
- XIMA Media GmbH
-
-
Field Summary
-
Fields inherited from class de.xima.fc.api.entity.AEntityAPI
entityClass
-
-
Constructor Summary
Constructors Constructor Description UserIdentityAPI()
-
Method Summary
All Methods Instance Methods Concrete Methods 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 class de.xima.fc.api.entity.AEntityAPI
create, create, delete, delete, deleteAllBy, deleteById, deleteById, getAll, getAllBy, getAttributes, getAttributes, getBy, getById, getById, getEntityRefs, getPagedResult, getSingleAttributes, getSingleAttributes, resultTotalCount, resultTotalCount, update, update
-
Methods inherited from class de.xima.fc.api.ASubAPI
getHandlerProvider
-
-
-
-
Method Detail
-
getByCallback
@Nullable public 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 theSystemAuthenticator
orauthenticator type
and the user identity identifier.- Parameters:
uc
- User context for accessing the database.identifier
- Identifier of the user identity.clientName
- Identifies theSystemAuthenticator
or authenticator type.- Returns:
- The user identity matching the callback information.
-
getByRemovalUuid
@Nullable public 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 public 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
public 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) andfalse
otherwise.
-
-