com.microsoft.azure.maven.function

Class PackageMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.microsoft.azure.maven.AbstractAzureMojo

com.microsoft.azure.maven.appservice.AbstractAppServiceMojo

com.microsoft.azure.maven.function.AbstractFunctionMojo

com.microsoft.azure.maven.function.PackageMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

@Mojo(name="package",
      defaultPhase=PACKAGE,
      requiresDependencyResolution=RUNTIME)
public class PackageMojo
extends AbstractFunctionMojo

Generate configuration files (host.json, function.json etc.) and copy JARs to staging directory.

Nested Class Summary

Nested classes/interfaces inherited from class com.microsoft.azure.maven.AbstractAzureMojo

AbstractAzureMojo.DefaultUncaughtExceptionHandler, AbstractAzureMojo.RunnableWithException

Field Summary

Fields

Modifier and Type	Field and Description
private static String	AZURE_FUNCTIONS_JAVA_CORE_LIBRARY
static String	BUILD_SUCCESS
private static String	BUILD_UBER_ARTIFACT_EXCEPTION
protected Boolean	buildJarWithDependencies Boolean flag to control whether to build fat jar or use the original jar with dependencies in lib folder
static String	COPY_JARS
static String	COPY_SUCCESS
private static String	DEFAULT_HOST_JSON
private static String	DEFAULT_LOCAL_SETTINGS_JSON
static String	EXTENSION_BUNDLE
private static String	EXTENSION_BUNDLE_ID
private static String	EXTENSION_BUNDLE_PREVIEW_ID
static String	FOUND_FUNCTIONS
static String	FUNCTION_JSON
private static BindingEnum[]	FUNCTION_WITHOUT_FUNCTION_EXTENSION
static String	GENERATE_CONFIG
static String	GENERATE_DONE
static String	GENERATE_SKIP
static String	INSTALL_EXTENSIONS
static String	INSTALL_EXTENSIONS_FINISH
static String	NO_FUNCTIONS
static String	SAVE_FUNCTION_JSON
static String	SAVE_FUNCTION_JSONS
static String	SAVE_SKIP
static String	SAVE_SUCCESS
static String	SAVING_HOST_JSON
static String	SAVING_LOCAL_SETTINGS_JSON
static String	SEARCH_FUNCTIONS
private static String	SKIP_INSTALL_EXTENSIONS_BUNDLE
private static String	SKIP_INSTALL_EXTENSIONS_FLAG
static String	SKIP_INSTALL_EXTENSIONS_HTTP
protected Boolean	skipCopyDependencies Boolean flag to control whether to skip copy dependencies to staging directory
protected Boolean	skipInstallExtensions Boolean flag to skip extension installation
static String	VALIDATE_CONFIG
static String	VALIDATE_DONE
static String	VALIDATE_SKIP

Fields inherited from class com.microsoft.azure.maven.function.AbstractFunctionMojo

alwaysReadyInstances, appInsightsInstance, appInsightsKey, artifactPath, AZURE_FUNCTIONS_JAVA_LIBRARY, CAN_NOT_FIND_ARTIFACT, disableAppInsights, enableDistributedTracing, environment, finalName, FUNCTION_EXTENSION_LIBRARY_MAP, HOST_JSON, hostJson, instanceSize, LOCAL_SETTINGS_JSON, localSettingsJson, maximumInstances, maxReplicas, minReplicas, outputDirectory, parser, pricingTier, region, runtime, skip, storageAccountName, storageAccountResourceGroup, TRIGGER_TYPE

Fields inherited from class com.microsoft.azure.maven.appservice.AbstractAppServiceMojo

appName, appServiceClient, appServicePlanName, appServicePlanResourceGroup, appSettings, deploymentSlotSetting, MAVEN_PLUGIN_POSTFIX, resourceGroup

Fields inherited from class com.microsoft.azure.maven.AbstractAzureMojo

allowTelemetry, auth, authType, buildDirectory, COMPILE_LEVEL_NOT_SUPPORTED, FAILED_TO_GET_VALID_RUNTIMES, failsOnError, failsOnRuntimeValidationError, INSTALLATION_ID_KEY, mavenResourcesFiltering, plugin, PLUGIN_NAME_KEY, PLUGIN_VERSION_KEY, project, session, SESSION_ID_KEY, settings, settingsDecrypter, SUBSCRIPTION_ID_KEY, SUBSCRIPTION_NOT_FOUND, SUBSCRIPTION_TEMPLATE, subscriptionId, telemetries, telemetryProxy, USING_AZURE_ENVIRONMENT

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
PackageMojo()

Method Summary

