Package org.keycloak.models.map.storage.file

Class FileCrudOperations<V extends AbstractEntity & UpdatableEntity,M>

java.lang.Object

org.keycloak.models.map.storage.file.FileCrudOperations<V,M>

All Implemented Interfaces:

HasRealmId, CrudOperations<V,M>

public abstract class FileCrudOperations<V extends AbstractEntity & UpdatableEntity,M>
extends Object
implements CrudOperations<V,M>, HasRealmId

Field Summary

Fields

Modifier and Type	Field	Description
static final org.snakeyaml.engine.v2.api.DumpSettings	DUMP_SETTINGS
static final String	FILE_SUFFIX
static final String	ID_COMPONENT_SEPARATOR
static final String	SEARCHABLE_FIELD_REALM_ID_FIELD_NAME

Constructor Summary

Constructors

Constructor	Description
FileCrudOperations(Class<V> entityClass, Function<String,Path> dataDirectoryFunc, Function<V,String[]> suggestedPath, boolean isExpirableEntity)

Method Summary

Modifier and Type	Method	Description
static boolean	canParseFile(Path p)
protected abstract void	checkIsSafeToModify(Path path)	Hook to validate that it is safe to modify the file identified by the supplied Path.
V	create(V value)
MapModelCriteriaBuilder<String,V,M>	createCriteriaBuilder()
boolean	delete(String key)
long	delete(QueryParameters<M> queryParameters)
String	determineKeyFromValue(V value)	Returns escaped ID - relative file name in the file system with path separator ID_COMPONENT_SEPARATOR.
String	determineKeyFromValue(V value, String lastIdComponentIfUnset)
long	getCount(QueryParameters<M> queryParameters)
protected abstract FileTime	getLastModifiedTime(Path path)	Hook to obtain the last modified time of the file identified by the supplied Path.
protected Path	getPathForEscapedId(String escapedId)
protected Path	getPathForEscapedId(String[] escapedIdPathArray)
static <V extends AbstractEntity & UpdatableEntity, M> Map<org.keycloak.storage.SearchableModelField<? super M>,MapModelCriteriaBuilder.UpdatePredicatesFunc<String,V,M>>	getPredicates(Class<V> entityClass)
String	getRealmId()
protected abstract String	getTxId()
protected V	parse(Path fileName)
V	read(String key)
Stream<V>	read(QueryParameters<M> queryParameters)
protected abstract void	registerRenameOnCommit(Path tempSp, Path sp)
protected abstract boolean	removeIfExists(Path sp)
void	setRealmId(String realmId)
protected abstract void	touch(String proposedId, Path sp)
V	update(V value)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.keycloak.models.map.storage.CrudOperations

exists, exists

Field Details

SEARCHABLE_FIELD_REALM_ID_FIELD_NAME

public static final String SEARCHABLE_FIELD_REALM_ID_FIELD_NAME

FILE_SUFFIX

public static final String FILE_SUFFIX

See Also:

• Constant Field Values

DUMP_SETTINGS

public static final org.snakeyaml.engine.v2.api.DumpSettings DUMP_SETTINGS

ID_COMPONENT_SEPARATOR

public static final String ID_COMPONENT_SEPARATOR

See Also:

• Constant Field Values

Constructor Details

FileCrudOperations

public FileCrudOperations(Class<V> entityClass,
 Function<String,Path> dataDirectoryFunc,
 Function<V,String[]> suggestedPath,
 boolean isExpirableEntity)

Method Details

getPredicates

public static <V extends AbstractEntity & UpdatableEntity,
M>
Map<org.keycloak.storage.SearchableModelField<? super M>,MapModelCriteriaBuilder.UpdatePredicatesFunc<String,V,M>> getPredicates(Class<V> entityClass)

getPathForEscapedId

protected Path getPathForEscapedId(String[] escapedIdPathArray)

getPathForEscapedId

protected Path getPathForEscapedId(String escapedId)

canParseFile

public static boolean canParseFile(Path p)

parse

protected V parse(Path fileName)

create

public V create(V value)

Specified by:

create in interface CrudOperations<V extends AbstractEntity & UpdatableEntity,M>

determineKeyFromValue

public String determineKeyFromValue(V value,
 String lastIdComponentIfUnset)

determineKeyFromValue

public String determineKeyFromValue(V value)

Returns escaped ID - relative file name in the file system with path separator ID_COMPONENT_SEPARATOR.

Specified by:

determineKeyFromValue in interface CrudOperations<V extends AbstractEntity & UpdatableEntity,M>

Parameters:

value - Object

forCreate - Whether this is for create operation (true) or

Returns:

read

public V read(String key)

Specified by:

read in interface CrudOperations<V extends AbstractEntity & UpdatableEntity,M>

createCriteriaBuilder

public MapModelCriteriaBuilder<String,V,M> createCriteriaBuilder()

read

public Stream<V> read(QueryParameters<M> queryParameters)

Specified by:

read in interface CrudOperations<V extends AbstractEntity & UpdatableEntity,M>

update

public V update(V value)

Specified by:

update in interface CrudOperations<V extends AbstractEntity & UpdatableEntity,M>

delete

public boolean delete(String key)

Specified by:

delete in interface CrudOperations<V extends AbstractEntity & UpdatableEntity,M>

delete

public long delete(QueryParameters<M> queryParameters)

Specified by:

delete in interface CrudOperations<V extends AbstractEntity & UpdatableEntity,M>

getCount

public long getCount(QueryParameters<M> queryParameters)

Specified by:

getCount in interface CrudOperations<V extends AbstractEntity & UpdatableEntity,M>

getRealmId

public String getRealmId()

Specified by:

getRealmId in interface HasRealmId

setRealmId

public void setRealmId(String realmId)

Specified by:

setRealmId in interface HasRealmId

touch

protected abstract void touch(String proposedId,
 Path sp)
                       throws IOException

Throws:

IOException

removeIfExists

protected abstract boolean removeIfExists(Path sp)

registerRenameOnCommit

protected abstract void registerRenameOnCommit(Path tempSp,
 Path sp)

getTxId

protected abstract String getTxId()

getLastModifiedTime

protected abstract FileTime getLastModifiedTime(Path path)

Hook to obtain the last modified time of the file identified by the supplied Path.

Parameters:

path - the Path to the file whose last modified time it to be obtained.

Returns:

the FileTime corresponding to the file's last modified time.

checkIsSafeToModify

protected abstract void checkIsSafeToModify(Path path)

Hook to validate that it is safe to modify the file identified by the supplied Path. The primary goal is to identify if other transactions have modified the file after it was read by the current transaction, preventing updates to a stale entity.

Parameters:

path - the Path to the file that is to be modified.