Package net.officefloor.nosql.cosmosdb

Class AbstractCosmosDbSupplierSource

java.lang.Object

net.officefloor.compile.spi.supplier.source.impl.AbstractSupplierSource

net.officefloor.nosql.cosmosdb.AbstractCosmosDbSupplierSource

All Implemented Interfaces:

SupplierSource

Direct Known Subclasses:

CosmosAsyncDbSupplierSource, CosmosDbSupplierSource

public abstract class AbstractCosmosDbSupplierSource
extends AbstractSupplierSource

Abstract SupplierSource for CosmosDatabase / CosmosAsyncDatabase.

Author:

Daniel Sagenschneider

Nested Class Summary

Nested classes/interfaces inherited from class net.officefloor.compile.spi.supplier.source.impl.AbstractSupplierSource

AbstractSupplierSource.SpecificationContext

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	PROPERTY_DATABASE	Property name for the CosmosDatabase name.
static java.lang.String	PROPERTY_ENTITY_LOCATORS	Property name for the comma separate list of CosmosEntityLocator Class names.

Constructor Summary

Constructors

Constructor	Description
AbstractCosmosDbSupplierSource()

Method Summary

Modifier and Type	Method	Description
protected void	loadSpecification(AbstractSupplierSource.SpecificationContext context)	Loads the SupplierSourceSpecification.
protected abstract void	setupManagedObjectSources(SupplierSourceContext context, java.lang.Class<?>[] entities)	Sets up the ManagedObjectSource instances.
void	supply(SupplierSourceContext context)	Supplies the necessary ManagedObjectSource instances.
void	terminate()	Terminates the supply contract.

Methods inherited from class net.officefloor.compile.spi.supplier.source.impl.AbstractSupplierSource

getSpecification

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_DATABASE

public static final java.lang.String PROPERTY_DATABASE

Property name for the CosmosDatabase name.

See Also:

Constant Field Values

PROPERTY_ENTITY_LOCATORS

public static final java.lang.String PROPERTY_ENTITY_LOCATORS

Property name for the comma separate list of CosmosEntityLocator Class names.

CosmosEntityLocator instances configured are instantiated by default constructors.

See Also:

Constant Field Values

Constructor Detail

AbstractCosmosDbSupplierSource

public AbstractCosmosDbSupplierSource()

Method Detail

setupManagedObjectSources

protected abstract void setupManagedObjectSources(SupplierSourceContext context,
                                                  java.lang.Class<?>[] entities)
                                           throws java.lang.Exception

Sets up the ManagedObjectSource instances.

Parameters:

context - SupplierSourceContext.

entities - Loaded entity Class instances.

Throws:

java.lang.Exception - If fails to setup the ManagedObjectSource instances.

loadSpecification

protected void loadSpecification(AbstractSupplierSource.SpecificationContext context)

Description copied from class: AbstractSupplierSource

Loads the SupplierSourceSpecification.

Specified by:

loadSpecification in class AbstractSupplierSource

Parameters:

context - AbstractSupplierSource.SpecificationContext.

supply

public void supply(SupplierSourceContext context)
            throws java.lang.Exception

Description copied from interface: SupplierSource

Supplies the necessary ManagedObjectSource instances.

Parameters:

context - SupplierSourceContext.

Throws:

java.lang.Exception - If fails to provide supply of ManagedObjectSource instances.

terminate

public void terminate()

Description copied from interface: SupplierSource

Terminates the supply contract.

This should release all resources required by the supplier.