Package com.illumon.iris.db.schema

Interface SchemaServiceAuthenticatedMutator

All Superinterfaces:

AutoCloseable, NamedImplementation, SchemaService

All Known Implementing Classes:

SchemaServiceEmptyTransientImpl, SchemaServiceEtcdImpl, SchemaServiceKvImpl

public interface SchemaServiceAuthenticatedMutator
extends SchemaService

Extend SchemaService with mutating methods that accept UserContext. These methods are to be used only in contexts where the user is authenticated by the caller.
Deephaven internal use only.

Nested Class Summary

Nested classes/interfaces inherited from interface com.illumon.iris.db.schema.SchemaService

SchemaService.Delegating

Method Summary

Modifier and Type	Method	Description
Schema	addSchema(Schema newSchema, io.deephaven.enterprise.auth.UserContext userContext, String code, String comment)	Adds a UserContext parameter to SchemaService.addSchema(Schema, String, String)
boolean	createNamespace(NamespaceSet namespaceSet, String namespaceName, io.deephaven.enterprise.auth.UserContext userContext, String code, String comment)	Adds a UserContext parameter to SchemaService.createNamespace(NamespaceSet, String, String, String)
void	deleteSchema(String namespace, String tableName, io.deephaven.enterprise.auth.UserContext userContext, String code, String comment)	Adds a UserContext parameter to SchemaService.deleteSchema(String, String, String, String)
void	removeNamespace(String namespaceName, io.deephaven.enterprise.auth.UserContext userContext, String code, String comment)	Adds a UserContext parameter to SchemaService.removeNamespace(String, String, String)
Schema	updateSchema(Schema newSchema, io.deephaven.enterprise.auth.UserContext userContext, String code, String comment)	Adds a UserContext parameter to SchemaService.updateSchema(Schema, String, String)

Methods inherited from interface com.illumon.util.type.NamedImplementation

getImplementationName

Methods inherited from interface com.illumon.iris.db.schema.SchemaService

about, addSchema, addSchema, addSchema, addSchema, asElement, asSchemaXml, authenticate, authenticate, authenticate, close, containsNamespace, containsNamespace, containsSchema, createNamespace, createNamespace, createNamespace, deleteSchema, deleteSchema, deleteSchema, deleteSchema, fromDefinition, fromDefinition, fromDefinition, fromDefinition, fromDefinition, fromElement, getAllSchemas, getLatestSchema, getLatestSchemaXml, getLatestTableDefinition, getLatestTableDefinitionRequired, getLatestTableDefinitionSchema, getNamespaceSet, getSchema, getSchema, getSchemas, getSchemas, getSchemasForNamespaceSet, initializationStage, listAllTables, listNamespaces, listNamespaces, listNamespaces, listNamespaces, listNamespaces, listTableNames, listTableNames, removeNamespace, removeNamespace, shutdown, updateSchema, updateSchema, updateSchema, updateSchema

Method Details

createNamespace

boolean createNamespace(@NotNull
 NamespaceSet namespaceSet,
 @NotNull
 String namespaceName,
 @NotNull
 io.deephaven.enterprise.auth.UserContext userContext,
 @NotNull
 String code,
 @NotNull
 String comment)

Adds a UserContext parameter to SchemaService.createNamespace(NamespaceSet, String, String, String)

Parameters:

namespaceSet - add namespaceName to this namespace set

namespaceName - name of the new namespace

userContext - pass-thru to kv persistence, indicates the user making this change

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

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

Returns:

true if the namespace was created, false if it already exists

Throws:

SchemaException - if the namespace could not be added to the given namespace set

removeNamespace

void removeNamespace(@NotNull
 String namespaceName,
 @NotNull
 io.deephaven.enterprise.auth.UserContext userContext,
 @NotNull
 String code,
 @NotNull
 String comment)

Adds a UserContext parameter to SchemaService.removeNamespace(String, String, String)

Parameters:

namespaceName - name of the namespace

userContext - pass-thru to kv persistence, indicates the user making this change

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

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

addSchema

Schema addSchema(@NotNull
 Schema newSchema,
 @NotNull
 io.deephaven.enterprise.auth.UserContext userContext,
 @NotNull
 String code,
 @NotNull
 String comment)
          throws SchemaException

Adds a UserContext parameter to SchemaService.addSchema(Schema, String, String)

Parameters:

newSchema - the schema to add

userContext - pass-thru to kv persistence, indicates the user making this change

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

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

Throws:

SchemaException

updateSchema

Schema updateSchema(@NotNull
 Schema newSchema,
 @NotNull
 io.deephaven.enterprise.auth.UserContext userContext,
 @NotNull
 String code,
 @NotNull
 String comment)
             throws IllegalArgumentException,
SchemaException

Adds a UserContext parameter to SchemaService.updateSchema(Schema, String, String)

Parameters:

newSchema - the schema to update

userContext - pass-thru to kv persistence, indicates the user making this change

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

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

Throws:

IllegalArgumentException

SchemaException

deleteSchema

void deleteSchema(@NotNull
 String namespace,
 @NotNull
 String tableName,
 @NotNull
 io.deephaven.enterprise.auth.UserContext userContext,
 @NotNull
 String code,
 @NotNull
 String comment)
           throws IllegalArgumentException,
SchemaException

Adds a UserContext parameter to SchemaService.deleteSchema(String, String, String, String)

Parameters:

namespace - the namespace of the schema to delete

tableName - the name of the schema to delete

userContext - pass-thru to kv persistence, indicates the user making this change

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

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

Throws:

IllegalArgumentException

SchemaException