Package io.deephaven.dhservice.client

Class SchemaServiceGrpcImpl

java.lang.Object
io.deephaven.dhservice.client.SchemaServiceGrpcImpl
All Implemented Interfaces:
SchemaService, SchemaServiceUtilLayer, NamedImplementation, AuthenticatedService, SchemaServiceBase, AutoCloseable
public class SchemaServiceGrpcImpl extends Object implements SchemaServiceUtilLayer, AuthenticatedService, AutoCloseable
Delegate all calls to a remote service.

  • Method Details

    • make

      public static SchemaService make() throws IOException, ClientConnectionConfigProvider.ProviderException
      Create an instance using system defaults.
      Returns:
      a new instance
      Throws:
      IOException
      ClientConnectionConfigProvider.ProviderException

    • make

      public static SchemaService make(@NotNull @NotNull ClientConnectionConfig config) throws SSLException
      Create an instance with the given config.
      Parameters:
      config - use this ClientConnectionConfig
      Returns:
      a new instance
      Throws:
      SSLException

    • 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

    • getLatestSchema

      @Nullable public @Nullable Schema getLatestSchema(@NotNull @NotNull String namespace, @NotNull @NotNull String tableName)
      Description copied from interface: SchemaService
      Get the latest version of the Schema defined by namespace and table name
      Specified by:
      getLatestSchema in interface SchemaService
      Parameters:
      namespace - the namespace of the table
      tableName - the table name
      Returns:
      the latest version of namespace.tablename or null if none was found

    • getLatestSchemaXml

      public SchemaXml getLatestSchemaXml(@NotNull @NotNull String namespace, @NotNull @NotNull String tableName)
      Description copied from interface: SchemaService
      Get the latest version of the Schema defined by namespace and table name, as an implementation supporting SchemaXml.
      Specified by:
      getLatestSchemaXml in interface SchemaService
      Parameters:
      namespace - the namespace of the table
      tableName - the table name
      Returns:
      the latest version of namespace.tablename or null if none was found

    • getSchema

      @Nullable public @Nullable Schema getSchema(@NotNull @NotNull String namespace, @NotNull @NotNull String tableName, @NotNull @NotNull SchemaVersion version)
      Description copied from interface: SchemaService
      Get the specified version of the Schema defined by namespace and table name
      Specified by:
      getSchema in interface SchemaService
      Parameters:
      namespace - the namespace of the table
      tableName - the table name
      version - the version of this schema to retrieve
      Returns:
      the requested version of the schema for namespace.tableName or null if none was found

    • getAllSchemas

      @NotNull public @NotNull Collection<Schema> getAllSchemas()
      Description copied from interface: SchemaService
      Get a collection of all known schemas in the system. The latest version of each will be returned. // TODO: subject to ACL visibility?
      Specified by:
      getAllSchemas in interface SchemaService
      Returns:
      a collection of all known schemas

    • getSchemas

      @NotNull public @NotNull Collection<Schema> getSchemas(@NotNull @NotNull NamespaceSet namespaceSet)
      Description copied from interface: SchemaService
      Get a collection of all known schemas in the system, with the given namespace set. The latest version of each will be returned.
      Specified by:
      getSchemas in interface SchemaService
      Returns:
      a collection of all known schemas in the given namespace set

    • getSchemas

      @NotNull public @NotNull Collection<Schema> getSchemas(@NotNull @NotNull String namespace)
      Description copied from interface: SchemaService
      Get a collection of all known schemas in the given namespace. The latest version of each will be returned.
      Specified by:
      getSchemas in interface SchemaService
      Returns:
      a collection of all known schemas in the given namespace

    • getLatestTableDefinitionSchema

      @Nullable public @Nullable TableDefinitionSchema getLatestTableDefinitionSchema(@NotNull @NotNull String namespace, @NotNull @NotNull String tableName)
      Description copied from interface: SchemaService
      Get the latest version of the TableDefinitionSchema defined by namespace and table name
      Specified by:
      getLatestTableDefinitionSchema in interface SchemaService
      Parameters:
      namespace - the namespace of the table
      tableName - the table name
      Returns:
      the latest version of namespace.tableName or null if none was found

    • getNamespaceSet

      @NotNull public @NotNull NamespaceSet getNamespaceSet(@NotNull @NotNull String namespace) throws IllegalArgumentException
      Description copied from interface: SchemaService
      Get the NamespaceSet for a particular namespace.
      Specified by:
      getNamespaceSet in interface SchemaService
      Parameters:
      namespace - The namespace name
      Returns:
      the namespace set of the namespace
      Throws:
      IllegalArgumentException - if the namespace does not exist

    • containsNamespace

      public boolean containsNamespace(@NotNull @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

    • containsSchema

      public boolean containsSchema(@NotNull @NotNull String namespace, @NotNull @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 @NotNull 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

    • listNamespaces

      @NotNull public @NotNull Collection<String> listNamespaces(@NotNull @NotNull NamespaceSet namespaceSet, boolean includeDeleted)
      Description copied from interface: SchemaService
      Get a collection of the namespaces available in the given namespace set.
      Specified by:
      listNamespaces in interface SchemaService
      Parameters:
      namespaceSet - list namespaces in this set (User, System)
      includeDeleted - true if deleted namespaces should be included
      Returns:
      a collection of namespace names

    • listTableNames

      @NotNull public @NotNull Collection<String> listTableNames(@NotNull @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

    • listAllTables

      @NotNull public @NotNull Map<NamespaceSet,Map<String,Collection<String>>> listAllTables()
      Description copied from interface: SchemaService
      Get a map of all known tables in all known namespaces for all namespace sets.
      Specified by:
      listAllTables in interface SchemaService
      Returns:
      all the table names, mapped by namespace set and namespace

    • createNamespace

      public boolean createNamespace(@NotNull @NotNull NamespaceSet namespaceSet, @NotNull @NotNull String namespaceName) throws SchemaException
      Description copied from interface: SchemaService
      Add a namespace with the given name to the schema service, in the requested namespace set. Returns true if the namespace was added, false if it already exists. Throws a SchemaException if the namespace could not be added.
      Specified by:
      createNamespace in interface SchemaService
      Parameters:
      namespaceSet - add namespaceName to this namespace set
      namespaceName - name of the new namespace
      Returns:
      true if the namespace was added, false if it already exists.
      Throws:
      SchemaException - if the namespace could not be added to the given namespace set

    • createNamespace

      public boolean createNamespace(@NotNull @NotNull NamespaceSet namespaceSet, @NotNull @NotNull String namespaceName, @NotNull @NotNull String code, @NotNull @NotNull String comment) throws SchemaException
      Description copied from interface: SchemaService
      Add a namespace with the given name to the schema service, in the requested namespace set. Returns true if the namespace was added, false if it already exists. Throws a SchemaException if the namespace could not be added.
      Specified by:
      createNamespace in interface SchemaService
      Parameters:
      namespaceSet - add namespaceName to this namespace set
      namespaceName - name of the new namespace
      code - pass-thru to kv persistence, indicates the code source of this update
      comment - pass-thru to kv persistence - a comment for this update
      Returns:
      true if the namespace was added, false if it already exists.
      Throws:
      SchemaException - if the namespace could not be added to the given namespace set

    • removeNamespace

      public void removeNamespace(@NotNull @NotNull String namespaceName, @NotNull @NotNull String code, @NotNull @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

    • removeNamespace

      public void removeNamespace(@NotNull @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

    • addSchema

      @NotNull public @NotNull Schema addSchema(@NotNull @NotNull Schema newSchema) throws SchemaException
      Description copied from interface: SchemaService
      Add the specified schema to the service.
      Specified by:
      addSchema in interface SchemaService
      Parameters:
      newSchema - the schema to add
      Returns:
      the schema actually stored in the SchemaService
      Throws:
      SchemaException - if the schema could not be added

    • addSchema

      @NotNull public @NotNull Schema addSchema(@NotNull @NotNull Schema newSchema, @NotNull @NotNull String code, @NotNull @NotNull String comment) throws SchemaException
      Description copied from interface: SchemaService
      Add the specified schema to the service.
      Specified by:
      addSchema in interface SchemaService
      Parameters:
      newSchema - the schema to add
      code - pass-thru to kv persistence, indicates the code source of this update
      comment - pass-thru to kv persistence - a comment for this update
      Returns:
      the schema actually stored in the SchemaService
      Throws:
      SchemaException - if the schema could not be added

    • addSchema

      @NotNull public @NotNull Schema addSchema(@NotNull @NotNull TableDefinitionSchema newSchema) throws SchemaException
      Description copied from interface: SchemaService
      Add the specified schema to the service.
      Specified by:
      addSchema in interface SchemaService
      Parameters:
      newSchema - the schema to add
      Returns:
      the schema actually stored in the SchemaService
      Throws:
      SchemaException - if the schema could not be added or already exists

    • addSchema

      @NotNull public @NotNull Schema addSchema(@NotNull @NotNull TableDefinitionSchema newSchema, @NotNull @NotNull String code, @NotNull @NotNull String comment) throws SchemaException
      Description copied from interface: SchemaService
      Add the specified schema to the service.
      Specified by:
      addSchema in interface SchemaService
      Parameters:
      newSchema - the schema to add
      code - pass-thru to kv persistence, indicates the code source of this update
      comment - pass-thru to kv persistence - a comment for this update
      Returns:
      the schema actually stored in the SchemaService
      Throws:
      SchemaException - if the schema could not be added or already exists

    • updateSchema

      @NotNull public @NotNull Schema updateSchema(@NotNull @NotNull Schema newSchema) throws IllegalArgumentException, SchemaException
      Description copied from interface: SchemaService
      Update the schema with the same namespace and table name with the specified new schema.
      Specified by:
      updateSchema in interface SchemaService
      Parameters:
      newSchema - the schema to update with
      Throws:
      IllegalArgumentException - if the namespace or table does not exist
      SchemaException - if the schema could not be updated

    • updateSchema

      @NotNull public @NotNull Schema updateSchema(@NotNull @NotNull Schema newSchema, @NotNull @NotNull String code, @NotNull @NotNull String comment) throws IllegalArgumentException, SchemaException
      Description copied from interface: SchemaService
      Update the schema with the same namespace and table name with the specified new schema.
      Specified by:
      updateSchema in interface SchemaService
      Parameters:
      newSchema - the schema to update with
      code - pass-thru to kv persistence, indicates the code source of this update
      comment - pass-thru to kv persistence - a comment for this update
      Returns:
      the schema actually stored in the SchemaService
      Throws:
      IllegalArgumentException - if the namespace or table does not exist
      SchemaException - if the schema could not be updated

    • updateSchema

      @NotNull public @NotNull Schema updateSchema(@NotNull @NotNull TableDefinitionSchema newSchema) throws IllegalArgumentException, SchemaException
      Description copied from interface: SchemaService
      Update the schema with the same namespace and table name with the specified new schema.
      Specified by:
      updateSchema in interface SchemaService
      Parameters:
      newSchema - the schema to update with.
      Returns:
      the schema actually stored in the SchemaService
      Throws:
      IllegalArgumentException - if the namespace or table does not exist
      SchemaException - if the schema could not be updated

    • updateSchema

      @NotNull public @NotNull Schema updateSchema(@NotNull @NotNull TableDefinitionSchema newSchema, @NotNull @NotNull String code, @NotNull @NotNull String comment) throws IllegalArgumentException, SchemaException
      Description copied from interface: SchemaService
      Update the schema with the same namespace and table name with the specified new schema.
      Specified by:
      updateSchema in interface SchemaService
      Parameters:
      newSchema - the schema to update with.
      code - pass-thru to kv persistence, indicates the code source of this update
      comment - pass-thru to kv persistence - a comment for this update
      Returns:
      the schema actually stored in the SchemaService
      Throws:
      IllegalArgumentException - if the namespace or table does not exist
      SchemaException - if the schema could not be updated

    • deleteSchema

      public void deleteSchema(@NotNull @NotNull String namespace, @NotNull @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 @NotNull String namespace, @NotNull @NotNull String tableName, @NotNull @NotNull String code, @NotNull @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

    • authenticate

      public boolean authenticate()
      Description copied from interface: AuthenticatedService
      Attempt default authentication if this is not already authenticated.
      Specified by:
      authenticate in interface AuthenticatedService
      Returns:
      true if authentication succeeded, else false

    • authenticate

      public boolean authenticate(@NotNull @NotNull String keyFile)
      Description copied from interface: AuthenticatedService
      Authenticate, or re-authenticate using the given private key file.
      Specified by:
      authenticate in interface AuthenticatedService
      Returns:
      true if authentication succeeded, else false

    • authenticate

      public boolean authenticate(@NotNull @NotNull String user, @NotNull @NotNull String password, @Nullable @Nullable String operateAsUser)
      Description copied from interface: AuthenticatedService
      Authenticate, or re-authenticate using the given credentials.
      Specified by:
      authenticate in interface AuthenticatedService
      Parameters:
      user - user to authenticate
      password - password for authentication
      operateAsUser - optional operate-as user
      Returns:
      true if authentication succeeded, else false

    • authenticate

      public boolean authenticate(@NotNull @NotNull String user, @NotNull @NotNull String password)
      Description copied from interface: AuthenticatedService
      Authenticate, or re-authenticate using the given credentials.
      Specified by:
      authenticate in interface AuthenticatedService
      Parameters:
      user - user to authenticate
      password - password for authentication
      Returns:
      true if authentication succeeded, else false

    • setTokenFactoryFactory

      public boolean setTokenFactoryFactory(@Nullable @Nullable TokenFactoryFactory tokenAuthenticationManager)
      Description copied from interface: AuthenticatedService
      Set the authentication client manager to use for token generation. If tokenAuthenticationManager is null or is not already authenticated, this call will de-authenticate the connection.
      Specified by:
      setTokenFactoryFactory in interface AuthenticatedService
      Parameters:
      tokenAuthenticationManager - the authentication client manager to be used for future calls.
      Returns:
      true if authentication succeeded, else false

    • getAuthenticatedUser

      public UserContext getAuthenticatedUser()
      Specified by:
      getAuthenticatedUser in interface AuthenticatedService