Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
package com.paypal.butterfly.api;
import com.paypal.butterfly.extensions.api.Extension;
import com.paypal.butterfly.extensions.api.TransformationTemplate;
import com.paypal.butterfly.extensions.api.exception.TemplateResolutionException;
import com.paypal.butterfly.extensions.api.upgrade.UpgradeStep;
import java.io.File;
import java.util.List;
import java.util.Optional;
import java.util.Properties;
import java.util.concurrent.CompletableFuture;
/**
* Butterfly façade
*
* @author facarvalho
*/
public interface ButterflyFacade {
/**
* Returns Butterfly version
*
* @return Butterfly version
*/
String getButterflyVersion();
/**
* Returns an unmodifiable list of all registered extensions
*
* @return an unmodifiable list of all registered extensions
*/
List getExtensions();
/**
* Butterfly might be able to automatically identify the type of application
* and which transformation template to be applied to it. This automatic
* transformation template resolution is performed by each registered
* Extension class. Based on the application folder, and its content, each
* registered extension might decide which transformation template should be used
* to transform it. Only one can be chosen. These are the possible resolution results:
*
*
Empty optional is returned: if no transformation template is resolved (unless if extension(s) evaluated the application as invalid,
* then an {@link TemplateResolutionException} is thrown, as explained below in details)
*
An optional with {@link TransformationTemplate} class is returned: if only one transformation template is resolved
*
A {@link TemplateResolutionException} exception is thrown: if one of the following cases is true (call {@link TemplateResolutionException#getMessage()} for details):
*
*
If there are no extensions registered
*
Multiple transformation templates are resolved
*
If no transformation template is resolved, but one or more extensions recognized the application type, but determined it to be invalid for transformation
*
*
*
* @param applicationFolder the folder where the code of the application to be transformed is
* @return see above
* @throws TemplateResolutionException see above
*/
Optional> automaticResolution(File applicationFolder) throws TemplateResolutionException;
/**
* Creates and returns a new {@link Configuration} object
* set to apply the transformation against the original application folder
* and the result will not be compressed to a zip file.
*
* Notice that calling this method will result in {@link Configuration#isModifyOriginalFolder()}
* to return {@code true}.
*
* @param properties a properties object specifying details about the transformation itself.
* These properties help to specialize the
* transformation, for example, determining if certain operations should
* be skipped or not, or how certain aspects of the transformation should
* be executed. The set of possible properties is defined by the used transformation
* extension and template, read the documentation offered by the extension
* for further details. The properties values are defined by the user requesting the transformation.
* Properties are optional, so, if not desired, this parameter can be set to null.
* @return a brand new {@link Configuration} object
* @throws IllegalArgumentException if properties object is invalid. Properties name must
* be non blank and only contain alphabetical characters, dots, underscore or hyphen. Properties
* object must be Strings and cannot be null.
*/
Configuration newConfiguration(Properties properties);
/**
* Creates and returns a new {@link Configuration} object
* set to place the transformed application at a new folder at the original application
* parent folder, besides compressing it to a zip file, depending on {@code zipOutput}.
*
* The transformed application folder's name is the same as original folder,
* plus a "-transformed-yyyyMMddHHmmssSSS" suffix.
*
* Notice that calling this method will result in {@link Configuration#isModifyOriginalFolder()}
* to return {@code false}.
*
* @param properties a properties object specifying details about the transformation itself.
* These properties help to specialize the
* transformation, for example, determining if certain operations should
* be skipped or not, or how certain aspects of the transformation should
* be executed. The set of possible properties is defined by the used transformation
* extension and template, read the documentation offered by the extension
* for further details. The properties values are defined by the user requesting the transformation.
* Properties are optional, so, if not desired, this parameter can be set to null.
* @param zipOutput if true, the transformed application folder will be compressed into a zip file
* @return a brand new {@link Configuration} object
* @throws IllegalArgumentException if properties object is invalid. Properties name must
* be non blank and only contain alphabetical characters, dots, underscore or hyphen. Properties
* object must be Strings and cannot be null.
*/
Configuration newConfiguration(Properties properties, boolean zipOutput);
/**
* Creates and returns a new {@link Configuration} object
* set to place the transformed application at {@code outputFolder},
* and compress it to a zip file or not, depending on {@code zipOutput}.
*
* Notice that calling this method will result in {@link Configuration#isModifyOriginalFolder()}
* to return {@code false}.
*
* @param properties a properties object specifying details about the transformation itself.
* These properties help to specialize the
* transformation, for example, determining if certain operations should
* be skipped or not, or how certain aspects of the transformation should
* be executed. The set of possible properties is defined by the used transformation
* extension and template, read the documentation offered by the extension
* for further details. The properties values are defined by the user requesting the transformation.
* Properties are optional, so, if not desired, this parameter can be set to null.
* @param outputFolder the output folder where the transformed application is
* supposed to be placed
* @param zipOutput if true, the transformed application folder will be compressed into a zip file
* @return a brand new {@link Configuration} object
* @throws IllegalArgumentException if {@code outputFolder} is null, does not exist, or is not a directory
* @throws IllegalArgumentException if properties object is invalid. Properties name must
* be non blank and only contain alphabetical characters, dots, underscore or hyphen. Properties
* object must be Strings and cannot be null.
*/
Configuration newConfiguration(Properties properties, File outputFolder, boolean zipOutput);
/**
* Transforms an application in an asynchronous and non-blocking manner.
* If templateClass is a {@link UpgradeStep}, application will be upgraded to the latest version.
*
* @param applicationFolder application folder
* @param templateClass transformation template class
* @return the transformation result object
*/
CompletableFuture transform(File applicationFolder, Class templateClass);
/**
* Transforms an application in an asynchronous and non-blocking manner.
* If templateClass is a {@link UpgradeStep}, application will be upgraded according to version.
* It also accepts an additional parameter providing configuration. See {@link Configuration} for further information.
*
* @param applicationFolder application folder
* @param templateClass transformation template class
* @param version the target upgrade version. If this parameter is null or blank, application will be upgraded to the latest version.
* If templateClass is not a {@link UpgradeStep}, this parameter is ignored.
* @param configuration Butterfly configuration object
* @throws IllegalArgumentException if templateClass is a {@link UpgradeStep} and version is not empty and an unknown version
* @return the transformation result object
*/
CompletableFuture transform(File applicationFolder, Class templateClass, String version, Configuration configuration);
}
