com.exasol.udfdebugging.ModuleFactory Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of udf-debugging-java Show documentation

Utilities for debugging, profiling and code coverage measure for UDFs.

The newest version!

package com.exasol.udfdebugging;

import java.sql.Connection;

import com.exasol.bucketfs.Bucket;

/**
 * Interface for factories for {@link Module}.
 */
public interface ModuleFactory {

    /**
     * Get if this module is enabled by system property.
     * 
     * @return {@code true} if this module is enabled
     */
    public boolean isEnabled();

    /**
     * Get the name of the property to enable this module.
     *
     * @return name of the property to enable this module
     */
    public String getModulePropertyName();

    /**
     * Build the {@link Module}.
     * 
     * @param localServiceExposer Proxy factory that makes ports of the test host available in the container
     * @param bucket              BucketFS bucket to upload resource to
     * @param exasolConnection    connection to the Exasol database
     * @return built {@link Module}
     */
    public Module buildModule(final LocalServiceExposer localServiceExposer, Bucket bucket,
            final Connection exasolConnection);
}