Package com.complexible.stardog.api

Class KernelAdminConnection

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected void _close()
      protected Metadata _get​(java.lang.String theName, java.lang.Iterable<? extends MetaProperty<?>> theOptions)
      protected <T> java.lang.String _set​(java.lang.String theName, MetaProperty<T> theOption, T theValue)
      java.lang.String backup​(java.lang.String theDatabase, java.util.Optional<java.lang.String> theBackupUrl, Options theOptions)
      Create a backup of the given database in the specified location.
      java.lang.String backupAll​(Options theOptions)
      Create a backup of the server in the specified location.
      <T> T call​(java.util.concurrent.Callable<T> theAction)  
      void changeEncryptionPassword​(java.lang.String theOldPassword, java.lang.String theNewPassword)
      Change the user managed encryption password.
      java.util.Collection<java.lang.String> checkpoint​(java.lang.String theDatabase, Options theOptions)
      Perform a checkpoint operation (list, create, restore) against selected database.
      void createNewEncryptionKey​(java.lang.String thePassPhrase, java.lang.String keyName)
      Add a new key for encrypting data.
      java.util.Map<java.lang.String,​java.lang.Object> currentStatus​(Options theOptions)
      Return the server status information, including Server/Protocols running, Stardog Home path, OS, etc.
      void disableEncryption​(java.lang.String thePassPhrase)
      Stop the server from using data encryption on all future data.
      java.lang.String drop​(java.lang.String theName)
      Drop the database with the given name.
      java.util.Collection<java.lang.String> fileKeyList​(java.lang.String thePassPhrase)
      Return the list of keys which have been used for encryption.
      java.io.File generateDiagnosticReport​(com.complexible.stardog.util.report.DiagnosticsReport theDiagnosticsReport)
      PermissionManager getPermissionManager()
      Return the PermissionManager for changing user & role permissions
      com.complexible.stardog.process.ProcessManager getProcessManager()  
      Metadata getProperty​(java.util.Collection<java.lang.String> thePropertyNames)
      Gets the property value for a server configuration option.
      QueryManager getQueryManager()
      Return the QueryManager for managing running queries
      RoleManager getRoleManager()
      Return the RoleManager to be used for role-centric security changes
      com.complexible.stardog.StoredFunctions getStoredFunctions()
      Returns the stored functions in this server.
      StoredQueries getStoredQueries()
      Returns the stored queries in this server.
      com.complexible.stardog.security.TokenManager getTokenManager()
      Return a link to the object that will allow clients to interact with JWT bearer tokens
      UserManager getUserManager()
      Return the UserManager to be used for user-centric security changes
      java.util.Collection<java.lang.String> list()
      List all the databases in the Stardog server
      DatabaseBuilder newDatabaseBuilder()
      java.lang.String offline​(java.lang.String theName, long theTime, java.util.concurrent.TimeUnit theTimeUnit)
      Take the database offline waiting up to the specified timeout before performing a hard off-line.
      java.lang.String online​(java.lang.String theName)
      Makes the database online according to the default strategy
      java.lang.String optimize​(java.lang.String theName, Metadata theOptions)
      Optimizes the indexes of a given database for query answering and disk utilization after the database has been heavily modified.
      void removeEncryptionPassword​(java.lang.String thePassword)
      Remove the user managed password for the encryption of data.
      java.lang.String repair​(java.lang.String theName)
      Repairs the specified database if it is corrupted.
      java.lang.String restore​(java.io.File theBackup, boolean theOverwrite, java.lang.String theName)
      Restore the database backed up to the given location
      java.lang.String restore​(java.lang.String theBackup, boolean theOverwrite, java.lang.String theName)
      void run​(java.lang.Runnable theAction)  
      void setEncryptionPassword​(java.lang.String thePassword)
      Encrypt all data keys against the given password.
      java.lang.String setProperty​(java.lang.String thePropertyName, java.lang.String theNewValue)
      Requests that the specified server configuration option value be changed to the new value.
      void shutdown()
      Shutdown the remote Stardog server.
      java.lang.String verify​(java.lang.String theName)
      Verify the integrity of specified database's index.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • KernelAdminConnection

        public KernelAdminConnection​(com.complexible.stardog.Kernel theKernel)

      • KernelAdminConnection

        public KernelAdminConnection​(com.complexible.stardog.Kernel theKernel,
                             org.apache.shiro.subject.Subject theSubject,
                             Options theOptions,
                             Views<AdminConnection> theViews)

    • Method Detail

      • getProperty

        public Metadata getProperty​(java.util.Collection<java.lang.String> thePropertyNames)
                     throws StardogException
        Gets the property value for a server configuration option. This value will be the default for the option or the override in the properties file.
        Parameters:
        thePropertyNames - filter for the properties to return. Empty set will match all properties.
        Returns:
        Metadata created with config values "MetaProperty.config(key, value).temporary().build()"
        Throws:
        StardogException

      • setProperty

        public java.lang.String setProperty​(java.lang.String thePropertyName,
                                    java.lang.String theNewValue)
                             throws StardogException
        Requests that the specified server configuration option value be changed to the new value. This method will notify any listening server modules about the change request. It is not guaranteed that the listening module will update the value.
        Returns:
        Throws:
        StardogException

      • offline

        public java.lang.String offline​(java.lang.String theName,
                                long theTime,
                                java.util.concurrent.TimeUnit theTimeUnit)
                         throws StardogException

        Take the database offline waiting up to the specified timeout before performing a hard off-line. A database going offline will allow open connections to complete, but will not accept new, incoming connections.

        Offline databases cannot be queried or updated and will be unaccessible to users.

        Specifying a timeout of 0 will immediately shut down the database severing all open connections, i.e. a hard shutdown.

        Parameters:
        theName - name of the database
        theTime - timeout duration, must be a positive number
        theTimeUnit - the unit of time for the timeout, cannot be null
        Returns:
        the server output of offline
        Throws:
        StardogException - if there was an error while offlining the database

      • online

        public java.lang.String online​(java.lang.String theName)
                        throws StardogException
        Makes the database online according to the default strategy
        Parameters:
        theName - the name of the database
        Returns:
        the server output of onlining the database
        Throws:
        StardogException - if there was an error while onlining the database

      • optimize

        public java.lang.String optimize​(java.lang.String theName,
                                 Metadata theOptions)
                          throws StardogException
        Optimizes the indexes of a given database for query answering and disk utilization after the database has been heavily modified. If a database has been modified with a large number of additions or removals, some internal structures may become less optimized for query answering. This utility will perform several operations that will help with query answering performance. Which operations are performed depends on the options given.

        Optimization will NOT modify the database contents. The data layout, indexes and other internal structures might change but the data stored in the database will remain same.

        Parameters:
        theName - the name of the database to optimize
        theOptions - options specifying the specific optimization steps to perform or empty for default optimizations
        Returns:
        the server output of optimize
        Throws:
        StardogException - if an error occurs during optimization

      • list

        public java.util.Collection<java.lang.String> list()
                                            throws StardogException
        List all the databases in the Stardog server
        Returns:
        the list of databases
        Throws:
        StardogException - if there was an error getting the list

      • repair

        public java.lang.String repair​(java.lang.String theName)
                        throws StardogException
        Repairs the specified database if it is corrupted. If the database is not corrupted, nothing will be repaired.
        Parameters:
        theName - the name of the database to repair
        Returns:
        the server output of the repair
        Throws:
        StardogException - if there was an error while repairing

      • verify

        public java.lang.String verify​(java.lang.String theName)
                        throws StardogException
        Verify the integrity of specified database's index.
        Parameters:
        theName - the name of the database to verify
        Returns:
        the output of the verify operation
        Throws:
        StardogException - if there was an error while verifying the database

      • shutdown

        public void shutdown()
              throws com.complexible.stardog.security.StardogSecurityException
        Shutdown the remote Stardog server. You must be connected to the server as a super-user.
        Throws:
        com.complexible.stardog.security.StardogSecurityException - if you are attempting to shut down the embedded server or if you are not a super-user and are trying to shut down a remote server.

      • drop

        public java.lang.String drop​(java.lang.String theName)
                      throws StardogException
        Drop the database with the given name.
        Parameters:
        theName - the name of the database to drop
        Returns:
        the Result of the invocation
        Throws:
        StardogException - if there was an error while dropping the database

      • setEncryptionPassword

        public void setEncryptionPassword​(java.lang.String thePassword)
                           throws StardogException
        Encrypt all data keys against the given password. This will issue a command to Stardog which will set a user managed password for the encryption of data. If this is not set Stardog will fully manage the encryption keys and all secrets that access them.
        Parameters:
        thePassword - the password that will protect the encryption keys
        Throws:
        StardogException

      • changeEncryptionPassword

        public void changeEncryptionPassword​(java.lang.String theOldPassword,
                                     java.lang.String theNewPassword)
                              throws StardogException
        Change the user managed encryption password.
        Parameters:
        theOldPassword - the current password
        theNewPassword - the new password
        Throws:
        StardogException

      • removeEncryptionPassword

        public void removeEncryptionPassword​(java.lang.String thePassword)
                              throws StardogException
        Remove the user managed password for the encryption of data. Once this is removed Stardog will maintain the unencrypted keys which are used to encrypt the data.
        Parameters:
        thePassword - the current password
        Throws:
        StardogException

      • createNewEncryptionKey

        public void createNewEncryptionKey​(java.lang.String thePassPhrase,
                                   java.lang.String keyName)
                            throws StardogException
        Add a new key for encrypting data. This will create a new Stardog managed encryption key. All data added after this new key is created will be encrypted with it. Any previously added data will not be affected by it. If a user managed password has been set then it must be passed in.
        Parameters:
        thePassPhrase - the current encryption password. If no password is in use this can be an empty string
        keyName - the name of the key. This must be unique to the system
        Throws:
        StardogException

      • disableEncryption

        public void disableEncryption​(java.lang.String thePassPhrase)
                       throws StardogException
        Stop the server from using data encryption on all future data. Currently encrypted data will be left encrypted. To re-enable encryption createNewEncryptionKey can be called again.
        Parameters:
        thePassPhrase - the current encryption password. If no password is in use this can be an empty string
        Throws:
        StardogException

      • fileKeyList

        public java.util.Collection<java.lang.String> fileKeyList​(java.lang.String thePassPhrase)
                                                   throws StardogException
        Return the list of keys which have been used for encryption.
        Parameters:
        thePassPhrase - the current encryption password. If no password is in use this can be an empty string
        Returns:
        - the Result of the invocation;
        Throws:
        StardogException - if there is an error performing the backup.

      • backup

        public java.lang.String backup​(java.lang.String theDatabase,
                               java.util.Optional<java.lang.String> theBackupUrl,
                               Options theOptions)
                        throws StardogException
        Description copied from interface: AdminConnection
        Create a backup of the given database in the specified location. The location can be a file path on the server or a URL pointing to S3 or GCP. Configuration options can be specified for the backup operation.
        Parameters:
        theDatabase - the name of the database to back up
        theBackupUrl - where to store the backup or empty if the default location should be used
        theOptions - configuration options to use for backups
        Returns:
        Throws:
        StardogException

      • backupAll

        public java.lang.String backupAll​(Options theOptions)
                           throws StardogException
        Create a backup of the server in the specified location.
        Parameters:
        theOptions - Collection of BackupOptions
        Returns:
        the output of the backup process
        Throws:
        StardogException - if there is an error performing the backup.

      • restore

        public java.lang.String restore​(java.io.File theBackup,
                                boolean theOverwrite,
                                java.lang.String theName)
                         throws StardogException
        Restore the database backed up to the given location
        Parameters:
        theBackup - the location of the backup
        theOverwrite - whether or not to overwrite any existing database
        theName - a new name for the restored database
        Returns:
        the output of the restore process
        Throws:
        StardogException - if there was an error restoring the database from a backup

      • restore

        public java.lang.String restore​(java.lang.String theBackup,
                                boolean theOverwrite,
                                java.lang.String theName)
                         throws StardogException
        Throws:
        StardogException

      • checkpoint

        public java.util.Collection<java.lang.String> checkpoint​(java.lang.String theDatabase,
                                                         Options theOptions)
                                                  throws StardogException
        Description copied from interface: AdminConnection
        Perform a checkpoint operation (list, create, restore) against selected database.
        Parameters:
        theDatabase - the name of the database for checkpoint operation
        theOptions - configuration options for the checkpoint
        Returns:
        Throws:
        StardogException

      • getUserManager

        public UserManager getUserManager()
        Return the UserManager to be used for user-centric security changes
        Returns:
        the UserManager

      • getRoleManager

        public RoleManager getRoleManager()
        Return the RoleManager to be used for role-centric security changes
        Returns:
        the RoleManager

      • getProcessManager

        public com.complexible.stardog.process.ProcessManager getProcessManager()
        Returns:
        The ProcessManager for managing running queries

      • getTokenManager

        public com.complexible.stardog.security.TokenManager getTokenManager()
        Return a link to the object that will allow clients to interact with JWT bearer tokens
        Returns:
        the TokenManager

      • currentStatus

        public java.util.Map<java.lang.String,​java.lang.Object> currentStatus​(Options theOptions)
                                                                     throws StardogException
        Return the server status information, including Server/Protocols running, Stardog Home path, OS, etc. The options can be used to configure which metrics will be included in the results. The embedded connections do not support any options other than MetricOptions.DATABASES.
        Parameters:
        theOptions -
        Returns:
        the metrics showing the server status
        Throws:
        StardogException - if there was an error retrieving the DBMS info
        See Also:
        MetricOptions

      • generateDiagnosticReport

        public java.io.File generateDiagnosticReport​(com.complexible.stardog.util.report.DiagnosticsReport theDiagnosticsReport)

      • getStoredQueries

        public StoredQueries getStoredQueries()
        Returns the stored queries in this server. Returned object can be used to add and remove stored queries.
        Returns:
        the stored queries

      • getStoredFunctions

        public com.complexible.stardog.StoredFunctions getStoredFunctions()
        Returns the stored functions in this server. Returned object can be used to add and remove stored functions.
        Returns:
        the stored functions

      • run

        public void run​(java.lang.Runnable theAction)

      • call

        public <T> T call​(java.util.concurrent.Callable<T> theAction)