Interface Connector
-
- All Known Subinterfaces:
PoolableConnector
- All Known Implementing Classes:
TstConnector
,TstStatefulConnector
,TstStatefulPoolableConnector
public interface Connector
This is the main interface to declare a connector. Developers must implement this interface. The life-cycle for aConnector
is as followsinit(Configuration)
is called then any of the operations implemented in the Connector and finally dispose. Theinit(Configuration)
anddispose()
allow for block operations. For instance bulk creates or deletes and the use of before and after actions. Oncedispose()
is called theConnector
object is discarded.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
dispose()
Dispose of any resources theConnector
uses.Configuration
getConfiguration()
Return the configuration that was passed toinit(Configuration)
.void
init(Configuration cfg)
Initialize the connector with its configuration.
-
-
-
Method Detail
-
getConfiguration
Configuration getConfiguration()
Return the configuration that was passed toinit(Configuration)
.- Returns:
- The configuration that was passed to
init(Configuration)
.
-
init
void init(Configuration cfg)
Initialize the connector with its configuration. For instance in a JDBCConnector
this would include the database URL, password, and user.- Parameters:
cfg
- instance of theConfiguration
object implemented by theConnector
developer and populated with information in order to initialize theConnector
.
-
dispose
void dispose()
Dispose of any resources theConnector
uses.
-
-