Package org.ametys.plugins.repository.migration.jcr.data

Class JcrDataVersionStorage

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.repository.migration.jcr.data.JcrDataVersionStorage

All Implemented Interfaces:

VersionStorage, LogEnabled, Serviceable

public class JcrDataVersionStorage
extends AbstractLogEnabled
implements VersionStorage, Serviceable

JCR implementation of VersionStorage, to manage the list of versions in a repository

Field Summary

Fields

Modifier and Type	Field	Description
protected MigrationExtensionPoint	_migrationEP	The migration extension point
protected AmetysObjectResolver	_resolver	The Ametys object resolver
protected VersionsRootHelper	_versionsRootHelper	The versions root helper

Constructor Summary

Constructors

Constructor	Description
JcrDataVersionStorage()

Method Summary

Modifier and Type	Method	Description
private VersionComponentAmetysObject	_createComponentObject(String componentId)
private VersionComponentAmetysObject	_getComponentObject(String componentId, boolean create)
private Optional<Version>	_getCurrentVersion(String versionHandlerId, String componentId)
void	addVersion(Version version)	Add a version
List<Version>	getAllVersions(String componentIdentifier, VersionConfiguration configuration, String versionHandlerId)	Get the history of all versions for a component identifier
VersionConfiguration	getConfiguration(String componentId, Configuration versionConfiguration)	Create a specific object containing usefull data for the handler/storage
Version	getCurrentVersion(String componentIdentifier, VersionConfiguration configuration, String versionHandlerId)	Find the current version for a component identifier
void	removeAllVersions(String componentIdentifier, VersionConfiguration configuration)	Remove all versions for a component identifier
void	service(ServiceManager manager)

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

_resolver

protected AmetysObjectResolver _resolver

The Ametys object resolver

_migrationEP

protected MigrationExtensionPoint _migrationEP

The migration extension point

_versionsRootHelper

protected VersionsRootHelper _versionsRootHelper

The versions root helper

Constructor Detail

JcrDataVersionStorage

public JcrDataVersionStorage()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

getCurrentVersion

public Version getCurrentVersion(String componentIdentifier,
                                 VersionConfiguration configuration,
                                 String versionHandlerId)
                          throws MigrationException

Description copied from interface: VersionStorage

Find the current version for a component identifier

Specified by:

getCurrentVersion in interface VersionStorage

Parameters:

componentIdentifier - component to look for

configuration - configuration to use

versionHandlerId - id of the VersionHandler

Returns:

the current version for this component (can have a versionId null if no version is found), or null if it is impossible to determine the version (e.g. safe mode).

Throws:

MigrationException - Something went wrong

NotMigrableInSafeModeException - Impossible to determine the version

getAllVersions

public List<Version> getAllVersions(String componentIdentifier,
                                    VersionConfiguration configuration,
                                    String versionHandlerId)
                             throws MigrationException

Description copied from interface: VersionStorage

Get the history of all versions for a component identifier

Specified by:

getAllVersions in interface VersionStorage

Parameters:

componentIdentifier - component to look for

configuration - configuration to use

versionHandlerId - id of the VersionHandler

Returns:

list of all versions for this component

Throws:

MigrationException - Something went wrong

NotMigrableInSafeModeException - Impossible to determine the version

addVersion

public void addVersion(Version version)
                throws MigrationException

Description copied from interface: VersionStorage

Add a version

Specified by:

addVersion in interface VersionStorage

Parameters:

version - Version to store (contains the component identifier)

Throws:

MigrationException - Something went wrong

removeAllVersions

public void removeAllVersions(String componentIdentifier,
                              VersionConfiguration configuration)
                       throws MigrationException

Description copied from interface: VersionStorage

Remove all versions for a component identifier

Specified by:

removeAllVersions in interface VersionStorage

Parameters:

componentIdentifier - component to clear

configuration - configuration to use

Throws:

MigrationException - Something went wrong

_getCurrentVersion

private Optional<Version> _getCurrentVersion(String versionHandlerId,
                                             String componentId)

_getComponentObject

private VersionComponentAmetysObject _getComponentObject(String componentId,
                                                         boolean create)

_createComponentObject

private VersionComponentAmetysObject _createComponentObject(String componentId)

getConfiguration

public VersionConfiguration getConfiguration(String componentId,
                                             Configuration versionConfiguration)
                                      throws ConfigurationException

Description copied from interface: VersionStorage

Create a specific object containing usefull data for the handler/storage

Specified by:

getConfiguration in interface VersionStorage

Parameters:

componentId - id of the component

versionConfiguration - configuration from the plugin.xml

Returns:

the confuguration object

Throws:

ConfigurationException - something wrong in the configuration