org.eclipse.ecf.storage
Interface IContainerStore

All Superinterfaces:

org.eclipse.core.runtime.IAdaptable

public interface IContainerStore
extends org.eclipse.core.runtime.IAdaptable

Storage interface for IContainer instances.

Method Summary

IContainerEntry[]	getContainerEntries() Get all IContainerEntrys.
IContainerEntry	retrieve(ID containerID) Retrieve an IContainerEntry for a given container ID.
IContainerEntry	retrieve(IIDEntry idEntry) Retrieve an IContainerEntry for a given IIDEntry.
IContainerEntry	store(IStorableContainerAdapter containerAdapter) Store a IStorableContainerAdapter in this container store.

Methods inherited from interface org.eclipse.core.runtime.IAdaptable

getAdapter

Method Detail

getContainerEntries

IContainerEntry[] getContainerEntries()

Get all IContainerEntrys. Will return from secure storage all container entries previously added via store(IStorableContainerAdapter).

Returns:

IContainerEntry[] of all container entries. Will not return null. If no containers previously stored, will return empty array.

store

IContainerEntry store(IStorableContainerAdapter containerAdapter)
                      throws org.eclipse.equinox.security.storage.StorageException

Store a IStorableContainerAdapter in this container store.

Parameters:

containerAdapter - the IStorableContainerAdapter to store. Must not be null.

Returns:

IContainerEntry result of storage. Will not return null.

Throws:

org.eclipse.equinox.security.storage.StorageException - if containerAdapter cannot be properly stored for whatever reason.

retrieve

IContainerEntry retrieve(ID containerID)

Retrieve an IContainerEntry for a given container ID.

Parameters:

containerID - the containerID to retrieve. Must not be null.

Returns:

IContainerEntry found, or null if container with given ID not found.

retrieve

IContainerEntry retrieve(IIDEntry idEntry)

Retrieve an IContainerEntry for a given IIDEntry.

Parameters:

idEntry - the idEntry to retrieve. Must not be null.

Returns:

IContainerEntry found, or null if container with given ID not found.