com.datastax.oss.driver.api.core.metadata.schema

Interface SchemaChangeListener

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

SchemaChangeListenerBase

public interface SchemaChangeListener
extends AutoCloseable

Tracks schema changes.

Implementations of this interface can be registered either via the configuration (see reference.conf in the manual or core driver JAR), or programmatically via SessionBuilder.addSchemaChangeListener(SchemaChangeListener).

Note that the methods defined by this interface will be executed by internal driver threads, and are therefore expected to have short execution times. If you need to perform long computations or blocking calls in response to schema change events, it is strongly recommended to schedule them asynchronously on a separate thread provided by your application code.

If you implement this interface but don't need to implement all the methods, extend SchemaChangeListenerBase.

Method Summary

Modifier and Type	Method and Description
void	onAggregateCreated(AggregateMetadata aggregate)
void	onAggregateDropped(AggregateMetadata aggregate)
void	onAggregateUpdated(AggregateMetadata current, AggregateMetadata previous)
void	onFunctionCreated(FunctionMetadata function)
void	onFunctionDropped(FunctionMetadata function)
void	onFunctionUpdated(FunctionMetadata current, FunctionMetadata previous)
void	onKeyspaceCreated(KeyspaceMetadata keyspace)
void	onKeyspaceDropped(KeyspaceMetadata keyspace)
void	onKeyspaceUpdated(KeyspaceMetadata current, KeyspaceMetadata previous)
default void	onSessionReady(Session session) Invoked when the session is ready to process user requests.
void	onTableCreated(TableMetadata table)
void	onTableDropped(TableMetadata table)
void	onTableUpdated(TableMetadata current, TableMetadata previous)
void	onUserDefinedTypeCreated(UserDefinedType type)
void	onUserDefinedTypeDropped(UserDefinedType type)
void	onUserDefinedTypeUpdated(UserDefinedType current, UserDefinedType previous)
void	onViewCreated(ViewMetadata view)
void	onViewDropped(ViewMetadata view)
void	onViewUpdated(ViewMetadata current, ViewMetadata previous)

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

onKeyspaceCreated

void onKeyspaceCreated(@NonNull
                       KeyspaceMetadata keyspace)

onKeyspaceDropped

void onKeyspaceDropped(@NonNull
                       KeyspaceMetadata keyspace)

onKeyspaceUpdated

void onKeyspaceUpdated(@NonNull
                       KeyspaceMetadata current,
                       @NonNull
                       KeyspaceMetadata previous)

onTableCreated

void onTableCreated(@NonNull
                    TableMetadata table)

onTableDropped

void onTableDropped(@NonNull
                    TableMetadata table)

onTableUpdated

void onTableUpdated(@NonNull
                    TableMetadata current,
                    @NonNull
                    TableMetadata previous)

onUserDefinedTypeCreated

void onUserDefinedTypeCreated(@NonNull
                              UserDefinedType type)

onUserDefinedTypeDropped

void onUserDefinedTypeDropped(@NonNull
                              UserDefinedType type)

onUserDefinedTypeUpdated

void onUserDefinedTypeUpdated(@NonNull
                              UserDefinedType current,
                              @NonNull
                              UserDefinedType previous)

onFunctionCreated

void onFunctionCreated(@NonNull
                       FunctionMetadata function)

onFunctionDropped

void onFunctionDropped(@NonNull
                       FunctionMetadata function)

onFunctionUpdated

void onFunctionUpdated(@NonNull
                       FunctionMetadata current,
                       @NonNull
                       FunctionMetadata previous)

onAggregateCreated

void onAggregateCreated(@NonNull
                        AggregateMetadata aggregate)

onAggregateDropped

void onAggregateDropped(@NonNull
                        AggregateMetadata aggregate)

onAggregateUpdated

void onAggregateUpdated(@NonNull
                        AggregateMetadata current,
                        @NonNull
                        AggregateMetadata previous)

onViewCreated

void onViewCreated(@NonNull
                   ViewMetadata view)

onViewDropped

void onViewDropped(@NonNull
                   ViewMetadata view)

onViewUpdated

void onViewUpdated(@NonNull
                   ViewMetadata current,
                   @NonNull
                   ViewMetadata previous)

onSessionReady

default void onSessionReady(@NonNull
                            Session session)

Invoked when the session is ready to process user requests.

This corresponds to the moment when SessionBuilder.build() returns, or the future returned by SessionBuilder.buildAsync() completes. If the session initialization fails, this method will not get called.

Listener methods are invoked from different threads; if you store the session in a field, make it at least volatile to guarantee proper publication.

This method is guaranteed to be the first one invoked on this object.

The default implementation is empty.