Interface ServerConnection
- All Superinterfaces:
java.lang.AutoCloseable
public interface ServerConnection
extends java.lang.AutoCloseable
Encapsulates the connection to an RDFox server. The server could be in the same process, or could be a remote server accessed via the RESTful API.
All instances of this class are single-threaded — that is, no method should be called simultaneously on several threads. However, please note
that there is no thread affinity — that is, methods on one connection can be called from different threads as long as the calls are serialised
externally. Methods
duplicate()
and interrupt()
are the exceptions and can be invoked in parallel with any other method apart from
close()
: calling close()
in parallel with any other method runs a high risk of crashing the JVM. Multiple connections should be
used to access a server concurrently, in which case all access to the server is serialised. A connection must be closed after use in order to release
the resources associated with it.-
Field Summary
Fields Modifier and Type Field Description static byte
ACCESS_TYPE_GRANT
A flag specifying grant access to a resource.static byte
ACCESS_TYPE_NONE
A flag specifying no access to a resource.static byte
ACCESS_TYPE_READ
A flag specifying read access to a resource.static byte
ACCESS_TYPE_STAR
A flag specifying all access types to a resource.static byte
ACCESS_TYPE_WRITE
A flag specifying write access to a resource. -
Method Summary
Modifier and Type Method Description void
changeRolePassword(java.lang.String currentPassword, java.lang.String newPassword)
Creates the password of the role that is associated with this connection.void
close()
Closes the data store connection by freeing all resources associated with it.boolean
containsDataStore(java.lang.String dataStoreName)
Returnstrue
if the connected server contains a data store with the given name.void
createDataStore(java.lang.String dataStoreName, java.lang.String dataStoreTypeName, java.util.Map<java.lang.String,java.lang.String> dataStoreParameters)
Creates a data store with the given name.void
createRole(java.lang.String roleName, java.lang.String password)
Creates a new role with the given name and password.void
createRole(java.lang.String roleName, java.lang.String passwordOrHash, boolean isHash)
Creates a new role with the given name and password.void
deleteDataStore(java.lang.String dataStoreName)
Deletes a data store with the given name from the server.void
deleteRole(java.lang.String roleName)
Deletes a role with the given name.ServerConnection
duplicate()
Creates a new connection to the same data store.ComponentInfo
getComponentInfo(boolean extended)
Returns diagnostic information about the server as a tree of objects each providing detailed information about the server.java.lang.String
getGitSHA()
Returns the string containing the Git SHA identifying the precise version of the RDFox instance code.int
getNumberOfThreads()
Returns the number of threads that the server uses for various tasks such as reasoning and data importation.java.util.Map<java.lang.String,java.lang.String>
getParameters()
Returns the parameters that the server was created with.java.lang.String
getRoleName()
Returns the name of the role currently associated with this connection.java.lang.String
getRolePasswordHash(java.lang.String roleName)
Returns the password hash for the given role name.java.lang.String
getVersion()
Returns the version string of the RDFox instance.void
grantPrivileges(java.lang.String roleName, java.lang.String resourceSpecifier, byte accessTypesToGrant)
Grants privileges over a resource specifier to a role.void
grantRole(java.lang.String roleName, java.lang.String superRoleName)
Grants the membership of a role in another role.void
interrupt()
Tries to interrupt an operation that is running in parallel on this connection.boolean
isMemberOf(java.lang.String roleName, java.lang.String superRoleName)
Checks whether the given role is a member of another super-role.java.util.List<java.lang.String>
listDataStores()
Returns the list of names of data stores available at the connected server.java.util.Map<java.lang.String,java.lang.Byte>
listPrivileges(java.lang.String roleName)
Lists the privileges of a given role.java.util.List<java.lang.String>
listRoleMembers(java.lang.String roleName)
Lists the roles that are members of the given role.java.util.List<java.lang.String>
listRoleMemberships(java.lang.String roleName)
Lists the roles that the given role is a member of.java.util.List<java.lang.String>
listRoles()
Returns the list of all roles available at the server.void
loadDataStoreFromBinaryFormat(java.lang.String dataStoreName, java.io.File file)
Loads a data store with the given name from a file containing the store saved in the standard or raw format.void
loadDataStoreFromBinaryFormat(java.lang.String dataStoreName, java.io.File file, java.lang.String dataStoreTypeName, java.util.Map<java.lang.String,java.lang.String> dataStoreParameters)
Loads a data store with the given name from a file containing the store saved in the standard or raw format.void
loadDataStoreFromBinaryFormat(java.lang.String dataStoreName, java.io.InputStream inputStream)
Loads a data store with the given name from an input stream containing the store saved in the standard or raw format.void
loadDataStoreFromBinaryFormat(java.lang.String dataStoreName, java.io.InputStream inputStream, java.lang.String dataStoreTypeName, java.util.Map<java.lang.String,java.lang.String> dataStoreParameters)
Loads a data store with the given name from an input stream containing the store saved in the standard or raw format.DataStoreConnection
newDataStoreConnection(java.lang.String dataStoreName)
Creates a connection to the data store of this server with the given name.void
revokePrivileges(java.lang.String roleName, java.lang.String resourceSpecifier, byte accessTypesToRevoke)
Revokes privileges over a resource specifier from a role.void
revokeRole(java.lang.String roleName, java.lang.String superRoleName)
Revokes the membership of a role in another role.void
setNumberOfThreads(int numberOfThreads)
Sets the number of threads that the server should use for various tasks such as reasoning and data importation.void
switchRole(java.lang.String roleName, java.lang.String password)
Changes the role associated with this connection.
-
Field Details
-
ACCESS_TYPE_NONE
static final byte ACCESS_TYPE_NONEA flag specifying no access to a resource.- See Also:
- Constant Field Values
-
ACCESS_TYPE_READ
static final byte ACCESS_TYPE_READA flag specifying read access to a resource.- See Also:
- Constant Field Values
-
ACCESS_TYPE_WRITE
static final byte ACCESS_TYPE_WRITEA flag specifying write access to a resource.- See Also:
- Constant Field Values
-
ACCESS_TYPE_GRANT
static final byte ACCESS_TYPE_GRANTA flag specifying grant access to a resource.- See Also:
- Constant Field Values
-
ACCESS_TYPE_STAR
static final byte ACCESS_TYPE_STARA flag specifying all access types to a resource.- See Also:
- Constant Field Values
-
-
Method Details
-
close
void close()Closes the data store connection by freeing all resources associated with it. Once a connection is closed, it cannot be used any further. Calling this method in parallel with any other method runs a very high risk of crashing the JVM.- Specified by:
close
in interfacejava.lang.AutoCloseable
-
duplicate
Creates a new connection to the same data store. The new connection inherits the role name from this one. The main use of this method is to avoid having to specify the role credentials again. This method can be called concurrently with any other method apart fromclose()
.- Returns:
- a new connection to the same server
- Throws:
JRDFoxException
- thrown if an error is encountered
-
interrupt
Tries to interrupt an operation that is running in parallel on this connection. RDFox will make a best effort to interrupt an operation, but there are no guarantees that the operation will indeed be interrupted. An operation will throw anOperationInterruptedException
exception. This method can be called concurrently with any other method apart fromclose()
.- Throws:
JRDFoxException
- thrown if an error is encountered
-
getRoleName
Returns the name of the role currently associated with this connection.- Returns:
- the name of the role currently associated with this connection
- Throws:
JRDFoxException
- thrown if there is an error
-
switchRole
Changes the role associated with this connection. The new role is reauthenticated, and if that succeeds, all subsequent actions on this connection will be made under the identity of the new role.- Parameters:
roleName
- the new role namepassword
- the password of the new role- Throws:
JRDFoxException
- thrown if there is an error
-
getParameters
Returns the parameters that the server was created with.- Returns:
- the parameters of the server
- Throws:
JRDFoxException
- thrown if an error is encountered
-
getVersion
Returns the version string of the RDFox instance.- Returns:
- the version string of the RDFox instance
- Throws:
JRDFoxException
- thrown if an error is encountered
-
getGitSHA
Returns the string containing the Git SHA identifying the precise version of the RDFox instance code.- Returns:
- the Git SHA string of the RDFox instance
- Throws:
JRDFoxException
- thrown if an error is encountered
-
getNumberOfThreads
Returns the number of threads that the server uses for various tasks such as reasoning and data importation.- Returns:
- the number of threads used by the server
- Throws:
JRDFoxException
- thrown if an error is encountered
-
setNumberOfThreads
Sets the number of threads that the server should use for various tasks such as reasoning and data importation. This operation can be invoked only if no transaction is active.- Parameters:
numberOfThreads
- the number of threads that the server should use- Throws:
JRDFoxException
- thrown if an error is encountered
-
getComponentInfo
Returns diagnostic information about the server as a tree of objects each providing detailed information about the server. Note: This information should be used for diagnostics purposes only. The content ofComponentInfo
is subject to change in future version. Callers should not rely on named property or a specific subcomponent being present.- Parameters:
extended
- iftrue
, the information about all data stores will be returned as well- Returns:
- information about the server
- Throws:
JRDFoxException
- thrown if an error is encountered
-
listDataStores
Returns the list of names of data stores available at the connected server.- Returns:
- the list of names of data stores available at the server
- Throws:
JRDFoxException
- thrown if an error is encountered
-
containsDataStore
Returnstrue
if the connected server contains a data store with the given name.- Parameters:
dataStoreName
- the name of a data store- Returns:
true
if the server contains a data store with the namedataStoreName
- Throws:
JRDFoxException
- thrown if an error is encountered
-
createDataStore
void createDataStore(java.lang.String dataStoreName, java.lang.String dataStoreTypeName, java.util.Map<java.lang.String,java.lang.String> dataStoreParameters) throws JRDFoxExceptionCreates a data store with the given name. The remaining parameters specify the data store type, as well as various data store parameters. The server should not contain a data store with the specified name.- Parameters:
dataStoreName
- the name of the newly created data storedataStoreTypeName
- the name of the data store type (see Data Store Types)dataStoreParameters
- the key-value pairs determining various data store parameters (see Data Store Parameters)- Throws:
JRDFoxException
- thrown if an error is encountered (e.g., if the server already contains a data store with the given name, or if some of the parameters are incorrect)
-
loadDataStoreFromBinaryFormat
void loadDataStoreFromBinaryFormat(java.lang.String dataStoreName, java.io.InputStream inputStream) throws JRDFoxExceptionLoads a data store with the given name from an input stream containing the store saved in the standard or raw format. The loaded data store will be initialised using the parameters found in the input stream. The server should not contain a data store with the specified name.- Parameters:
dataStoreName
- the name of the newly created data storeinputStream
- contains the data store encoded using the standard or the raw format- Throws:
JRDFoxException
- thrown if an error is encountered (e.g., if the server already contains a data store with the given name, or if the format is incorrect)
-
loadDataStoreFromBinaryFormat
void loadDataStoreFromBinaryFormat(java.lang.String dataStoreName, java.io.File file) throws JRDFoxExceptionLoads a data store with the given name from a file containing the store saved in the standard or raw format. The loaded data store will be initialised using the parameters found in the file. The server should not contain a data store with the specified name.- Parameters:
dataStoreName
- the name of the newly created data storefile
- contains the data store encoded using the standard or the raw format- Throws:
JRDFoxException
- thrown if an error is encountered (e.g., if the server already contains a data store with the given name, or if the format is incorrect)
-
loadDataStoreFromBinaryFormat
void loadDataStoreFromBinaryFormat(java.lang.String dataStoreName, java.io.InputStream inputStream, java.lang.String dataStoreTypeName, java.util.Map<java.lang.String,java.lang.String> dataStoreParameters) throws JRDFoxExceptionLoads a data store with the given name from an input stream containing the store saved in the standard or raw format. The loaded data store will be initialised using the specified parameters, which are the same as in thecreateDataStore(java.lang.String, java.lang.String, java.util.Map<java.lang.String, java.lang.String>)
method. Please note that, if the input contains a data store in the raw format, the parameters must be exactly the same as in the input. In contrast, if the input contains a data store in the standard format, most parameters (apart from the equality mode) can be overridden; hence, this method can be used to transfer the data from one data store to another. The server should not contain a data store with the specified name.- Parameters:
dataStoreName
- the name of the newly created data storeinputStream
- contains the data store encoded using the standard or the raw formatdataStoreTypeName
- the name of the data store type (see Data Store Types)dataStoreParameters
- the key-value pairs determining various data store parameters (see Data Store Parameters)- Throws:
JRDFoxException
- thrown if an error is encountered (e.g., if the server already contains a data store with the given name, or if the file format is incorrect)
-
loadDataStoreFromBinaryFormat
void loadDataStoreFromBinaryFormat(java.lang.String dataStoreName, java.io.File file, java.lang.String dataStoreTypeName, java.util.Map<java.lang.String,java.lang.String> dataStoreParameters) throws JRDFoxExceptionLoads a data store with the given name from a file containing the store saved in the standard or raw format. The loaded data store will be initialised using the specified parameters, which are the same as in thecreateDataStore(java.lang.String, java.lang.String, java.util.Map<java.lang.String, java.lang.String>)
method. Please note that, if the input contains a data store in the raw format, the parameters must be exactly the same as in the input. In contrast, if the input contains a data store in the standard format, most parameters (apart from the equality mode) can be overridden; hence, this method can be used to transfer the data from one data store to another. The server should not contain a data store with the specified name.- Parameters:
dataStoreName
- the name of the newly created data storefile
- contains the data store encoded using the standard or the raw formatdataStoreTypeName
- the name of the data store type (see Data Store Types)dataStoreParameters
- the key-value pairs determining various data store parameters (see Data Store Parameters)- Throws:
JRDFoxException
- thrown if an error is encountered (e.g., if the server already contains a data store with the given name, or if the file format is incorrect)
-
deleteDataStore
Deletes a data store with the given name from the server. A data store can be deleted only if no connections are open to it.- Parameters:
dataStoreName
- the name of the data store to delete- Throws:
JRDFoxException
- thrown if an error is encountered (e.g., if the server does not contain a data store with the given name)
-
newDataStoreConnection
Creates a connection to the data store of this server with the given name. The new data store connection uses the same credentials as this server connection.- Parameters:
dataStoreName
- the name of the data store to connect to- Returns:
- a connection to the specified data store
- Throws:
JRDFoxException
- thrown if an error is encountered (e.g., if the server does not contain a data store with the given name)
-
listRoles
Returns the list of all roles available at the server.- Returns:
- the list of all roles available at the server.
- Throws:
JRDFoxException
- thrown if there is an error
-
createRole
Creates a new role with the given name and password.- Parameters:
roleName
- the new role namepassword
- the password of the new role- Throws:
JRDFoxException
- thrown if there is an error
-
createRole
void createRole(java.lang.String roleName, java.lang.String passwordOrHash, boolean isHash) throws JRDFoxExceptionCreates a new role with the given name and password.- Parameters:
roleName
- the new role namepasswordOrHash
- the password or its hash of the new roleisHash
- iftrue
, thenpasswordOrHash
is interpreted as the hash of the password; otherwise,passwordOrHash
is interpreted as the verbatim password- Throws:
JRDFoxException
- thrown if there is an error
-
deleteRole
Deletes a role with the given name.- Parameters:
roleName
- the name of the role to delete- Throws:
JRDFoxException
- thrown if there is an error
-
changeRolePassword
void changeRolePassword(java.lang.String currentPassword, java.lang.String newPassword) throws JRDFoxExceptionCreates the password of the role that is associated with this connection. The change is performed only if the current password matches.- Parameters:
currentPassword
- the current password of the role associated with this connectionnewPassword
- the new password for the role associated with this connection- Throws:
JRDFoxException
- thrown if there is an error
-
getRolePasswordHash
Returns the password hash for the given role name.- Parameters:
roleName
- the name of the role for which the password hash should be returned- Returns:
- the password hash
- Throws:
JRDFoxException
- thrown if there is an error
-
listRoleMemberships
java.util.List<java.lang.String> listRoleMemberships(java.lang.String roleName) throws JRDFoxExceptionLists the roles that the given role is a member of.- Parameters:
roleName
- the name of the role for which the memberships should be returned- Returns:
- the list of roles that the given role is a member of
- Throws:
JRDFoxException
- thrown if there is an error
-
listRoleMembers
Lists the roles that are members of the given role.- Parameters:
roleName
- the name of the role for which the members should be returned- Returns:
- the list of roles that are members of the given role
- Throws:
JRDFoxException
- thrown if there is an error
-
isMemberOf
boolean isMemberOf(java.lang.String roleName, java.lang.String superRoleName) throws JRDFoxExceptionChecks whether the given role is a member of another super-role.- Parameters:
roleName
- the name of the role for which the check is performedsuperRoleName
- the name of the potential super-role for which the check is performed- Returns:
true
if the given role is a member of another super-role.- Throws:
JRDFoxException
- thrown if there is an error
-
grantRole
Grants the membership of a role in another role.- Parameters:
roleName
- the name of the role that is to be made member ofsuperRoleName
superRoleName
- the name of the role that should getroleName
as member- Throws:
JRDFoxException
- thrown if there is an error
-
revokeRole
Revokes the membership of a role in another role.- Parameters:
roleName
- the name of the role that should stop being member ofsuperRoleName
superRoleName
- the name of the role that for whichroleName
should stop being a member- Throws:
JRDFoxException
- thrown if there is an error
-
listPrivileges
java.util.Map<java.lang.String,java.lang.Byte> listPrivileges(java.lang.String roleName) throws JRDFoxExceptionLists the privileges of a given role. The result is a map of resource specifiers to the access types that the role currently has.- Parameters:
roleName
- the name of the role whose privileges are being listed- Returns:
- the map of resource specifiers to the access types (specified as a bit-mask of
ACCESS_TYPE_*
values) - Throws:
JRDFoxException
- thrown if there is an error
-
grantPrivileges
void grantPrivileges(java.lang.String roleName, java.lang.String resourceSpecifier, byte accessTypesToGrant) throws JRDFoxExceptionGrants privileges over a resource specifier to a role.- Parameters:
roleName
- the name of the role to which the privileges are being grantedresourceSpecifier
- identifies a resource to which the privileges are being grantedaccessTypesToGrant
- the access types (specified as a bit-mask ofACCESS_TYPE_*
values) that are to be granted- Throws:
JRDFoxException
- thrown if there is an error
-
revokePrivileges
void revokePrivileges(java.lang.String roleName, java.lang.String resourceSpecifier, byte accessTypesToRevoke) throws JRDFoxExceptionRevokes privileges over a resource specifier from a role.- Parameters:
roleName
- the name of the role to which the privileges are being grantedresourceSpecifier
- identifies a resource to which the privileges are being grantedaccessTypesToRevoke
- the access types (specified as a bit-mask ofACCESS_TYPE_*
values) that are to be revoked- Throws:
JRDFoxException
- thrown if there is an error
-