Package dev.getelements.elements.sdk.dao

Interface AuthSchemeDao

All Known Implementing Classes:

MongoAuthSchemeDao

public interface AuthSchemeDao

Method Summary

Modifier and Type	Method	Description
AuthScheme	createAuthScheme(AuthScheme authScheme)	Creates an AuthScheme
void	deleteAuthScheme(String authSchemeId)	Deletes the AuthScheme with the supplied auth scheme ID.
Optional<AuthScheme>	findAuthScheme(String authSchemeId)	Finds an AuthScheme, returning an Optional<AuthScheme>.
default AuthScheme	getAuthScheme(String authSchemeId)	Fetches a specific AuthScheme instance based on ID.
Pagination<AuthScheme>	getAuthSchemes(int offset, int count, List<String> tags)	Lists all AuthScheme instances
List<AuthScheme>	getAuthSchemesByAudience(List<String> audience)	Gets all AuthScheme instances with the supplied audiences.
AuthScheme	updateAuthScheme(AuthScheme authScheme)	Updates the supplied AuthScheme

Method Details

getAuthSchemes

Pagination<AuthScheme> getAuthSchemes(int offset,
 int count,
 List<String> tags)

Lists all AuthScheme instances

Parameters:

offset -

count -

tags -

Returns:

a Pagination of AuthScheme instances

findAuthScheme

Optional<AuthScheme> findAuthScheme(String authSchemeId)

Finds an AuthScheme, returning an Optional<AuthScheme>.

Parameters:

authSchemeId - the auth scheme id

Returns:

an Optional<AuthScheme>

getAuthScheme

default AuthScheme getAuthScheme(String authSchemeId)

Fetches a specific AuthScheme instance based on ID. If not found, an exception is raised.

Parameters:

authSchemeId - the auth scheme ID

Returns:

the AuthScheme, never null

getAuthSchemesByAudience

List<AuthScheme> getAuthSchemesByAudience(List<String> audience)

Gets all AuthScheme instances with the supplied audiences.

Parameters:

audience - the audience

updateAuthScheme

AuthScheme updateAuthScheme(AuthScheme authScheme)

Updates the supplied AuthScheme

Parameters:

authScheme - the UpdateAuthSchemeRequest with the information to update the authScheme

Returns:

a UpdateAuthSchemeResponse as it was created

createAuthScheme

AuthScheme createAuthScheme(AuthScheme authScheme)

Creates an AuthScheme

Parameters:

authScheme - the CreateAuthSchemeRequest with the information to create the authScheme

Returns:

a CreateAuthSchemeResponse as it was created

deleteAuthScheme

void deleteAuthScheme(String authSchemeId)

Deletes the AuthScheme with the supplied auth scheme ID.

Parameters:

authSchemeId - the auth scheme ID.