OmeroBlitz API

omero::api::StatefulServiceInterface

Overview

[ "ami", "amd" ] interface StatefulServiceInterface extends ServiceInterface

Service marker for stateful services which permits the closing of a particular service before the destruction of the session.

Derived Classes and Interfaces

Exporter

JobHandle

MetadataStore

PyramidService

RawFileStore

Search

ThumbnailStore

grid::ImportProcess

Operation Index

passivate

Causes the blitz server to store the service implementation to disk to free memory.

activate

Load a service implementation from disk if it was previously passivated.

close

Frees all resources -- passivated or active -- for the given stateful service and removes its name from the object adapter.

getCurrentEventContext

To free clients from tracking the mapping from session to stateful service, each stateful service can returns its own context information.

Operations

void passivate() throws ServerError

Causes the blitz server to store the service implementation to disk to free memory. This is typically done automatically by the server when a pre-defined memory limit is reached, but can be used by the client if it clear that a stateful service will not be used for some time. Activation will happen automatically whether passivation was done manually or automatically.

void activate() throws ServerError

Load a service implementation from disk if it was previously passivated. It is unnecessary to call this method since activation happens automatically, but calling this may prevent a short lapse when the service is first accessed after passivation. It is safe to call this method at any time, even when the service is not passivated.

void close() throws ServerError

Frees all resources -- passivated or active -- for the given stateful service and removes its name from the object adapter. Any further method calls will fail with a Ice::NoSuchObjectException. Note: with JavaEE, the close method was called publicly, and internally this called destroy(). As of the OmeroBlitz migration, this functionality has been combined.

sys::EventContext getCurrentEventContext() throws ServerError

To free clients from tracking the mapping from session to stateful service, each stateful service can returns its own context information.