eu.fbk.knowledgestore

Interface KnowledgeStore

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

AbstractKnowledgeStore, Client, ForwardingKnowledgeStore, HttpServer, Server

public interface KnowledgeStore
extends Closeable

A KnowledgeStore instance.

This interface represents the entry point of the KnowledgeStore API. Users have to first obtain an instance of this interface, in a way that depends on whether the KnowledgeStore is running locally in embedded mode or is accessed via its CRUD and SPARQL endpoints at some base URL (reported by method #getURL()). After an instance is obtained, new user sessions can be created calling methods newSession() (for anonymous sessions} or #newSession(URI, String) (for authenticated user sessions); the returned Session objects allow in turn to issue API calls to the KnowledgeStore. When the KnowledgeStore instance is no more used, method close() should be called to release the KnowledgeStore instance and any resource possibly allocated to it.

KnowledgeStore instances are thread safe. Object equality is used for comparing Store instances.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the KnowledgeStore instance, releasing any resource possibly allocated.
boolean	isClosed() Tests whether this KnowledgeStore instance has been closed.
Session	newSession() Creates a new anonymous user session.
Session	newSession(String username, String password) Creates a new user session, using the optional username and password specified.

Method Detail

newSession

Session newSession()
            throws IllegalStateException

Creates a new anonymous user session. Which operations may be called on the returned Session depend on the security settings for anonymous users of the KnowledgeStore instance.

Returns:

the created Session

Throws:

IllegalStateException - in case the KnowledgeStore instance has been closed

newSession

Session newSession(@Nullable
                   String username,
                   @Nullable
                   String password)
            throws IllegalStateException

Creates a new user session, using the optional username and password specified. This method allows to specify the user the session will be associated to; if the username is null, the session will be anonymous. Supplying a password is necessary for creating a session on a remote KS (as user authentication is enforced); it may be optional otherwise. Which operations may be called on the returned Session depend on the security settings for the specific authenticated user of the KnowledgeStore instance.

Parameters:

username - the username, possibly null

password - the user password, possibly null

Returns:

the created Session

Throws:

IllegalStateException - in case the KnowledgeStore instance has been closed

isClosed

boolean isClosed()

Tests whether this KnowledgeStore instance has been closed.

Returns:

true, if this KnowledgeStore instance has been closed

close

void close()

Closes the KnowledgeStore instance, releasing any resource possibly allocated. Calling this method additional times has no effect. After this method is called, calls to other methods of the KnowledgeStore interface will result in IllegalStateExceptions being thrown.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable