FileMapStorage (Keycloak Docs Distribution 21.0.2 API)

java.lang.Object
- org.keycloak.models.map.storage.file.FileMapStorage<V,M>

All Implemented Interfaces:: MapStorage<V,M>

public class FileMapStorage<V extends AbstractEntity & UpdatableEntity,M>
extends Object
implements MapStorage<V,M>

A file-based MapStorage.

Author:: Stefan Guilhen

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class FileMapStorage.Crud<V extends AbstractEntity & UpdatableEntity,M>

Constructor Summary

Constructors
Constructor	Description
`FileMapStorage(Class<V> entityClass, Function<V,String[]> uniqueHumanReadableField, Function<String,Path> dataDirectoryFunc)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`MapKeycloakTransaction<V,M>`	`createTransaction(KeycloakSession session)`	Creates a `MapKeycloakTransaction` object that tracks a new transaction related to this storage.
`FileMapKeycloakTransaction<V,M>`	`createTransactionInternal(KeycloakSession session)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - FileMapStorage
```
public FileMapStorage(Class<V> entityClass,
                      Function<V,String[]> uniqueHumanReadableField,
                      Function<String,Path> dataDirectoryFunc)
```
- Method Detail
  - createTransaction
```
public MapKeycloakTransaction<V,M> createTransaction(KeycloakSession session)
```
    Description copied from interface: MapStorage
    
    Creates a MapKeycloakTransaction object that tracks a new transaction related to this storage. In case of JPA or similar, the transaction object might be supplied by the container (via JTA) or shared same across storages accessing the same database within the same session; in other cases (e.g. plain map) a separate transaction handler might be created per each storage.
    
    Specified by:
    
    createTransaction in interface MapStorage<V extends AbstractEntity & UpdatableEntity,M>
    
    Returns:
    
    See description. Never returns null
  - createTransactionInternal
```
public FileMapKeycloakTransaction<V,M> createTransactionInternal(KeycloakSession session)
```