Package de.julielab.concepts.db.core.spi
Interface DatabaseConnected
-
- All Known Subinterfaces:
ConceptInserter,DatabaseOperator,DataExporter,MappingCreator,MappingInserter
- All Known Implementing Classes:
CypherBoltExporter,CypherBoltOperator,CypherFileDBExporter,CypherFileDBOperator,CypherHttpExporter,CypherHttpOperator,DataExporterImpl,FileDatabaseConceptInserter,FileDatabaseMappingInserter,JavaClassFileDBExporter,JavaClassFileDBOperator,RestConceptInserter,RestDatabaseOperator,RestExporter,RestMappingInserter
public interface DatabaseConnectedAn interface to indicate server provider interfaces that interact with the database and, thus, require a database connection.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidsetConnection(org.apache.commons.configuration2.HierarchicalConfiguration<org.apache.commons.configuration2.tree.ImmutableNode> connectionConfiguration)Requires the implementing service provider to check if the given connection is supported and, if so, to use it for later method calls.
-
-
-
Method Detail
-
setConnection
void setConnection(org.apache.commons.configuration2.HierarchicalConfiguration<org.apache.commons.configuration2.tree.ImmutableNode> connectionConfiguration) throws ConceptDatabaseConnectionExceptionRequires the implementing service provider to check if the given connection is supported and, if so, to use it for later method calls. Please not that this kind of state requires caution in case of multithreading.
If the provider cannot serve to given connection configuration, it is required to throw a
ConceptDatabaseConnectionException. This serves as the indication that the provider is not applicable for the required connection type. Typically, it will then just be omitted by its service.- Parameters:
connectionConfiguration- The connection details, e.g. HTTP, BOLT or file-based connection.- Throws:
ConceptDatabaseConnectionException- If the provider does not support the passed connection configuration.
-
-