com.delphix.masking.api.driverSupport

Interface SingleOperationTask

public interface SingleOperationTask

This is the interface that all Single Operation Tasks must implement.

Attention! If using a logger - be careful when choosing which information to log. Sensitive information should never be logged!

Method Summary

Modifier and Type	Method and Description
default java.lang.Boolean	cancel() Method to cancel SingleOperationTask.
void	execute() Method to execute SingleOperationTask.
java.lang.String	getTaskName() Get the task name of this SingleOperationTask.
void	setup(ComponentService serviceProvider) Retrieve and set up any required information provided by the service provider that may be required by this class.

Method Detail

getTaskName

java.lang.String getTaskName()

Get the task name of this SingleOperationTask. This name must be unique across all SingleOperationTask delivered in a single plugin.

Returns:

The name of this SingleOperationTask

setup

void setup(@NotNull
           ComponentService serviceProvider)

Retrieve and set up any required information provided by the service provider that may be required by this class.

Attention! The service provider contains access to the target java.sql.Connection object Sensitive information related to a connection, such as host and credentials should never be logged!

Parameters:

serviceProvider - See DriverComponentService for all available accessors.

execute

void execute()
      throws java.io.IOException,
             java.sql.SQLException,
             SingleOperationTaskException

Method to execute SingleOperationTask.

Throws:

java.io.IOException - If an error occurs while performing IO operations.

SingleOperationTaskException - If a generic error occurs related to SingleOperationTask.

java.sql.SQLException - If an error occurs while performing SQL operations.

cancel

default java.lang.Boolean cancel()
                          throws SingleOperationTaskException

Method to cancel SingleOperationTask.

Returns:

True if the task was successfully canceled, false otherwise.

Throws:

SingleOperationTaskException - If a generic error occurs related to SingleOperationTask.