org.apache.stanbol.ontologymanager.servicesapi.session

Interface Session

All Superinterfaces:

Lockable, NamedArtifact, OntologyCollector, OntologyCollectorListenable, OntologyInputSourceHandler, OWLExportable, SessionListenable

All Known Subinterfaces:

Session

public interface Session
extends OntologyCollector, OWLExportable, Lockable, SessionListenable

An ontology collector that can be used by client applications to store volatile data, e.g. for the duration of a service call. It has an aggressive severance policy and tries to delete as many managed ontologies as possible when it goes down.

Note that sessions are generally disjoint with HTTP sessions or the like, but can be used in conjunction with them, or manipulated to mimic their behaviour.

Author:

alexdma

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Session.State The states a session can be in: ACTIVE (for running sessions), HALTED (for inactive sessions that may later be activated, e.g. when a user logs in), ZOMBIE (inactive and bound for destruction, no longer referenceable).

Nested classes/interfaces inherited from interface org.apache.stanbol.ontologymanager.servicesapi.ontology.OWLExportable

OWLExportable.ConnectivityPolicy

Field Summary

Fields

Modifier and Type	Field and Description
static String	shortName

Method Summary

Methods

Modifier and Type	Method and Description
void	attachScope(String scopeId) Instructs the session to reference the supplied ontology scope.
void	clearScopes() Removes all references to ontology scopes, thus leaving the session data as standalone.
void	close() Closes this Session irreversibly.
void	detachScope(String scopeId) Instructs the session to no longer reference the supplied ontology scope.
Set<String>	getAttachedScopes() Gets the identifiers of the scopes currently attached to this session.
Session.State	getSessionState() Returns the current state of this KReS session.
boolean	isActive() Equivalent to getState() == State.ACTIVE.
void	open() Sets this session as active
Session.State	setActive(boolean active) Sets the session as ACTIVE if active is true, INACTIVE otherwise.

Methods inherited from interface org.apache.stanbol.ontologymanager.servicesapi.collector.OntologyCollector

addOntology, getManagedOntologies, getOntology, getOntology, getOntology, getOntology, getOntology, getOntology, getOntology, getOntology, hasOntology, hasOntology, listManagedOntologies, removeOntology, removeOntology, setUp, tearDown

Methods inherited from interface org.apache.stanbol.ontologymanager.servicesapi.collector.OntologyCollectorListenable

addOntologyCollectorListener, clearOntologyCollectorListeners, getOntologyCollectorListeners, removeOntologyCollectorListener

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

getDefaultNamespace, getID, getNamespace, setDefaultNamespace, setNamespace

Methods inherited from interface org.apache.stanbol.ontologymanager.servicesapi.io.OntologyInputSourceHandler

getSupportedOntologyTypes

Methods inherited from interface org.apache.stanbol.ontologymanager.servicesapi.ontology.OWLExportable

export, export, getConnectivityPolicy, setConnectivityPolicy

Methods inherited from interface org.apache.stanbol.ontologymanager.servicesapi.collector.Lockable

isLocked

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

addSessionListener, clearSessionListeners, getSessionListeners, removeSessionListener

Field Detail

shortName

static final String shortName

See Also:

Constant Field Values

Method Detail

attachScope

void attachScope(String scopeId)

Instructs the session to reference the supplied ontology scope. This way, whenever session data are processed, scope data will be considered as well.

Parameters:

scope - the ontology scope to be referenced.

clearScopes

void clearScopes()

Removes all references to ontology scopes, thus leaving the session data as standalone.

close

void close()

Closes this Session irreversibly. Most likely includes setting the state to ZOMBIE.

detachScope

void detachScope(String scopeId)

Instructs the session to no longer reference the supplied ontology scope. If a scope with the supplied identifier was not attached, this method has no effect.

Parameters:

scope - the identifer of the ontology scope to be detached.

getAttachedScopes

Set<String> getAttachedScopes()

Gets the identifiers of the scopes currently attached to this session.

Returns:

the attached scope identifiers

getSessionState

Session.State getSessionState()

Returns the current state of this KReS session.

Returns:

the state of this session

isActive

boolean isActive()

Equivalent to getState() == State.ACTIVE.

Returns:

true iff this session is in the ACTIVE state

open

void open()

Sets this session as active

Throws:

NonReferenceableSessionException

setActive

Session.State setActive(boolean active)

Sets the session as ACTIVE if active is true, INACTIVE otherwise. The state set is returned, which should match the input state unless an error occurs.

Should throw an exception if this session is in a ZOMBIE state.

Parameters:

active - the desired activity state for this session

Returns:

the resulting state of this KReS session