Package com.snowflake.connectors.application.configuration.connection

Class UpdateConnectionConfigurationHandler

java.lang.Object

com.snowflake.connectors.application.configuration.connection.UpdateConnectionConfigurationHandler

public class UpdateConnectionConfigurationHandler
extends Object

Handler for the connection configuration update 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 connection configuration failure, used by the ConnectorErrorHelper.

Method Summary

Modifier and Type	Method	Description
static UpdateConnectionConfigurationHandlerBuilder	builder(Session session)	Returns a new instance of ConnectionConfigurationHandlerBuilder.
static Variant	updateConnectionConfiguration(Session session, Variant configuration)	Default handler method for the PUBLIC.UPDATE_CONNECTION_CONFIGURATION procedure.
ConnectorResponse	updateConnectionConfiguration(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 connection configuration failure, used by the ConnectorErrorHelper.

See Also:

Constant Field Values

Method Detail

updateConnectionConfiguration

public static Variant updateConnectionConfiguration(Session session,
                                                    Variant configuration)

Default handler method for the PUBLIC.UPDATE_CONNECTION_CONFIGURATION procedure.

Parameters:

session - Snowpark session object

configuration - connection configuration properties

Returns:

a variant representing the ConnectorResponse returned by setConnectionConfiguration

builder

public static UpdateConnectionConfigurationHandlerBuilder builder(Session session)

Returns a new instance of ConnectionConfigurationHandlerBuilder.

Parameters:

session - Snowpark session object

Returns:

a new builder instance

updateConnectionConfiguration

public ConnectorResponse updateConnectionConfiguration(Variant configuration)

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

The handler logic consists of:

• connector status check
• ConnectionConfigurationInputValidator.validate(Variant)
• ConnectionConfigurationCallback.execute(Variant) for a draft check
• DraftConnectionValidator.validate(Variant)
• ConnectionConfigurationCallback.execute(Variant)
• ConnectionValidator.validate()
• connector status update

Parameters:

configuration - connection 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