omero.api

Interface _StatefulServiceInterfaceOperationsNC

All Superinterfaces:

_ServiceInterfaceOperationsNC

All Known Subinterfaces:

_ExporterOperationsNC, _ImportProcessOperationsNC, _JobHandleOperationsNC, _MetadataStoreOperationsNC, _PyramidServiceOperationsNC, _RawFileStoreOperationsNC, _RawPixelsStoreOperationsNC, _RenderingEngineOperationsNC, _SearchOperationsNC, _ThumbnailStoreOperationsNC, Exporter, ImportProcess, JobHandle, MetadataStore, PyramidService, RawFileStore, RawPixelsStore, RenderingEngine, Search, StatefulServiceInterface, ThumbnailStore

All Known Implementing Classes:

_ExporterDisp, _ExporterTie, _ImportProcessDisp, _ImportProcessTie, _JobHandleDisp, _JobHandleTie, _MetadataStoreDisp, _MetadataStoreTie, _PyramidServiceDisp, _PyramidServiceTie, _RawFileStoreDisp, _RawFileStoreTie, _RawPixelsStoreDisp, _RawPixelsStoreTie, _RenderingEngineDisp, _RenderingEngineTie, _SearchDisp, _SearchTie, _StatefulServiceInterfaceDisp, _StatefulServiceInterfaceTie, _ThumbnailStoreDisp, _ThumbnailStoreTie, BfPixelsStoreI

public interface _StatefulServiceInterfaceOperationsNC
extends _ServiceInterfaceOperationsNC

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

Method Summary

Modifier and Type	Method and Description
void	activate_async(AMD_StatefulServiceInterface_activate __cb) Load a service implementation from disk if it was previously passivated.
void	close_async(AMD_StatefulServiceInterface_close __cb) Frees all resources -- passivated or active -- for the given stateful service and removes its name from the object adapter.
void	getCurrentEventContext_async(AMD_StatefulServiceInterface_getCurrentEventContext __cb) To free clients from tracking the mapping from session to stateful service, each stateful service can returns its own context information.
void	passivate_async(AMD_StatefulServiceInterface_passivate __cb) Causes the blitz server to store the service implementation to disk to free memory.

Method Detail

passivate_async

void passivate_async(AMD_StatefulServiceInterface_passivate __cb)
              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.

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

activate_async

void activate_async(AMD_StatefulServiceInterface_activate __cb)
             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.

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

close_async

void close_async(AMD_StatefulServiceInterface_close __cb)
          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.

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError

getCurrentEventContext_async

void getCurrentEventContext_async(AMD_StatefulServiceInterface_getCurrentEventContext __cb)
                           throws ServerError

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

Parameters:

__cb - The callback object for the operation.

Throws:

ServerError