org.apache.unomi.shell.migration

Interface Migration

All Known Implementing Classes:

MigrationTo121, MigrationTo122, MigrationTo150

public interface Migration

This interface must be implemented if you create a new migration class

Author:

dgaillard

Method Summary

Modifier and Type	Method and Description
void	execute(org.apache.karaf.shell.api.console.Session session, org.apache.http.impl.client.CloseableHttpClient httpClient, String esAddress, org.osgi.framework.BundleContext bundleContext) This method is called to execute the migration
String	getDescription() This method returns a short description of the changes performed during this migration
org.osgi.framework.Version	getFromVersion() This method return the minimal version before applying this migration TODO: not used for now
org.osgi.framework.Version	getToVersion() This method return the target version after migration

Method Detail

getFromVersion

org.osgi.framework.Version getFromVersion()

This method return the minimal version before applying this migration TODO: not used for now

Returns:

return the version

getToVersion

org.osgi.framework.Version getToVersion()

This method return the target version after migration

Returns:

the target version

getDescription

String getDescription()

This method returns a short description of the changes performed during this migration

Returns:

the migration description

execute

void execute(org.apache.karaf.shell.api.console.Session session,
             org.apache.http.impl.client.CloseableHttpClient httpClient,
             String esAddress,
             org.osgi.framework.BundleContext bundleContext)
      throws IOException

This method is called to execute the migration

Parameters:

session - the shell's session

httpClient - CloseableHttpClient

esAddress - the fully qualified address at which the ElasticSearch is reachable (ie http://localhost:9200)

bundleContext - the bundle context object

Throws:

IOException - if there was an error while executing the migration