public abstract class AbstractAdminConnection extends Object implements AdminConnection
NO_TIMEOUT
Constructor and Description |
---|
AbstractAdminConnection(Views<AdminConnection> theViews) |
Modifier and Type | Method and Description |
---|---|
protected abstract void |
_close() |
protected abstract Metadata |
_get(String theName,
Iterable<? extends MetaProperty<?>> theOptions) |
protected abstract <T> String |
_set(String theName,
MetaProperty<T> theOption,
T theValue) |
<T extends AdminConnection> |
as(Class<T> theView)
Return this admin connection viewed as a different type of admin connection.
|
protected void |
assertOpen()
Assert that the client is currently logged into the Stardog server
|
protected void |
assertValidName(String theName) |
DatabaseBuilder |
builder(Metadata theOptions)
Convenience method to create a database builder with the given options.
|
void |
close()
Log out of the Stardog server and close the client.
|
DatabaseBuilder |
disk(String theName)
Create a new builder for creating disk databases
|
Metadata |
get(String theName,
Iterable<? extends MetaProperty<?>> theOptions)
Gets the values of the specified options in the given database.
|
<T> T |
get(String theName,
MetaProperty<T> theOption)
Gets the value of the specified option in the given database.
|
boolean |
isOpen()
Return whether or not this connection is open.
|
DatabaseBuilder |
newDatabase(String theName)
Create a builder for creating a new database.
|
protected abstract DatabaseBuilder |
newDatabaseBuilder() |
String |
offline(String theName)
Makes the database offline according to the default strategy and default timeout.
|
<T> String |
set(String theName,
MetaProperty<T> theOption,
T theValue)
Sets the value of the specified option for the database with the given name.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
backup, backup, backup, backup, backupAll, backupAll, backupAll, changeEncryptionPassword, createNewEncryptionKey, currentStatus, currentStatus, disableEncryption, drop, fileKeyList, generateDiagnosticReport, getPermissionManager, getProperty, getQueryManager, getRoleManager, getStoredFunctions, getStoredQueries, getTokenManager, getUserManager, list, offline, online, optimize, optimize, removeEncryptionPassword, repair, restore, restore, setEncryptionPassword, setProperty, shutdown, verify
public AbstractAdminConnection(Views<AdminConnection> theViews)
protected abstract void _close()
protected abstract DatabaseBuilder newDatabaseBuilder()
protected abstract <T> String _set(String theName, MetaProperty<T> theOption, T theValue) throws StardogException
StardogException
protected abstract Metadata _get(String theName, Iterable<? extends MetaProperty<?>> theOptions) throws StardogException
StardogException
public DatabaseBuilder disk(String theName) throws StardogException
disk
in interface AdminConnection
theName
- the name of the disk database to createStardogException
- if the name of the database is invalidpublic DatabaseBuilder builder(Metadata theOptions) throws StardogException
builder
in interface AdminConnection
StardogException
- if there was an error while creating the dbpublic final void close()
close
in interface AdminConnection
close
in interface AutoCloseable
public final <T extends AdminConnection> T as(Class<T> theView) throws StardogException
as
in interface AdminConnection
T
- the connection view to returntheView
- the type of connection to view this object asStardogException
- if the connection cannot be viewed as the provided type. This could be from the
parent connection having been closed or it does not support the provided view.public final boolean isOpen()
isOpen
in interface AdminConnection
public final DatabaseBuilder newDatabase(String theName) throws StardogException
newDatabase
in interface AdminConnection
theName
- the name of the database to createStardogException
- if the name of the database is invalidpublic <T> T get(String theName, MetaProperty<T> theOption) throws StardogException
null
if the
option is NOT a known Stardog options
, or if it is NOT
readable
. The function may also return null
if the option is set
to null
value for the database. To differentiate these cases, AdminConnection.get(String, Iterable)
function can be used instead. This function will throw an exception if the user does not have read access to the
database metadata.get
in interface AdminConnection
T
- type of the option valuetheName
- name of the databasetheOption
- the option to getnull
as explained aboveStardogException
- if there was an error while getting the valuepublic final Metadata get(String theName, Iterable<? extends MetaProperty<?>> theOptions) throws StardogException
contain
all the specified options. Only the values for
known Stardog options
that are should be
readable
will be contained in the result. This function will throw an
exception if the user does not have read access to the database metadata.get
in interface AdminConnection
theName
- database nametheOptions
- options for which values will be retrievedStardogException
- if an error occurs while retrieving option valuespublic final <T> String set(String theName, MetaProperty<T> theOption, T theValue) throws StardogException
known Stardog option
,
the provided value should be valid
, and
either the option should be writable online
or it should be writable
and the database should NOT be online
.set
in interface AdminConnection
T
- type of the option valuetheName
- name of the databasetheOption
- option to settheValue
- option valueStardogException
- if an error occurs trying to set the option valuepublic String offline(String theName) throws StardogException
offline
in interface AdminConnection
StardogException
protected void assertOpen()
IllegalStateException
- if the client is not connectedprotected void assertValidName(String theName) throws StardogException
StardogException
Copyright © 2010-2016 Stardog Union. All Rights Reserved.