com.microfocus.da.sct.interfaces

Interface CommonIntegrator

public interface CommonIntegrator

Base interface that defines the functionality of an external source configuration type

Author:

Serena Software, Inc., a Micro Focus Company

Method Summary

Modifier and Type	Method and Description
void	downloadVersionContent(VersionInfo versionInfo, File processingDirectoryLocation) This method extracts the information from VersionInfo and starts processing artifacts.
default Collection<String>	getAlerts(Locale locale) This method is responsible for showing any alerts or warning messages before running the integration for version creation.
Collection<VersionInfo>	getNextVersionInfo(Properties properties) This method returns the VersionInfo composition object that is required for downloading and processing the artifact.

Method Detail

getNextVersionInfo

Collection<VersionInfo> getNextVersionInfo(Properties properties)
                                    throws Exception

This method returns the VersionInfo composition object that is required for downloading and processing the artifact.

Parameters:

properties - Individual properties from which each versionParam is extracted and used for downloading or processing.

Returns:

Collection of VersionInfo objects

Throws:

Exception - If something goes wrong

downloadVersionContent

void downloadVersionContent(VersionInfo versionInfo,
                            File processingDirectoryLocation)
                     throws Exception

This method extracts the information from VersionInfo and starts processing artifacts. Because the cleanup operation is handled implicitly, use the processingDirectoryLocation for all of the processing. Its contents are deleted after the version processing is done. The returned file object should be in the same location because of the cleaning operation.

Parameters:

versionInfo - VersionInfo object that has the required information for creating a version.

processingDirectoryLocation - The processingDirectoryLocation is the location where all the artifact processing is done. You can use the Java temp directory for this.

Throws:

Exception - If something goes wrong

getAlerts

default Collection<String> getAlerts(Locale locale)
                              throws Exception

This method is responsible for showing any alerts or warning messages before running the integration for version creation. When you implement this you must return any warning and alert messages as part of pre-validation to avoid integration failures.

Parameters:

locale - This is important when you need to strings to be displayed in the language for a specific locale.

Returns:

Collection of composed alerts

Throws:

Exception - If the composition of alerts fails