Package de.xima.fc.dao.interfaces

Interface IClientAuthenticatorDao

All Superinterfaces:

de.xima.cmn.dao.interfaces.IAbstractDao<ClientAuthenticator,Long,IEntityContext>, IGenericDao<ClientAuthenticator>, IMandantDependentBaseDao<ClientAuthenticator>

All Known Implementing Classes:

ClientAuthenticatorDao

public interface IClientAuthenticatorDao
extends IMandantDependentBaseDao<ClientAuthenticator>

Author:

XIMA MEDIA GmbH

Method Summary

Modifier and Type	Method	Description
String	findUniqueName(IEntityContext ec, String candidate, Mandant client, ClientAuthenticator exclude)	Returns a name that is not taken by another ClientAuthenticator in the given client.
ClientAuthenticator	getByCallback(IEntityContext ec, UUID callbackUuid)	Finds the client authenticator by its callback UUID.
ClientAuthenticator	getByUuid(IEntityContext ec, Mandant client, UUID uuid)
boolean	isNameExisiting(IEntityContext ec, Mandant client, String name)	Returns whether or not the given client authenticator name exists within the gieven client.

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

all, bulkDelete, bulkUpdate, checkLockingVersion, create, create, delete, delete, deleteAll, executePagedDaoAction, getAttributes, getAttributes, getSingleAttributes, getSingleAttributes, getTransactionHandler, read, registerListener, registerListener, registerListener, resultTotalCount, setTransactionHandler, singleElement, unregisterListener, unregisterListener, unregisterListener, update, update

Methods inherited from interface de.xima.fc.dao.interfaces.IGenericDao

count, findAll, findSingle, getEntityRefs, read

Method Detail

getByUuid

@Nullable
ClientAuthenticator getByUuid(IEntityContext ec,
                              Mandant client,
                              UUID uuid)

Parameters:

ec - Current entity context for accessing the database.

client - Client where to search for the authenticator.

uuid - UUID of the authenticator to retrieve.

Returns:

The authenticator with the given UUID that belongs to the client, or null when no such authenticator exist.

getByCallback

@Nullable
ClientAuthenticator getByCallback(IEntityContext ec,
                                  UUID callbackUuid)

Finds the client authenticator by its callback UUID.

Parameters:

ec - Current entity context for accessing the database.

callbackUuid - Callback UUID of the authenticator to retrieve.

Returns:

The authenticator with the given callback UUID, or null when no such authenticator exist.

findUniqueName

String findUniqueName(IEntityContext ec,
                      String candidate,
                      Mandant client,
                      ClientAuthenticator exclude)

Returns a name that is not taken by another ClientAuthenticator in the given client. An index will be added to the candidate if necessary.

Parameters:

ec - IEntityContext to be used

candidate - String authenticator name candidate to be made unique

client - Mandant to look in for unique name

exclude - ClientAuthenticator client resource to be excluded from the search. May be null .

Returns:

unique client authenticator name within the system

Since:

8.0.0

isNameExisiting

boolean isNameExisiting(IEntityContext ec,
                        Mandant client,
                        String name)

Returns whether or not the given client authenticator name exists within the gieven client.

Parameters:

ec - IEntityContext to be used

name - String authenticator name to check

client - Mandant to look in for the name

Returns:

whether or not the given name is unique

Since:

8.0.0