Modifier and Type	Method and Description
static void	buildArtifactWithDependencies(File artifactFile, Set<File> dependencies, File target)
private void	copyArtifactToStagingDirectory(File stagingDirectory, Set<File> dependencies)
private void	copyDependenciesToStagingDirectory(File stagingDirectory, Set<File> dependencies)
private static void	copyFilesWithDefaultContent(File source, File dest, String defaultContent)
private static void	copyFileToDirectory(File srcFile, File destFile)
protected void	copyHostJson()
protected void	copyJarsToStageDirectory()
protected void	copyLocalSettingsJson()
protected void	doExecute()
protected Set<Method>	findAnnotatedMethods(AnnotationHandler handler)
protected AnnotationHandler	getAnnotationHandler()
protected URL	getArtifactUrl()
private static List<org.apache.maven.plugins.shade.resource.ResourceTransformer>	getDefaultResourceTransformers()
protected List<URL>	getDependencyArtifactUrls()
private static org.apache.maven.plugins.shade.filter.Filter	getExcludeSignFilesFilter(Set<File> jars)
protected Set<BindingEnum>	getFunctionBindingEnums(Map<String,FunctionConfiguration> configMap)
protected Map<String,FunctionConfiguration>	getFunctionConfigurations(AnnotationHandler handler, Set<Method> methods)
protected FunctionCoreToolsHandler	getFunctionCoreToolsHandler(CommandHandler commandHandler)
protected com.fasterxml.jackson.databind.ObjectWriter	getObjectWriter()
List<DeploymentResource>	getResources()
protected String	getScriptFilePath()
protected URL	getTargetClassUrl()
protected void	installExtension(FunctionCoreToolsHandler handler, Set<BindingEnum> bindingEnums)
protected boolean	isInstallingExtensionNeeded(Set<BindingEnum> bindingTypes)
protected void	promptCompileInfo()
protected void	trackFunctionProperties(Map<String,FunctionConfiguration> configMap)
protected void	validateFunctionConfigurations(Map<String,FunctionConfiguration> configMap)
protected void	writeFunctionJsonFile(com.fasterxml.jackson.databind.ObjectWriter objectWriter, String functionName, FunctionConfiguration config)
protected void	writeFunctionJsonFiles(com.fasterxml.jackson.databind.ObjectWriter objectWriter, Map<String,FunctionConfiguration> configMap)
protected void	writeObjectToFile(com.fasterxml.jackson.databind.ObjectWriter objectWriter, Object object, File targetFile)

Methods inherited from class com.microsoft.azure.maven.function.AbstractFunctionMojo

getAppInsightsInstance, getAppInsightsKey, getArtifact, getBundleVersion, getFinalName, getFunctionLibraryVersion, getHostJsonFile, getLocalSettingsJsonFile, getRegion, getRuntimeConfiguration, getTelemetryProperties, isDisableAppInsights, isSkipMojo, readHostJson, validateAppName, validateFunctionCompatibility

Methods inherited from class com.microsoft.azure.maven.appservice.AbstractAppServiceMojo

getAppName, getAppServicePlanName, getAppServicePlanResourceGroup, getAppSettings, getDeploymentSlotSetting, getDeploymentStagingDirectoryPath, getResourceGroup, initAzureAppServiceClient, printCurrentSubscription

Methods inherited from class com.microsoft.azure.maven.AbstractAzureMojo

afterMojoExecution, beforeMojoExecution, checkSubscription, execute, executeWithTimeRecorder, getActualAuthType, getAllowTelemetry, getBuildDirectoryAbsolutePath, getCompileLevel, getFailsOnError, getFailsOnRuntimeValidationError, getInstallationId, getMavenResourcesFiltering, getPluginName, getPluginVersion, getProject, getSession, getSessionId, getSettings, getSubscriptionId, getTargetSubscriptionId, getTelemetries, getTelemetryProxy, getUserAgent, getValidRuntimes, highlightDefaultValue, infoWithMultipleLines, initTelemetryProxy, loginAzure, loginAzure, onMojoError, onSkipped, printCredentialDescription, selectSubscription, selectSubscription, trackMojoFailure, updateTelemetryProperties, validateArtifactCompileVersion

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SEARCH_FUNCTIONS

public static final String SEARCH_FUNCTIONS

See Also:

Constant Field Values

FOUND_FUNCTIONS

public static final String FOUND_FUNCTIONS

See Also:

Constant Field Values

NO_FUNCTIONS

public static final String NO_FUNCTIONS

See Also:

Constant Field Values

GENERATE_CONFIG

public static final String GENERATE_CONFIG

See Also:

Constant Field Values

GENERATE_SKIP

