Package io.deephaven.enterprise.schema.internal

Class SchemaServiceBase.Delegating

java.lang.Object

io.deephaven.enterprise.schema.internal.SchemaServiceBase.Delegating

All Implemented Interfaces:

SchemaServiceBase, AutoCloseable

Enclosing interface:

SchemaServiceBase

public static class SchemaServiceBase.Delegating
extends Object
implements SchemaServiceBase

Delegate all method calls to an implementation object. This is designed to be overloaded.

Nested Class Summary

Nested classes/interfaces inherited from interface io.deephaven.enterprise.schema.internal.SchemaServiceBase

SchemaServiceBase.Delegating

Constructor Summary

Constructors

Constructor	Description
Delegating(SchemaServiceBase delegate)

Method Summary

Modifier and Type	Method	Description
String	about()	Information about a SchemaService instance.
boolean	authenticate()	Authenticate using default authentication.
boolean	authenticate(String user, String password)	Authenticate using the given user and password.
boolean	authenticate(String user, String password, String operateAs)	Authenticate using the given user and password, operating as the operateAs user.
void	close()
boolean	containsNamespace(String namespace)	Find out whether the given namespace is known to the schema service.
boolean	containsNamespace(String namespace, boolean includeDeleted)	Find out whether the given namespace is known to the schema service.
boolean	containsSchema(String namespace, String tableName)	Find out if the given schema exists.
void	deleteSchema(String namespace, String tableName)	Delete the specified schema.
void	deleteSchema(String namespace, String tableName, String code, String comment)	Delete the specified schema.
Collection<String>	listNamespaces()	Get a collection of the namespaces available.
Collection<String>	listNamespaces(boolean includeDeleted)	Get a collection of the namespaces available.
Collection<String>	listTableNames(String namespace)	Get a collection of all table names in the specified namespace.
Collection<String>	listTableNames(String namespace, boolean includeDeleted)	Get a collection of all table names in the specified namespace.
void	removeNamespace(String namespaceName)	Remove the given namespace.
void	removeNamespace(String namespaceName, String code, String comment)	Remove the given namespace.
void	shutdown()	Shut down the schema service.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.deephaven.enterprise.schema.internal.SchemaServiceBase

initializationStage

Constructor Details

Delegating

public Delegating(@NotNull
 SchemaServiceBase delegate)

Method Details

about

public String about()

Description copied from interface: SchemaServiceBase

Information about a SchemaService instance. Useful for debugging.

Specified by:

about in interface SchemaServiceBase

Returns:

a string containing information about the instance

authenticate

public boolean authenticate(@NotNull
 String user,
 @NotNull
 String password)

Description copied from interface: SchemaServiceBase

Authenticate using the given user and password. Implementations are not required to allow re-authentication.

Specified by:

authenticate in interface SchemaServiceBase

Parameters:

user - the user to authenticate

password - the password for the user

Returns:

true only if the authentication succeeded

authenticate

public boolean authenticate(@NotNull
 String user,
 @NotNull
 String password,
 @NotNull
 String operateAs)

Description copied from interface: SchemaServiceBase

Authenticate using the given user and password, operating as the operateAs user. Implementations are not required to allow re-authentication.

Specified by:

authenticate in interface SchemaServiceBase

Parameters:

user - the user to authenticate

password - the password for the user

operateAs - attempt to operate as this effective user

Returns:

true only if the authentication succeeded

authenticate

public boolean authenticate()

Description copied from interface: SchemaServiceBase

Authenticate using default authentication. This will be using the default private key or however AuthenticationClientManager.getDefault() has been authenticated.

Specified by:

authenticate in interface SchemaServiceBase

Returns:

true only if the authentication succeeded

containsNamespace

public boolean containsNamespace(@NotNull
 String namespace,
 boolean includeDeleted)

Description copied from interface: SchemaServiceBase

Find out whether the given namespace is known to the schema service.

Specified by:

containsNamespace in interface SchemaServiceBase

Parameters:

namespace - the namespace in question

includeDeleted - true if deleted namespaces should be considered

Returns:

true if the namespace is found

containsNamespace

public boolean containsNamespace(@NotNull
 String namespace)

Description copied from interface: SchemaServiceBase

Find out whether the given namespace is known to the schema service.

Specified by:

