jadex.bridge.service.types.persistence

Interface IPersistenceService

public interface IPersistenceService

Service for basic component persistence features.

Method Summary

Modifier and Type	Method and Description
jadex.commons.future.IFuture<java.lang.Void>	addIdleHook(IIdleHook hook) Set the idle hook to be called when a component becomes idle.
jadex.commons.future.IFuture<java.lang.Void>	restore(java.util.Collection<IPersistInfo> pis) Restore components from a snapshot.
jadex.commons.future.IFuture<java.lang.Void>	restore(IPersistInfo pi) Restore a component from a snapshot.
jadex.commons.future.IFuture<java.util.Collection<IPersistInfo>>	snapshot(java.util.Collection<IComponentIdentifier> cids, boolean recursive) Get the component states.
jadex.commons.future.IFuture<IPersistInfo>	snapshot(IComponentIdentifier cid) Get the component state.
jadex.commons.future.IFuture<java.lang.Void>	swapFromStorage(IPersistInfo pi) Transparently restore the component state of a previously swapped component.
jadex.commons.future.IFuture<IPersistInfo>	swapToStorage(IComponentIdentifier cid) Fetch the component state and transparently remove it from memory.

Method Detail

snapshot

jadex.commons.future.IFuture<IPersistInfo> snapshot(IComponentIdentifier cid)

Get the component state.

Parameters:

cid - The component to be saved.

recursive - True, if subcomponents should be saved as well.

Returns:

The component(s) state.

snapshot

jadex.commons.future.IFuture<java.util.Collection<IPersistInfo>> snapshot(java.util.Collection<IComponentIdentifier> cids,
                                                                          boolean recursive)

Get the component states.

Parameters:

cids - The components to be saved.

recursive - True, if subcomponents should be saved as well.

Returns:

The component state(s).

restore

jadex.commons.future.IFuture<java.lang.Void> restore(IPersistInfo pi)

Restore a component from a snapshot.

Parameters:

pi - The component snapshot.

restore

jadex.commons.future.IFuture<java.lang.Void> restore(java.util.Collection<IPersistInfo> pis)

Restore components from a snapshot.

Parameters:

pis - The component snapshots.

swapToStorage

jadex.commons.future.IFuture<IPersistInfo> swapToStorage(IComponentIdentifier cid)

Fetch the component state and transparently remove it from memory. Keeps the component available in CMS to allow restoring it on access.

Parameters:

cid - The component identifier.

Returns:

The component state.

swapFromStorage

jadex.commons.future.IFuture<java.lang.Void> swapFromStorage(IPersistInfo pi)

Transparently restore the component state of a previously swapped component.

Parameters:

pi - The persist info.

addIdleHook

jadex.commons.future.IFuture<java.lang.Void> addIdleHook(IIdleHook hook)

Set the idle hook to be called when a component becomes idle.