org.apache.stanbol.ontologymanager.servicesapi.session

Interface SessionManager

All Superinterfaces:

NamedArtifact, SessionListenable

All Known Subinterfaces:

SessionManager

public interface SessionManager
extends NamedArtifact, SessionListenable

Manages session objects via CRUD-like operations. A SessionManager maintains in-memory storage of sessions, creates new ones and either destroys or stores existing ones persistently. All sessions are managed via unique identifiers of the org.semanticweb.owlapi.model.IRI type.

NOTE: implementations should either be synchronized, or document whenever they are not.

Author:

alexdma

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONNECTIVITY_POLICY The key used to configure the connectivity policy.
static String	ID The key used to configure the base namespace of the ontology network.
static String	MAX_ACTIVE_SESSIONS The key used to configure the base namespace of the ontology network.

Method Summary

Methods

Modifier and Type	Method and Description
Session	createSession() Generates and registers a new session and assigns a unique session ID generated internally.
Session	createSession(String sessionID) Generates and registers a new session and tries to assign it the supplied session ID.
void	destroySession(String sessionID) Deletes the session identified by the supplied sessionID and releases its resources.
int	getActiveSessionLimit() Gets the number of sessions that can be simultaneously active and managed by this session manager.
Set<String>	getRegisteredSessionIDs() Returns the set of strings that identify registered sessions, whatever their state.
Session	getSession(String sessionID) Retrieves the unique session identified by sessionID.
void	setActiveSessionLimit(int limit) Sets the maximum allowed number of active sessions managed by this manager simultaneously.
void	storeSession(String sessionID, OutputStream out) Deprecated. As of now, session contents are always stored. Deprecation will be removed if a new policy is implemented.

Methods inherited from interface org.apache.stanbol.ontologymanager.servicesapi.NamedArtifact

getDefaultNamespace, getID, getNamespace, setDefaultNamespace, setNamespace

Methods inherited from interface org.apache.stanbol.ontologymanager.servicesapi.session.SessionListenable

addSessionListener, clearSessionListeners, getSessionListeners, removeSessionListener

Field Detail

CONNECTIVITY_POLICY

static final String CONNECTIVITY_POLICY

The key used to configure the connectivity policy.

See Also:

Constant Field Values

ID

static final String ID

The key used to configure the base namespace of the ontology network.

See Also:

Constant Field Values

MAX_ACTIVE_SESSIONS

static final String MAX_ACTIVE_SESSIONS

The key used to configure the base namespace of the ontology network.

See Also:

Constant Field Values

Method Detail

createSession

Session createSession()
                      throws SessionLimitException

Generates and registers a new session and assigns a unique session ID generated internally. This will not cause DuplicateSessionIDExceptions to be thrown.

Returns:

the generated session

Throws:

SessionLimitException

createSession

Session createSession(String sessionID)
                      throws DuplicateSessionIDException,
                             SessionLimitException

Generates and registers a new session and tries to assign it the supplied session ID. If a session with that ID is already registered, the new session is not created and a DuplicateSessionIDException is thrown.

Parameters:

sessionID - the IRI that uniquely identifies the session

Returns:

the generated session

Throws:

DuplicateSessionIDException - if a session with that sessionID is already registered

SessionLimitException

destroySession

void destroySession(String sessionID)

Deletes the session identified by the supplied sessionID and releases its resources.

Parameters:

sessionID - the IRI that uniquely identifies the session

getActiveSessionLimit

int getActiveSessionLimit()

Gets the number of sessions that can be simultaneously active and managed by this session manager.

Returns:

the session limit.

getRegisteredSessionIDs

Set<String> getRegisteredSessionIDs()

Returns the set of strings that identify registered sessions, whatever their state.

Returns:

the IDs of all registered sessions.

getSession

Session getSession(String sessionID)

Retrieves the unique session identified by sessionID.

Parameters:

sessionID - the IRI that uniquely identifies the session

Returns:

the unique session identified by sessionID

setActiveSessionLimit

void setActiveSessionLimit(int limit)

Sets the maximum allowed number of active sessions managed by this manager simultaneously. A negative value denotes no limit. Note that it is possible to set this value to zero, thus preventing Stanbol from creating session at all.

Parameters:

limit -

storeSession

void storeSession(String sessionID,
                OutputStream out)
                  throws NonReferenceableSessionException,
                         org.semanticweb.owlapi.model.OWLOntologyStorageException

Deprecated. As of now, session contents are always stored. Deprecation will be removed if a new policy is implemented.

Stores the session identified by sessionID using the output stream out.

Parameters:

sessionID - the IRI that uniquely identifies the session

out - the output stream to store the session

Throws:

org.semanticweb.owlapi.model.OWLOntologyStorageException

NonReferenceableSessionException