Package org.ametys.core.migration.version.handler

Interface VersionHandler

All Known Implementing Classes:

JavaVersionHandler, ScriptVersionHandler, StorageBasedVersionHandler

public interface VersionHandler

Handler to retrieve all versions

Method Summary

Modifier and Type	Method	Description
VersionConfiguration	createVersionConfiguration(Configuration configuration)	Creates a VersionConfiguration associated with this VersionHandler
MigrationEngine.Versions	getVersions(MigrationEngine.MigrationComponent component)	Retrieves a hierarchical view of all Version managed by this component.
VersionStorage	getVersionStorage(VersionConfiguration configuration)	Returns the VersionStorage associated with this VersionHandler.

Method Details

getVersionStorage

VersionStorage getVersionStorage(VersionConfiguration configuration)
                          throws MigrationException

Returns the VersionStorage associated with this VersionHandler.

Parameters:

configuration - the associated configuration

Returns:

the associated VersionStorage

Throws:

MigrationException - if an exception occur while getting the version storage

getVersions

MigrationEngine.Versions getVersions(MigrationEngine.MigrationComponent component)
                              throws MigrationException

Retrieves a hierarchical view of all Version managed by this component.

Parameters:

component - the context component

Returns:

all Version managed by this component

Throws:

MigrationException - something went wrong while retrieveing the versions

createVersionConfiguration

VersionConfiguration createVersionConfiguration(Configuration configuration)
                                         throws ConfigurationException,
NotMigrableInSafeModeException

Creates a VersionConfiguration associated with this VersionHandler

Parameters:

configuration - the Configuration for retrieving versions

Returns:

a configuration for this type of version handler

Throws:

ConfigurationException - something is wrong in the configuration

NotMigrableInSafeModeException - if it's impossible to configure the versions in safe mode