containsNamespace in interface SchemaServiceBase

Parameters:

namespace - the namespace in question

Returns:

true if the namespace is found

containsSchema

public boolean containsSchema(@NotNull
 String namespace,
 @NotNull
 String tableName)

Description copied from interface: SchemaServiceBase

Find out if the given schema exists. Does not check for deleted schemas.

Specified by:

containsSchema in interface SchemaServiceBase

Parameters:

namespace - the namespace of the table

tableName - the table name

Returns:

true if a schema is found for namespace.tableName

listNamespaces

@NotNull
public Collection<String> listNamespaces()

Description copied from interface: SchemaServiceBase

Get a collection of the namespaces available.

Specified by:

listNamespaces in interface SchemaServiceBase

Returns:

a collection of namespace names

listNamespaces

@NotNull
public Collection<String> listNamespaces(boolean includeDeleted)

Description copied from interface: SchemaServiceBase

Get a collection of the namespaces available.

Specified by:

listNamespaces in interface SchemaServiceBase

Parameters:

includeDeleted - true if deleted namespaces should be included

Returns:

a collection of namespace names

listTableNames

@NotNull
public Collection<String> listTableNames(@NotNull
 String namespace)

Description copied from interface: SchemaServiceBase

Get a collection of all table names in the specified namespace.

Specified by:

listTableNames in interface SchemaServiceBase

Parameters:

namespace - the name of the namespace

Returns:

a collection of all available schemas in namespace

listTableNames

@NotNull
public Collection<String> listTableNames(@NotNull
 String namespace,
 boolean includeDeleted)

Description copied from interface: SchemaServiceBase

Get a collection of all table names in the specified namespace.

Specified by:

listTableNames in interface SchemaServiceBase

Parameters:

namespace - the name of the namespace

includeDeleted - tf deleted schemas should be included

Returns:

a collection of all available schemas in namespace, empty list if namespace does not exit

removeNamespace

public void removeNamespace(@NotNull
 String namespaceName)
                     throws SchemaException

Description copied from interface: SchemaServiceBase

Remove the given namespace. The namespace must be empty (contain no schemas).

Specified by:

removeNamespace in interface SchemaServiceBase

Parameters:

namespaceName - the namespace to remove

Throws:

SchemaException - if the namespace cannot be removed

removeNamespace

public void removeNamespace(@NotNull
 String namespaceName,
 @NotNull
 String code,
 @NotNull
 String comment)
                     throws SchemaException

Description copied from interface: SchemaServiceBase

Remove the given namespace. The namespace must be empty (contain no schemas).

Specified by:

removeNamespace in interface SchemaServiceBase

Parameters:

namespaceName - the namespace to remove

code - pass-thru to kv persistence, indicates the code source of this update

comment - pass-thru to kv persistence - a comment for this update

Throws:

SchemaException - if the namespace cannot be removed

deleteSchema

public void deleteSchema(@NotNull
 String namespace,
 @NotNull
 String tableName)
                  throws IllegalArgumentException,
SchemaException

Description copied from interface: SchemaServiceBase

Delete the specified schema.

Specified by:

deleteSchema in interface SchemaServiceBase

Parameters:

namespace - the namespace of the schema to delete

tableName - the name of the schema to delete

Throws:

IllegalArgumentException - if the namespace or table could not be found

SchemaException - if the schema could not be deleted

deleteSchema

public void deleteSchema(@NotNull
 String namespace,
 @NotNull
 String tableName,
 @NotNull
 String code,
 @NotNull
 String comment)
                  throws IllegalArgumentException,
SchemaException

Description copied from interface: SchemaServiceBase

Delete the specified schema.

Specified by:

deleteSchema in interface SchemaServiceBase

Parameters:

namespace - the namespace of the schema to delete

tableName - the name of the schema to delete

code - pass-thru to kv persistence, indicates the code source of this delete

comment - pass-thru to kv persistence - a comment for this delete

Throws:

IllegalArgumentException - if the namespace or table could not be found

SchemaException - if the schema could not be deleted

shutdown

public void shutdown()

Description copied from interface: SchemaServiceBase

Shut down the schema service. This may involve cleaning up threads and releasing resources.

Specified by:

shutdown in interface SchemaServiceBase

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface SchemaServiceBase