Package com.snowflake.connectors.application.configuration.connector

Class ConfigureConnectorHandler

java.lang.Object

com.snowflake.connectors.application.configuration.connector.ConfigureConnectorHandler

public class ConfigureConnectorHandler
extends Object

Handler for the connector configuration process. A new instance of the handler must be created using the builder.

Field Summary

Fields

Modifier and Type	Field	Description
static String	ERROR_TYPE	Error type for the connector configuration failure, used by the ConnectorErrorHelper.

Method Summary

Modifier and Type	Method	Description
static ConfigureConnectorHandlerBuilder	builder(Session session)	Returns a new instance of ConfigureConnectorHandlerBuilder.
static Variant	configureConnector(Session session, Variant configuration)	Default handler method for the PUBLIC.CONFIGURE_CONNECTOR procedure.
ConnectorResponse	configureConnector(Variant configuration)	Executes the main logic of the handler, with logging using withExceptionLogging.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ERROR_TYPE

public static final String ERROR_TYPE

Error type for the connector configuration failure, used by the ConnectorErrorHelper.

See Also:

Constant Field Values

Method Detail

configureConnector

public static Variant configureConnector(Session session,
                                         Variant configuration)

Default handler method for the PUBLIC.CONFIGURE_CONNECTOR procedure.

Parameters:

session - Snowpark session object

configuration - connector configuration properties

Returns:

a variant representing the ConnectorResponse returned by configureConnector

builder

public static ConfigureConnectorHandlerBuilder builder(Session session)

Returns a new instance of ConfigureConnectorHandlerBuilder.

Parameters:

session - Snowpark session object

Returns:

a new builder instance

configureConnector

public ConnectorResponse configureConnector(Variant configuration)

Executes the main logic of the handler, with logging using withExceptionLogging.

The handler logic consists of:

• connector status check
• ConnectorConfigurationService.validateFields(Variant)
• ConfigureConnectorInputValidator.validate(Variant)
• ConfigureConnectorCallback.execute(Variant)
• connector status update

Parameters:

configuration - connector configuration properties

Returns:

a response with the code OK if the execution was successful, otherwise a response with an error code and an error message