Package de.espirit.firstspirit.feature

Interface FeatureInstallAgent

@NonExtendable
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	Description
static final SpecialistType<FeatureInstallAgent>	TYPE	The agent's technical type to be used to request the agent from a SpecialistsBroker.

Method Summary

Modifier and Type	Method	Description
@NotNull ServerActionHandle<? extends FeatureProgress,FeatureAnalyseResult>	analyzeFeature(@NotNull FeatureFile featureFile)	Starts a server side feature analyze process for the given feature file.
@NotNull ServerActionHandle<? extends FeatureProgress,FeatureInstallResult>	installFeature(@NotNull FeatureFile featureFile, @NotNull Map<String,String> layerMapping)	Deprecated, for removal: This API element is subject to removal in a future version. since 5.2.513 - use installFeature(FeatureFile, LayerMapper) instead
@NotNull ServerActionHandle<? extends FeatureProgress,FeatureInstallResult>	installFeature(@NotNull FeatureFile featureFile, @Nullable LayerMapper layerMapper)	Starts a server side feature installation process for the given feature file.
@NotNull ServerActionHandle<? extends FeatureProgress,FeatureInstallResult>	installFeature(@NotNull FeatureInstallOptions options)	Starts a server side feature installation process for the given FeatureInstallOptions.
@NotNull FeatureFile	uploadFeatureFile(@NotNull InputStream stream)	Uploads the given stream (originated from a feature transport zip file) to the server and returns the related feature file

Field Details

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 Details

uploadFeatureFile

@NotNull
@NotNull FeatureFile uploadFeatureFile(@NotNull
 @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:

• installFeature(FeatureFile, LayerMapper)

analyzeFeature

@NotNull
@NotNull ServerActionHandle<? extends FeatureProgress,FeatureAnalyseResult> analyzeFeature(@NotNull
 @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

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

Deprecated, for removal: This API element is subject to removal in a future version.

since 5.2.513 - use installFeature(FeatureFile, LayerMapper) instead

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; value = 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

installFeature

@NotNull
@NotNull ServerActionHandle<? extends FeatureProgress,FeatureInstallResult> installFeature(@NotNull
 @NotNull FeatureFile featureFile,
 @Nullable
 @Nullable LayerMapper layerMapper)
                                                                                    throws IOException

Starts a server side feature installation process for the given feature file. Passing a layer mapper is mandatory, if a new schema which doesn't exists in the target project will be installed during the process.

Parameters:

layerMapper - the database layer mapping for the installation process. Given layerMapper must provide mappings for updates and new created schemes - it isn't necessary (nullable) to pass a layerMapper if no new schema will be installed

Returns:

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

Throws:

IOException

Since:

5.2.513

installFeature

@NotNull
@NotNull ServerActionHandle<? extends FeatureProgress,FeatureInstallResult> installFeature(@NotNull
 @NotNull FeatureInstallOptions options)
                                                                                    throws IOException

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

Parameters:

options - the FeatureInstallOptions specifying the related options for the installation process.

Returns:

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

Throws:

IOException

Since:

5.2.231104