public final class KernelAdminConnection extends AbstractAdminConnection
NO_TIMEOUT
Constructor and Description |
---|
KernelAdminConnection(com.complexible.stardog.Kernel theKernel,
org.apache.shiro.subject.Subject theSubject,
Options theOptions,
Views<AdminConnection> theViews) |
Modifier and Type | Method and Description |
---|---|
protected void |
_close() |
protected Metadata |
_get(String theName,
Iterable<? extends MetaProperty<?>> theOptions) |
protected <T> String |
_set(String theName,
MetaProperty<T> theOption,
T theValue) |
String |
backup(String theDatabase,
Optional<String> theBackupUrl,
Options theOptions)
Create a backup of the given database in the specified location.
|
String |
backupAll()
Create a backup of the server to the default location.
|
String |
backupAll(File theLocation)
Create a backup of the server in the specified location.
|
String |
backupAll(String theLocation)
Create a backup of the server in the specified location.
|
<T> T |
call(Callable<T> theAction) |
void |
changeEncryptionPassword(String theOldPassword,
String theNewPassword)
Change the user managed encryption password.
|
void |
createNewEncryptionKey(String thePassPhrase,
String keyName)
Add a new key for encrypting data.
|
Map<String,Object> |
currentStatus(Options theOptions)
Return the server status information, including Server/Protocols running, Stardog Home path, OS, etc.
|
void |
disableEncryption(String thePassPhrase)
Stop the server from using data encryption on all future data.
|
String |
drop(String theName)
Drop the database with the given name.
|
Collection<String> |
fileKeyList(String thePassPhrase)
Return the list of keys which have been used for encryption.
|
PermissionManager |
getPermissionManager()
Return the
PermissionManager for changing user & role permissions |
Metadata |
getProperty(Collection<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.
|
UserManager |
getUserManager()
Return the
UserManager to be used for user-centric security changes |
Collection<String> |
list()
List all of the databases in the Stardog server
|
DatabaseBuilder |
newDatabaseBuilder() |
String |
offline(String theName,
long theTime,
TimeUnit theTimeUnit)
Take the database offline waiting up to the specified timeout before performing a hard off-line.
|
String |
online(String theName)
Makes the database online according to the default strategy
|
String |
optimize(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(String thePassword)
Remove the user managed password for the encryption of data.
|
String |
repair(String theName)
Repairs the specified database if it is corrupted.
|
String |
restore(File theBackup,
boolean theOverwrite,
String theName)
Restore the database backed up to the given location
|
String |
restore(String theBackup,
boolean theOverwrite,
String theName) |
void |
run(Runnable theAction) |
void |
setEncryptionPassword(String thePassword)
Encrypt all data keys against the given password.
|
String |
setProperty(String thePropertyName,
String theNewValue)
Requests that the specified server configuration option value be changed to the new value.
|
void |
shutdown()
Shutdown the remote Stardog server.
|
String |
verify(String theName)
Verify the integrity of specified database's index.
|
as, assertOpen, assertValidName, builder, close, disk, get, get, isOpen, newDatabase, offline, set
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
backup, backup, backup, currentStatus, optimize
public KernelAdminConnection(com.complexible.stardog.Kernel theKernel, org.apache.shiro.subject.Subject theSubject, Options theOptions, Views<AdminConnection> theViews)
protected void _close()
_close
in class AbstractAdminConnection
public DatabaseBuilder newDatabaseBuilder()
newDatabaseBuilder
in class AbstractAdminConnection
protected Metadata _get(String theName, Iterable<? extends MetaProperty<?>> theOptions) throws StardogException
_get
in class AbstractAdminConnection
StardogException
protected <T> String _set(String theName, MetaProperty<T> theOption, T theValue) throws StardogException
_set
in class AbstractAdminConnection
StardogException
public Metadata getProperty(Collection<String> thePropertyNames) throws StardogException
StardogException
public String setProperty(String thePropertyName, String theNewValue) throws StardogException
StardogException
public String offline(String theName, long theTime, 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.
theName
- name of the databasetheTime
- timeout duration, must be a positive numbertheTimeUnit
- the unit of time for the timeout, cannot be nullStardogException
- if there was an error while offlining the databasepublic String online(String theName) throws StardogException
theName
- the name of the databaseStardogException
- if there was an error while onlining the databasepublic String optimize(String theName, Metadata theOptions) throws StardogException
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.
theName
- the name of the database to optimizetheOptions
- options specifying the specific optimization steps to perform or empty for default optimizationsStardogException
- if an error occurs during optimizationpublic Collection<String> list() throws StardogException
StardogException
- if there was an error getting the listpublic String repair(String theName) throws StardogException
theName
- the name of the database to repairStardogException
- if there was an error while repairingpublic String verify(String theName) throws StardogException
theName
- the name of the database to verifyStardogException
- if there was an error while verifying the databasepublic void shutdown() throws com.complexible.stardog.security.StardogSecurityException
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.public String drop(String theName) throws StardogException
theName
- the name of the database to dropStardogException
- if there was an error while dropping the databasepublic void setEncryptionPassword(String thePassword) throws StardogException
thePassword
- the password that will protect the encryption keysStardogException
public void changeEncryptionPassword(String theOldPassword, String theNewPassword) throws StardogException
theOldPassword
- the current passwordtheNewPassword
- the new passwordStardogException
public void removeEncryptionPassword(String thePassword) throws StardogException
thePassword
- the current passwordStardogException
public void createNewEncryptionKey(String thePassPhrase, String keyName) throws StardogException
thePassPhrase
- the current encryption password. If no password is in use this
can be an empty stringkeyName
- the name of the key. This must be unique to the systemStardogException
public void disableEncryption(String thePassPhrase) throws StardogException
thePassPhrase
- the current encryption password. If no password is in use this
can be an empty stringStardogException
public Collection<String> fileKeyList(String thePassPhrase) throws StardogException
thePassPhrase
- the current encryption password. If no password is in use this
can be an empty stringStardogException
- if there is an error performing the backup.public String backup(String theDatabase, Optional<String> theBackupUrl, Options theOptions) throws StardogException
AdminConnection
Configuration options
can be specified for the backup operation.theDatabase
- the name of the database to back uptheBackupUrl
- where to store the backup or empty if the default location should be usedtheOptions
- configuration options to use for backupsStardogException
public String backupAll() throws StardogException
StardogException
- if there is an error performing the backup.public String backupAll(String theLocation) throws StardogException
theLocation
- where to store the backupStardogException
- if there is an error performing the backup.public String backupAll(File theLocation) throws StardogException
theLocation
- where to store the backupStardogException
- if there is an error performing the backup.public String restore(File theBackup, boolean theOverwrite, String theName) throws StardogException
theBackup
- the location of the backuptheOverwrite
- whether or not to overwrite any existing databasetheName
- a new name for the restored databaseStardogException
- if there was an error restoring the database from a backuppublic String restore(String theBackup, boolean theOverwrite, String theName) throws StardogException
StardogException
public UserManager getUserManager()
UserManager
to be used for user-centric security changespublic RoleManager getRoleManager()
RoleManager
to be used for role-centric security changespublic PermissionManager getPermissionManager()
PermissionManager
for changing user & role permissionspublic QueryManager getQueryManager()
QueryManager
for managing running queriespublic Map<String,Object> currentStatus(Options theOptions) throws StardogException
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
.theOptions
- StardogException
- if there was an error retrieving the DBMS infoMetricOptions
public StoredQueries getStoredQueries()
public com.complexible.stardog.StoredFunctions getStoredFunctions()
public void run(Runnable theAction)
public <T> T call(Callable<T> theAction)
Copyright © 2010-2016 Stardog Union. All Rights Reserved.