org.modeshape.schematic

Interface SchematicDbProvider<T extends SchematicDb>

All Known Implementing Classes:

FileDbProvider, RelationalProvider

public interface SchematicDbProvider<T extends SchematicDb>

Service interface for SchematicDb providers. A particular provider is expected to implement this interface and make itself available for discovery using the standard ServiceLoader mechanism.

Since:

5.0

Method Summary

Modifier and Type	Method and Description
T	getDB(String type, Document configuration) Returns a schematic DB instance for a given db type and configuration document

Method Detail

getDB

T getDB(String type,
        Document configuration)

Returns a schematic DB instance for a given db type and configuration document

Parameters:

type - the type of DB; may not be null

configuration - a Document instance which contains the configuration of a particular DB.

Returns:

a SchematicDb instance or null if a particular provider does not recognize the type.

Throws:

RuntimeException - if a DB provider recognizes the type, but fails in an expected way to provide a valid DB instance.