Package dev.getelements.elements.sdk.dao

Interface UserUidDao

All Known Implementing Classes:

MongoUserUidDao

public interface UserUidDao

This is the UserUidDao which is used to manage associated unique user ids. These will represent different methods of authentication and associate them with a singular User object. All user id schemes that begin with 'dev.getelements' are reserved. Created by keithhudnall on 1/29/25.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SCHEME_EMAIL
static final String	SCHEME_NAME
static final String	SCHEME_PHONE_NUMBER

Method Summary

Modifier and Type	Method	Description
UserUid	createOrUpdateUserUid(UserUid userUid)	Attempts to create or update a new UserUid with the given userUid object.
UserUid	createUserUidStrict(UserUid userUid)	Attempts to create a new UserUid with the given userUid object.
default Optional<UserUid>	findUserUid(String id, String scheme)	Gets the user uid with the given name or id
UserUid	getUserUid(String id, String scheme)	Gets the user uid with the given name or id
Pagination<UserUid>	getUserUids(int offset, int count, String search)	Attempts to get a certain number of user uids
void	softDeleteUserUidsForUserId(User user)	This will scrub all scheme ids for all UserUids referencing the user with the given id.

Field Details

SCHEME_NAME

static final String SCHEME_NAME

See Also:

• Constant Field Values

SCHEME_EMAIL

static final String SCHEME_EMAIL

See Also:

• Constant Field Values

SCHEME_PHONE_NUMBER

static final String SCHEME_PHONE_NUMBER

See Also:

• Constant Field Values

Method Details

getUserUids

Pagination<UserUid> getUserUids(int offset,
 int count,
 String search)

Attempts to get a certain number of user uids

Parameters:

offset - - the page offset

count - - total results per page

search - - search query - valid search properties are scheme, uid, and user id

Returns:

the user uid pagination object

getUserUid

UserUid getUserUid(String id,
 String scheme)

Gets the user uid with the given name or id

Parameters:

id - - the id associated with the scheme

scheme - - the scheme name

Returns:

the user uid object

findUserUid

default Optional<UserUid> findUserUid(String id,
 String scheme)

Gets the user uid with the given name or id

Parameters:

id - - the id associated with the scheme

scheme - - the scheme name

Returns:

the user uid object

createUserUidStrict

UserUid createUserUidStrict(UserUid userUid)

Attempts to create a new UserUid with the given userUid object. Using "Strict" semantics, if the user exists then this will throw an exception.

Parameters:

userUid - - the object to create in the db

Returns:

- the resultant userUid with any modifications made as a result of the creation

createOrUpdateUserUid

UserUid createOrUpdateUserUid(UserUid userUid)

Attempts to create or update a new UserUid with the given userUid object.

Parameters:

userUid - - the object to create or update in the db

Returns:

- the resultant userUid with any modifications made as a result of the creation or update

softDeleteUserUidsForUserId

void softDeleteUserUidsForUserId(User user)

This will scrub all scheme ids for all UserUids referencing the user with the given id.

Parameters:

user - - the id of the user to search for