public static final String GENERATE_SKIP

See Also:

Constant Field Values

GENERATE_DONE

public static final String GENERATE_DONE

See Also:

Constant Field Values

VALIDATE_CONFIG

public static final String VALIDATE_CONFIG

See Also:

Constant Field Values

VALIDATE_SKIP

public static final String VALIDATE_SKIP

See Also:

Constant Field Values

VALIDATE_DONE

public static final String VALIDATE_DONE

See Also:

Constant Field Values

SAVING_HOST_JSON

public static final String SAVING_HOST_JSON

See Also:

Constant Field Values

SAVING_LOCAL_SETTINGS_JSON

public static final String SAVING_LOCAL_SETTINGS_JSON

See Also:

Constant Field Values

SAVE_FUNCTION_JSONS

public static final String SAVE_FUNCTION_JSONS

See Also:

Constant Field Values

SAVE_SKIP

public static final String SAVE_SKIP

See Also:

Constant Field Values

SAVE_FUNCTION_JSON

public static final String SAVE_FUNCTION_JSON

See Also:

Constant Field Values

SAVE_SUCCESS

public static final String SAVE_SUCCESS

See Also:

Constant Field Values

COPY_JARS

public static final String COPY_JARS

See Also:

Constant Field Values

COPY_SUCCESS

public static final String COPY_SUCCESS

See Also:

Constant Field Values

INSTALL_EXTENSIONS

public static final String INSTALL_EXTENSIONS

See Also:

Constant Field Values

SKIP_INSTALL_EXTENSIONS_HTTP

public static final String SKIP_INSTALL_EXTENSIONS_HTTP

See Also:

Constant Field Values

INSTALL_EXTENSIONS_FINISH

public static final String INSTALL_EXTENSIONS_FINISH

See Also:

Constant Field Values

BUILD_SUCCESS

public static final String BUILD_SUCCESS

See Also:

Constant Field Values

FUNCTION_JSON

public static final String FUNCTION_JSON

See Also:

Constant Field Values

EXTENSION_BUNDLE

public static final String EXTENSION_BUNDLE

See Also:

Constant Field Values

AZURE_FUNCTIONS_JAVA_CORE_LIBRARY

private static final String AZURE_FUNCTIONS_JAVA_CORE_LIBRARY

See Also:

Constant Field Values

DEFAULT_LOCAL_SETTINGS_JSON

private static final String DEFAULT_LOCAL_SETTINGS_JSON

See Also:

Constant Field Values

DEFAULT_HOST_JSON

private static final String DEFAULT_HOST_JSON

See Also:

Constant Field Values

FUNCTION_WITHOUT_FUNCTION_EXTENSION

private static final BindingEnum[] FUNCTION_WITHOUT_FUNCTION_EXTENSION

EXTENSION_BUNDLE_ID

private static final String EXTENSION_BUNDLE_ID

See Also:

Constant Field Values

EXTENSION_BUNDLE_PREVIEW_ID

private static final String EXTENSION_BUNDLE_PREVIEW_ID

See Also:

Constant Field Values

SKIP_INSTALL_EXTENSIONS_FLAG

private static final String SKIP_INSTALL_EXTENSIONS_FLAG

See Also:

Constant Field Values

SKIP_INSTALL_EXTENSIONS_BUNDLE

private static final String SKIP_INSTALL_EXTENSIONS_BUNDLE

See Also:

Constant Field Values

BUILD_UBER_ARTIFACT_EXCEPTION

private static final String BUILD_UBER_ARTIFACT_EXCEPTION

See Also:

Constant Field Values

skipInstallExtensions

@Parameter(property="functions.skipInstallExtensions",
           defaultValue="false")
protected Boolean skipInstallExtensions

Boolean flag to skip extension installation

skipCopyDependencies

@Parameter(property="functions.skipCopyDependencies",
           defaultValue="false")
protected Boolean skipCopyDependencies

Boolean flag to control whether to skip copy dependencies to staging directory

buildJarWithDependencies

@Parameter(property="functions.buildJarWithDependencies",
           defaultValue="false")
protected Boolean buildJarWithDependencies

Boolean flag to control whether to build fat jar or use the original jar with dependencies in lib folder

Constructor Detail

PackageMojo

public PackageMojo()

Method Detail

doExecute

protected void doExecute()
                  throws com.microsoft.azure.toolkit.lib.common.exception.AzureExecutionException

Specified by:

doExecute in class AbstractAzureMojo

Throws:

com.microsoft.azure.toolkit.lib.common.exception.AzureExecutionException

buildArtifactWithDependencies

