org.rundeck.core.projects

Interface ProjectDataExporter

All Known Subinterfaces:

ProjectComponent

public interface ProjectDataExporter

exporter for project data into archive file

Method Summary

Modifier and Type	Method and Description
default void	export(java.lang.String project, java.lang.Object zipBuilder, java.util.Map<java.lang.String,java.lang.String> exportOptions) Export data for the project
default java.util.List<java.lang.String>	getExportAuthRequiredActions()
default java.util.List<java.lang.String>	getExportMustRunAfter()
default java.util.List<java.lang.String>	getExportMustRunBefore()
default java.util.List<Property>	getExportProperties()
default boolean	isExportDefault()
default boolean	isExportOptional()

Method Detail

export

default void export(java.lang.String project,
                    java.lang.Object zipBuilder,
                    java.util.Map<java.lang.String,java.lang.String> exportOptions)

Export data for the project

Parameters:

project - project name

zipBuilder - ZipBuilder

exportOptions - options for this component

getExportAuthRequiredActions

default java.util.List<java.lang.String> getExportAuthRequiredActions()

Returns:

authorization action names to test, any match will be allowed

isExportOptional

default boolean isExportOptional()

Returns:

true if this type of data can be deselected for export, false if the data should always be exported

isExportDefault

default boolean isExportDefault()

Returns:

true if this type of data should be exported by default for the project, if it is also optional

getExportProperties

default java.util.List<Property> getExportProperties()

Returns:

list of input properties for export process

getExportMustRunBefore

default java.util.List<java.lang.String> getExportMustRunBefore()

Returns:

list of component names to run before

getExportMustRunAfter

default java.util.List<java.lang.String> getExportMustRunAfter()

Returns:

list of component names to run after