Package de.espirit.firstspirit.feature

Interface FeatureAgent

public interface FeatureAgent

Agent providing means to handle content transport features. This agent is related to the project specified by the surrounding context.

A feature is a collection of project contents or properties which can be transported between different projects. Detailed information can be found in the "CorporateContent" documentation.

Example:
SpecialistsBroker.requireSpecialist(FeatureAgent.TYPE)

Since:

5.0.111

See Also:

• SpecialistsBroker.requireSpecialist(SpecialistType)

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	FeatureAgent.FeatureBuilder	A builder for creating a new feature descriptor.

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
FeatureDescriptor	createFeature(String name, Revision revision, boolean release)	Create a new feature with the given name.
@NotNull FeatureAgent.FeatureBuilder	createFeatureBuilder(@NotNull FeatureDescriptor descriptor)	Returns a builder where you can create a new feature descriptor using the provided instance as blueprint.
FeatureModel	createFeatureModel(FeatureDescriptor featureDescriptor)	Create a feature model based on the given feature descriptor.
ServerActionHandle<? extends FeatureProgress,Boolean>	createFeatureTransportFile(FeatureDescriptor featureDescriptor)	Starts a server side process to create a feature transport file.
void	deleteFeature(FeatureDescriptor featureDescriptor)	Deletes the feature specified by the given feature descriptor.
void	deleteFeatureFile(@NotNull FeatureFile featureFile)	Deletes the given FeatureFile in the current project.
InputStream	downloadFeatureFile(@NotNull FeatureFile featureFile)	Download the feature transport zip file specified by the given featureFile.
List<FeatureDescriptor>	getFeatureDescriptors()	Returns a list of all feature descriptors available for the project this agent is related to.
@NotNull List<FeatureFile>	getFeatureFiles()	Returns a list of all featureFiles existing on the server for the current project.
void	saveFeature(FeatureModel model)	Saves the given feature model and its related feature descriptor.

Field Details

TYPE

static final SpecialistType<FeatureAgent> TYPE

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

Since:

5.0.111

Method Details

getFeatureDescriptors

List<FeatureDescriptor> getFeatureDescriptors()

Returns a list of all feature descriptors available for the project this agent is related to.

Since:

5.0.111

createFeature

FeatureDescriptor createFeature(String name,
 Revision revision,
 boolean release)

Create a new feature with the given name.

Parameters:

name - the name of the feature to be created

revision - the revision the userservice of the content objects of the new feature belongs to

release - indicates whether the content object of this feature belongs to a release store or not

Since:

5.0.111

deleteFeature

void deleteFeature(FeatureDescriptor featureDescriptor)

Deletes the feature specified by the given feature descriptor.

Since:

5.0.413

See Also:

• getFeatureDescriptors()

createFeatureModel

FeatureModel createFeatureModel(FeatureDescriptor featureDescriptor)

Create a feature model based on the given feature descriptor. The descriptor is only used as initial parameter set. Therefor change params before calling this method if you want them to be persisted during saving

Since:

5.0.111

See Also:

• saveFeature(FeatureModel)

saveFeature

void saveFeature(FeatureModel model)

Saves the given feature model and its related feature descriptor.

Since:

5.0.111

See Also:

• createFeatureModel(de.espirit.firstspirit.feature.FeatureDescriptor)

createFeatureTransportFile

ServerActionHandle<? extends FeatureProgress,Boolean> createFeatureTransportFile(FeatureDescriptor featureDescriptor)

Starts a server side process to create a feature transport file.

Returns:

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

Since:

5.0.111

See Also:

• downloadFeatureFile(FeatureFile)

getFeatureFiles

@NotNull
@NotNull List<FeatureFile> getFeatureFiles()
                                    throws ParseException,
IOException

Returns a list of all featureFiles existing on the server for the current project.

Throws:

ParseException

IOException

Since:

5.2.230703

downloadFeatureFile

InputStream downloadFeatureFile(@NotNull
 @NotNull FeatureFile featureFile)
                         throws IOException

Download the feature transport zip file specified by the given featureFile. During a service side transport file creation process, a feature file can be received via the feature progess.

Parameters:

featureFile - specifying the transport zip file to download

Throws:

IOException

Since:

5.0.111

See Also:

• FeatureProgress.getFeatureFile()

deleteFeatureFile

void deleteFeatureFile(@NotNull
 @NotNull FeatureFile featureFile)
                throws IOException

Deletes the given FeatureFile in the current project.

Parameters:

featureFile - the FeatureFile to delete

Throws:

IOException

Since:

5.2.230703

createFeatureBuilder

@NotNull
@NotNull FeatureAgent.FeatureBuilder createFeatureBuilder(@NotNull
 @NotNull FeatureDescriptor descriptor)

Returns a builder where you can create a new feature descriptor using the provided instance as blueprint.

Parameters:

descriptor - Feature descriptor to use as blueprint.

Returns:

A factory where you can create a new feature descriptor based on the provided instance.

Since:

5.2.1203