Package org.clazzes.util.jdbc.provider.api

Interface IJdbcProviderApi

  • All Superinterfaces:
    org.clazzes.util.sched.api.IJobStatusService
    All Known Implementing Classes:
    JdbcProviderApiImpl
    public interface IJdbcProviderApi
extends org.clazzes.util.sched.api.IJobStatusService

    • Method Detail

      • testConnection

        UUID testConnection​(String url,
                    Map<String,​String> additionalProperties)
        Test a not yet configured JDBC connection.
        Parameters:
        url - The JDBC URL to test.
        additionalProperties - Any additional properties like username, password, ... as mentioned in the description of JdbcProvider.
        Returns:
        An UUID of a job to query with IJobStatusService.getJobStatus(UUID). The job will have a result type of Boolean.

      • testDataSource

        UUID testDataSource​(String datasourceName)
        Test an already configured datasource.
        Parameters:
        datasourceName - The name of the configured datasource to test.
        Returns:
        An UUID of a job to query with IJobStatusService.getJobStatus(UUID). The job will have a result type of Boolean.

      • testAllDataSources

        UUID testAllDataSources()
        Test all configured datasources.
        Returns:
        An UUID of a job to query with IJobStatusService.getJobStatus(UUID). The job will have a result type of Integer representing the number of successfully tested datasources.

      • restartDataSource

        UUID restartDataSource​(String datasourceName)
        Restart a configured datasource.
        Parameters:
        datasourceName - The name of the configured datasource to restart.
        Returns:
        An UUID of a job to query with IJobStatusService.getJobStatus(UUID). The job will have a result type of Boolean.

      • listDataSources

        Map<String,​Boolean> listDataSources()
        Returns:
        A list of datasources along with their activation status.