|
RSE Release 3.0 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IRSEPersistenceManager
This interface defines the services provided by a persistence manager for RSE. There is typically only one persistence manager instance defined when RSE is running. The persistence manager controls the persistence of RSE profiles through the use of registered persistence providers.
Method Summary | |
---|---|
boolean |
commitProfile(ISystemProfile profile,
long timeout)
Schedules a save of particular profile. |
ISystemProfile[] |
commitProfiles(long timeout)
Save all profiles. |
void |
deleteProfile(IRSEPersistenceProvider persistenceProvider,
String profileName)
Delete the persistent form of a profile. |
IRSEPersistenceProvider |
getPersistenceProvider(String id)
Retrieves the persistence provider named by a particular id. |
String[] |
getPersistenceProviderIds()
|
boolean |
isBusy()
|
boolean |
isRestoreComplete()
Indicate if all profiles for all autostart persistence provider have been restored. |
void |
migrateProfile(ISystemProfile profile,
IRSEPersistenceProvider persistenceProvider)
Migrates a profile to a new persistence provider. |
IStatus |
migrateProfile(ISystemProfile profile,
IRSEPersistenceProvider persistenceProvider,
boolean delete)
Migrates a profile to a new persistence provider. |
void |
registerPersistenceProvider(String id,
IRSEPersistenceProvider provider)
Register the persistence provider to be used when saving and restoring RSE doms. |
ISystemProfile[] |
restoreProfiles(IRSEPersistenceProvider provider,
long timeout)
Restore the profiles for a particular provider. |
ISystemProfile[] |
restoreProfiles(long timeout)
Restore all profiles known to autostart persistence providers. |
Method Detail |
---|
boolean commitProfile(ISystemProfile profile, long timeout)
profile
- the profile to savetimeout
- the timeout value in milliseconds. If the operation cannot be started in this time
it will return false.
ISystemProfile[] commitProfiles(long timeout)
timeout
- the maximum number of milliseconds to wait until the persistence manager becomes available
to schedule a save for an individual profile.
ISystemProfile[] restoreProfiles(long timeout)
timeout
- the maximum number of milliseconds to wait for the manager to become idle for each profile.
ISystemProfile[] restoreProfiles(IRSEPersistenceProvider provider, long timeout)
provider
- a persistence providertimeout
- the maximum number of milliseconds to wait for the manager to become idle before restoring this
the each profile managed by this provider.
void deleteProfile(IRSEPersistenceProvider persistenceProvider, String profileName)
persistenceProvider
- the persistence provider to use to delete the profile.
If this is null the default persistence provider is used.profileName
- The name of the profile to deletevoid migrateProfile(ISystemProfile profile, IRSEPersistenceProvider persistenceProvider)
migrateProfile(profile, persistenceProvider, true);
profile
- the system profile to be migratedpersistenceProvider
- the persistence provider to which this profile will be migrated.IStatus migrateProfile(ISystemProfile profile, IRSEPersistenceProvider persistenceProvider, boolean delete)
profile
- the system profile to be migratedpersistenceProvider
- the persistence provider to which this profile
will be migrated.delete
- true if the persistent form of this profile is to be
deleted from the old provider, false if the persistent form of
the profile is to be marked as migrated.
void registerPersistenceProvider(String id, IRSEPersistenceProvider provider)
id
- the provider id.provider
- the provider.String[] getPersistenceProviderIds()
registerPersistenceProvider(String, IRSEPersistenceProvider)
IRSEPersistenceProvider getPersistenceProvider(String id)
id
- the id of the persistence provider to locate
boolean isBusy()
boolean isRestoreComplete()
|
RSE Release 3.0 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |