Package 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:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final SpecialistType<FeatureInstallAgent>
The agent's technical type to be used to request the agent from aSpecialistsBroker
. -
Method Summary
Modifier and TypeMethodDescriptionanalyzeFeature
(@NotNull FeatureFile featureFile) Starts a server side feature analyze process for the given feature file.installFeature
(@NotNull FeatureFile featureFile, @NotNull Map<String, String> layerMapping) Deprecated.installFeature
(@NotNull FeatureFile featureFile, @Nullable LayerMapper layerMapper) Starts a server side feature installation process for the given feature file.uploadFeatureFile
(@NotNull InputStream stream) Uploads the given stream (originated from a feature transport zip file) to the server and returns the relatedfeature file
-
Field Details
-
TYPE
The agent's technical type to be used to request the agent from aSpecialistsBroker
.- Since:
- 5.0.111
-
-
Method Details
-
uploadFeatureFile
Uploads the given stream (originated from a feature transport zip file) to the server and returns the relatedfeature file
- Throws:
IOException
- Since:
- 5.0.111
- See Also:
-
analyzeFeature
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 ServerActionHandle<? extends FeatureProgress,FeatureInstallResult> installFeature(@NotNull @NotNull FeatureFile featureFile, @NotNull @NotNull Map<String, String> layerMapping) throws IOExceptionDeprecated.since 5.2.513 - useinstallFeature(FeatureFile, LayerMapper)
insteadStarts a server side feature installation process for the given feature file.- Parameters:
layerMapping
- the databaselayer
mapping for the installation process. (key = layer name of source project; value = layer name of target project). Given mapping must contain mappings forupdates
andnew 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
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 newschema
which doesn't exists in the target project will be installed during the process.- Parameters:
layerMapper
- the databaselayer
mapping for the installation process. Given layerMapper must provide mappings forupdates
andnew 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(FeatureFile, LayerMapper)
instead