public static void buildArtifactWithDependencies(@Nonnull
                                                 File artifactFile,
                                                 @Nullable
                                                 Set<File> dependencies,
                                                 File target)

getDefaultResourceTransformers

private static List<org.apache.maven.plugins.shade.resource.ResourceTransformer> getDefaultResourceTransformers()

getExcludeSignFilesFilter

private static org.apache.maven.plugins.shade.filter.Filter getExcludeSignFilesFilter(Set<File> jars)

getAnnotationHandler

protected AnnotationHandler getAnnotationHandler()

findAnnotatedMethods

protected Set<Method> findAnnotatedMethods(AnnotationHandler handler)
                                    throws MalformedURLException

Throws:

MalformedURLException

getArtifactUrl

protected URL getArtifactUrl()
                      throws MalformedURLException

Throws:

MalformedURLException

getTargetClassUrl

protected URL getTargetClassUrl()
                         throws MalformedURLException

Throws:

MalformedURLException

getDependencyArtifactUrls

protected List<URL> getDependencyArtifactUrls()

Returns:

URLs for the classpath with compile scope needed jars

getFunctionConfigurations

protected Map<String,FunctionConfiguration> getFunctionConfigurations(AnnotationHandler handler,
                                                                      Set<Method> methods)
                                                               throws com.microsoft.azure.toolkit.lib.common.exception.AzureExecutionException

Throws:

com.microsoft.azure.toolkit.lib.common.exception.AzureExecutionException

getScriptFilePath

protected String getScriptFilePath()

validateFunctionConfigurations

protected void validateFunctionConfigurations(Map<String,FunctionConfiguration> configMap)

writeFunctionJsonFiles

protected void writeFunctionJsonFiles(com.fasterxml.jackson.databind.ObjectWriter objectWriter,
                                      Map<String,FunctionConfiguration> configMap)
                               throws IOException

Throws:

IOException

writeFunctionJsonFile

protected void writeFunctionJsonFile(com.fasterxml.jackson.databind.ObjectWriter objectWriter,
                                     String functionName,
                                     FunctionConfiguration config)
                              throws IOException

Throws:

IOException

copyHostJson

protected void copyHostJson()
                     throws IOException

Throws:

IOException

copyLocalSettingsJson

protected void copyLocalSettingsJson()
                              throws IOException

Throws:

IOException

copyFilesWithDefaultContent

private static void copyFilesWithDefaultContent(File source,
                                                File dest,
                                                String defaultContent)
                                         throws IOException

Throws:

IOException

writeObjectToFile

protected void writeObjectToFile(com.fasterxml.jackson.databind.ObjectWriter objectWriter,
                                 Object object,
                                 File targetFile)
                          throws IOException

Throws:

IOException

getObjectWriter

protected com.fasterxml.jackson.databind.ObjectWriter getObjectWriter()

copyJarsToStageDirectory

protected void copyJarsToStageDirectory()
                                 throws IOException,
                                        org.apache.maven.plugin.MojoExecutionException

Throws:

IOException

org.apache.maven.plugin.MojoExecutionException

copyDependenciesToStagingDirectory

private void copyDependenciesToStagingDirectory(@Nonnull
                                                File stagingDirectory,
                                                @Nullable
                                                Set<File> dependencies)
                                         throws IOException

Throws:

IOException

copyArtifactToStagingDirectory

private void copyArtifactToStagingDirectory(@Nonnull
                                            File stagingDirectory,
                                            @Nullable
                                            Set<File> dependencies)
                                     throws IOException

Throws:

IOException

getResources

public List<DeploymentResource> getResources()

Overrides:

getResources in class AbstractAppServiceMojo

getFunctionCoreToolsHandler

protected FunctionCoreToolsHandler getFunctionCoreToolsHandler(CommandHandler commandHandler)

installExtension

protected void installExtension(FunctionCoreToolsHandler handler,
                                Set<BindingEnum> bindingEnums)
                         throws com.microsoft.azure.toolkit.lib.common.exception.AzureExecutionException

Throws:

com.microsoft.azure.toolkit.lib.common.exception.AzureExecutionException

getFunctionBindingEnums

protected Set<BindingEnum> getFunctionBindingEnums(Map<String,FunctionConfiguration> configMap)

isInstallingExtensionNeeded

protected boolean isInstallingExtensionNeeded(Set<BindingEnum> bindingTypes)

promptCompileInfo

protected void promptCompileInfo()

trackFunctionProperties

protected void trackFunctionProperties(Map<String,FunctionConfiguration> configMap)

copyFileToDirectory

private static void copyFileToDirectory(@Nonnull
                                        File srcFile,
                                        @Nonnull
                                        File destFile)