de.espirit.firstspirit.feature

Interface FeatureInstallAgent

public interface FeatureInstallAgent

Agent providing means to handle installation of content transport features. This agent is related to the project specified by the surrounding context. This project is the target of feature installations.

Example:
SpecialistsBroker.requireSpecialist(FeatureInstallAgent.TYPE)

Since:

5.0.111

See Also:

SpecialistsBroker.requireSpecialist(SpecialistType)

Field Summary

Fields

Modifier and Type	Field and Description
static SpecialistType<FeatureInstallAgent>	TYPE The agent's technical type to be used to request the agent from a SpecialistsBroker.

Method Summary

Methods

Modifier and Type	Method and Description
ServerActionHandle<? extends FeatureProgress,FeatureAnalyseResult>	analyzeFeature(FeatureFile featureFile) Starts a server side feature analyze process for the given feature file.
ServerActionHandle<? extends FeatureProgress,FeatureInstallResult>	installFeature(FeatureFile featureFile, Map<String,String> layerMapping) Starts a server side feature installation process for the given feature file.
FeatureFile	uploadFeatureFile(InputStream stream) Uploads the given stream (originated from a feature transport zip file) to the server and returns the related feature file

Field Detail

TYPE

static final SpecialistType<FeatureInstallAgent> TYPE

The agent's technical type to be used to request the agent from a SpecialistsBroker.

Since:

5.0.111

Method Detail

uploadFeatureFile

FeatureFile uploadFeatureFile(@NotNull
                            InputStream stream)
                              throws IOException

Uploads the given stream (originated from a feature transport zip file) to the server and returns the related feature file

Throws:

IOException

Since:

5.0.111

See Also:

#startFeatureAnalyse(FeatureFile), #startFeatureInstall(FeatureFile, Map)

analyzeFeature

ServerActionHandle<? extends FeatureProgress,FeatureAnalyseResult> analyzeFeature(@NotNull
                                                                                FeatureFile featureFile)
                                                                                  throws IOException

Starts a server side feature analyze process for the given feature file.

Returns:

the server action handle providing means to progress and state of the server side process

Throws:

IOException

Since:

5.0.111

installFeature

ServerActionHandle<? extends FeatureProgress,FeatureInstallResult> installFeature(@NotNull
                                                                                FeatureFile featureFile,
                                                                                @NotNull
                                                                                Map<String,String> layerMapping)
                                                                                  throws IOException

Starts a server side feature installation process for the given feature file.

Parameters:

layerMapping - the database layer mapping for the installation process. (key = layer name of source project; key = layer name of target project). Given mapping must contain mappings for updates and new created schemes

Returns:

the server action handle providing means to progress and state of the server side process

Throws:

IOException

Since:

5.0.111