Module cloud.quinimbus.persistence.api

Package cloud.quinimbus.persistence.api

Interface PersistenceContext

public interface PersistenceContext

The persistence context is the central object for using Quinimbus Persistence.

Method Summary

Modifier and Type	Method	Description
<T extends Record> EntityReader<T>	getRecordEntityReader(EntityType type, Class<T> recordClass)
RecordEntityRegistry	getRecordEntityRegistry()
<T extends Record> EntityWriter<T>	getRecordEntityWriter(EntityType type, Class<T> recordClass)
Optional<Schema>	getSchema(String id)	Get the schame registered by the given id.
Optional<PersistenceSchemaProvider>	getSchemaProvider(String alias)	Get the schema provider registered by the given alias.
Optional<PersistenceSchemaStorage>	getSchemaStorage(String id)
<T extends PersistenceSchemaStorage> Optional<? extends PersistenceStorageProvider<T>>	getStorageProvider(String alias)	Get the storage provider registered by the given alias.
Schema	importRecordSchema(Class<? extends Record>... recordClasses)
Schema	importSchema(PersistenceSchemaProvider provider)
Schema	importSchema(PersistenceSchemaProvider provider, cloud.quinimbus.config.api.ConfigNode configNode)
Schema	importSchemaFromSingleJson(Reader reader)
EmbeddedObject	newEmbedded(EmbeddedPropertyType type, EntityType parentType, List<String> path, Map<String,Object> properties)
EmbeddedObject	newEmbedded(EmbeddedPropertyType type, EntityType parentType, List<String> path, Map<String,Object> properties, Map<String,Object> transientFields)
<K> Entity<K>	newEntity(K id, EntityType type)
<K> Entity<K>	newEntity(K id, EntityType type, Map<String,Object> properties)
<K> Entity<K>	newEntity(K id, EntityType type, Map<String,Object> properties, Map<String,Object> transientFields)
<T extends LifecycleEvent<K>, K> void	onLifecycleEvent(String schema, Class<T> eventType, EntityType type, Consumer<T> consumer)
<T extends LifecycleEvent<K>, K> void	onLifecycleEvent(String schema, Class<T> eventType, String typeId, Consumer<T> consumer)
PersistenceSchemaStorage	setInMemorySchemaStorage(String id)
PersistenceSchemaStorage	setSchemaStorage(String id, PersistenceSchemaStorage storage)
void	upgradeSchema(PersistenceSchemaStorage storage)

Method Details

getStorageProvider

<T extends PersistenceSchemaStorage>
Optional<? extends PersistenceStorageProvider<T>> getStorageProvider(String alias)

Get the storage provider registered by the given alias.

Type Parameters:

T - The type of the storage the provider will produce

Parameters:

alias - The alias of the provider

Returns:

An Optional containing the provider if present, an empty Optional otherwise

getSchemaProvider

Optional<PersistenceSchemaProvider> getSchemaProvider(String alias)

Get the schema provider registered by the given alias.

Parameters:

alias - The alias of the provider

Returns:

An Optional containing the provider if present, an empty Optional otherwise

getSchema

Optional<Schema> getSchema(String id)

Get the schame registered by the given id.

Parameters:

id - The id of the schema

Returns:

An Optional containing the schema if present, an empty Optional otherwise

getSchemaStorage

Optional<PersistenceSchemaStorage> getSchemaStorage(String id)

setSchemaStorage

PersistenceSchemaStorage setSchemaStorage(String id,
 PersistenceSchemaStorage storage)

setInMemorySchemaStorage

PersistenceSchemaStorage setInMemorySchemaStorage(String id)

newEntity

<K> Entity<K> newEntity(K id,
 EntityType type)

newEntity

<K> Entity<K> newEntity(K id,
 EntityType type,
 Map<String,Object> properties)
                 throws UnparseableValueException

Throws:

UnparseableValueException

newEntity

<K> Entity<K> newEntity(K id,
 EntityType type,
 Map<String,Object> properties,
 Map<String,Object> transientFields)
                 throws UnparseableValueException

Throws:

UnparseableValueException

newEmbedded

EmbeddedObject newEmbedded(EmbeddedPropertyType type,
 EntityType parentType,
 List<String> path,
 Map<String,Object> properties)
                    throws UnparseableValueException

Throws:

UnparseableValueException

newEmbedded

EmbeddedObject newEmbedded(EmbeddedPropertyType type,
 EntityType parentType,
 List<String> path,
 Map<String,Object> properties,
 Map<String,Object> transientFields)
                    throws UnparseableValueException

Throws:

UnparseableValueException

importSchema

Schema importSchema(PersistenceSchemaProvider provider)
             throws InvalidSchemaException

Throws:

InvalidSchemaException

importSchema

Schema importSchema(PersistenceSchemaProvider provider,
 cloud.quinimbus.config.api.ConfigNode configNode)
             throws InvalidSchemaException

Throws:

InvalidSchemaException

importSchemaFromSingleJson

Schema importSchemaFromSingleJson(Reader reader)
                           throws InvalidSchemaException,
IOException

Throws:

InvalidSchemaException

IOException

importRecordSchema

Schema importRecordSchema(Class<? extends Record>... recordClasses)
                   throws InvalidSchemaException

Throws:

InvalidSchemaException

getRecordEntityReader

<T extends Record> EntityReader<T> getRecordEntityReader(EntityType type,
 Class<T> recordClass)
                                                  throws EntityReaderInitialisationException

Throws:

EntityReaderInitialisationException

getRecordEntityWriter

<T extends Record> EntityWriter<T> getRecordEntityWriter(EntityType type,
 Class<T> recordClass)
                                                  throws EntityWriterInitialisationException

Throws:

EntityWriterInitialisationException

upgradeSchema

void upgradeSchema(PersistenceSchemaStorage storage)
            throws PersistenceException

Throws:

PersistenceException

getRecordEntityRegistry

RecordEntityRegistry getRecordEntityRegistry()

onLifecycleEvent

<T extends LifecycleEvent<K>,
K> void onLifecycleEvent(String schema,
 Class<T> eventType,
 EntityType type,
 Consumer<T> consumer)

onLifecycleEvent

<T extends LifecycleEvent<K>,
K> void onLifecycleEvent(String schema,
 Class<T> eventType,
 String typeId,
 Consumer<T> consumer)