com.delphix.masking.api.driverSupport

Interface Task

public interface Task

This is the interface that all Driver Support Tasks must implement.

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

Since:

1.5.0

Method Summary

Modifier and Type	Method and Description
default TaskComponentStatus	getStatus() Method to return status of Task Components.
java.lang.String	getTaskName() Get the name of this Task.
void	postJobExecute() Method to execute in a masking job following any transformation.
void	preJobExecute() Method to execute in a masking job prior to any transformation.
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 name of this Task. This name must be unique across all tasks delivered in a single plugin.

Returns:

The name of this task

Since:

1.5.0

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.

Since:

1.5.0

preJobExecute

void preJobExecute()
            throws java.io.IOException,
                   MaskingException,
                   java.sql.SQLException

Method to execute in a masking job prior to any transformation.

Throws:

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

MaskingException - If a generic error occurs related to masking.

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

Since:

1.5.0

postJobExecute

void postJobExecute()
             throws java.io.IOException,
                    MaskingException,
                    java.sql.SQLException

Method to execute in a masking job following any transformation.

Throws:

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

MaskingException - If a generic error occurs related to masking.

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

Since:

1.5.0

getStatus

default TaskComponentStatus getStatus()

Method to return status of Task Components. Task components could be constraints, indexes or triggers etc.

Returns:

A TaskComponentStatus object with the status of the task.

Since:

1.17.0