org.eclipse.rse.persistence
Interface IRSEPersistenceProvider

public interface IRSEPersistenceProvider

This is the interface that needs to be implemented when providing an extension using the RSE persistence provider extension point. Implement this class to provide a specialized means of saving and restoring the RSE DOM. This interface is used by the persistence manager to schedule loads and saves of the DOM and should only be used by the persistence manager.

Method Summary

IStatus	deleteProfile(String profileName, IProgressMonitor monitor) Removes a profile.
String[]	getMigratedProfileNames()
String[]	getSavedProfileNames()
Job	getSaveJob(RSEDOM dom) Returns a job suitable for saving a DOM.
RSEDOM	loadRSEDOM(String profileName, IProgressMonitor monitor) Restores an RSE DOM given a profileName.
boolean	saveRSEDOM(RSEDOM dom, IProgressMonitor monitor) Persists an RSE DOM.
IStatus	setMigrationMark(String profileName, boolean migrated) Sets the migration state of a profile.
void	setProperties(Properties properties) Sets the properties for this provider.
boolean	supportsMigration() Indicates whether or not this persistence provider supports migration.

Method Detail

setProperties

public void setProperties(Properties properties)

Sets the properties for this provider. This must be done immediately after the provider is instantiated. The persistence manager will provide these properties for providers defined as extensions.

Parameters:

properties - the properties object containing the properties supplied in the extension.

loadRSEDOM

public RSEDOM loadRSEDOM(String profileName,
                         IProgressMonitor monitor)

Restores an RSE DOM given a profileName.

Parameters:

profileName - name of the Profile to load

monitor - The monitor to use for progress monitoring and cancellation. Must not be null.

Returns:

the RSE DOM for the specified profile

saveRSEDOM

public boolean saveRSEDOM(RSEDOM dom,
                          IProgressMonitor monitor)

Persists an RSE DOM. Writes the DOM to some form of external storage and then marks the DOM as clean using RSEDOMNode.markUpdated().

Parameters:

dom - the RSE DOM to persist.

monitor - The monitor to use for progress monitoring and cancellation. Must not be null.

Returns:

true if succcessful

getSaveJob

public Job getSaveJob(RSEDOM dom)

Returns a job suitable for saving a DOM. The result can be null if the persistence provider determines that a job would not be the best way of saving a particular DOM.

Parameters:

dom - the DOM for which to construct the job.

Returns:

The job that can be scheduled to perform the save operation.

getSavedProfileNames

public String[] getSavedProfileNames()

Returns:

The names of the profiles that have been saved by this persistence provider. Profiles that have been marked as migrated are not returned in this list. This may be an empty array but will never be null.

deleteProfile

public IStatus deleteProfile(String profileName,
                             IProgressMonitor monitor)

Removes a profile. Does nothing if the profile is not found.

Parameters:

profileName - the name of the profile to remove

monitor - The monitor to use for progress monitoring and cancellation. Must not be null.

Returns:

the IStatus indicating the operations success.

setMigrationMark

public IStatus setMigrationMark(String profileName,
                                boolean migrated)

Sets the migration state of a profile.

Parameters:

profileName - the name of the profile of which to set the migration state

migrated - true if the profile is to be marked as migrated, false if it is to be marked as normal. Normal profiles are returned in getSavedProfileNames(), migrated profiles are returned in getMigratedProfileNames().

Returns:

a status representing the resulting state of the migration. An OK status indicates a successful marking. An ERROR status indicates an unsuccessful marking.

Since:

org.eclipse.rse.core 3.0

See Also:

IRSECoreStatusCodes

getMigratedProfileNames

public String[] getMigratedProfileNames()

Returns:

The names of the profiles that have been migrated by this persistence provider. The names of profiles that have been marked as migrated are returned in this list. The appearance of a profile name in this list implies that the profile may be unmigrated by this provider by using setMigrationMark(String, boolean). This may be an empty array but will never be null.

Since:

org.eclipse.rse.core 3.0

supportsMigration

public boolean supportsMigration()

Indicates whether or not this persistence provider supports migration.

Returns:

true if the provider supports marking of the persistence form of profiles as migrated, false otherwise.

Since:

org.eclipse.rse.core 3.0