Package net.officefloor.compile.spi.supplier.source

Interface SupplierSource

All Known Implementing Classes:

AbstractCosmosDbSupplierSource, AbstractSupplierSource, CosmosAsyncDbSupplierSource, CosmosDbSupplierSource, DynamoDbSupplierSource, FirestoreSupplierSource, JaxRsSupplierSource, ObjectifySupplierSource, ServletSupplierSource, SpringBeanSupplierSource, SpringSupplierSource, WebAppWoofExtensionService.WebAppSupplierSource

public interface SupplierSource

Supplies ManagedObjectSource instances.

This allows for plugging in object libraries.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method	Description
SupplierSourceSpecification	getSpecification()	Obtains the SupplierSourceSpecification for this SupplierSource.
void	supply(SupplierSourceContext context)	Supplies the necessary ManagedObjectSource instances.
void	terminate()	Terminates the supply contract.

Method Details

getSpecification

SupplierSourceSpecification getSpecification()

Obtains the SupplierSourceSpecification for this SupplierSource.

This enables the SupplierSourceContext to be populated with the necessary details as per this SupplierSourceSpecification in loading the InitialSupplierType.

Returns:

SupplierSourceSpecification.

supply

void supply(SupplierSourceContext context)
     throws Exception

Supplies the necessary ManagedObjectSource instances.

Parameters:

context - SupplierSourceContext.

Throws:

Exception - If fails to provide supply of ManagedObjectSource instances.

terminate

void terminate()

Terminates the supply contract.

This should release all resources required by the supplier.