com.microsoft.azure.maven.function

Class AbstractFunctionMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.microsoft.azure.maven.AbstractAzureMojo

com.microsoft.azure.maven.AbstractAppServiceMojo

com.microsoft.azure.maven.function.AbstractFunctionMojo

All Implemented Interfaces:

com.microsoft.azure.maven.auth.AuthConfiguration, com.microsoft.azure.maven.telemetry.TelemetryConfiguration, org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

Direct Known Subclasses:

AddMojo, DeployMojo, ListMojo, PackageMojo, RunMojo

public abstract class AbstractFunctionMojo
extends com.microsoft.azure.maven.AbstractAppServiceMojo

Nested Class Summary

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

com.microsoft.azure.maven.AbstractAzureMojo.DefaultUncaughtExceptionHandler

Field Summary

Fields

Modifier and Type	Field and Description
protected String	finalName
private static String	JDK_VERSION_ERROR
protected File	outputDirectory
protected com.microsoft.azure.maven.appservice.PricingTierEnum	pricingTier App Service pricing tier, which will only be used to create Functions App at the first time. Below is the list of supported pricing tier: F1 D1 B1 B2 B3 S1 S2 S3 P1V2 P2V2 P3V2
protected String	region App Service region, which will only be used to create App Service at the first time.
protected boolean	skip Skip execution.

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

appName, appServicePlanName, appServicePlanResourceGroup, appSettings, deploymentType, MAVEN_PLUGIN_POSTFIX, resourceGroup

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

allowTelemetry, AUTH_TYPE, authentication, AZURE_INIT_FAIL, buildDirectory, failsOnError, FAILURE_REASON, httpProxyHost, httpProxyPort, INIT_FAILURE, INSTALLATION_ID_KEY, mavenResourcesFiltering, plugin, PLUGIN_NAME_KEY, PLUGIN_VERSION_KEY, project, session, SESSION_ID_KEY, settings, SUBSCRIPTION_ID_KEY, subscriptionId, TELEMETRY_NOT_ALLOWED

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractFunctionMojo()

Method Summary

Modifier and Type	Method and Description
void	checkJavaVersion()
void	execute()
String	getFinalName()
com.microsoft.azure.management.appservice.FunctionApp	getFunctionApp()
com.microsoft.azure.management.appservice.PricingTier	getPricingTier()
String	getRegion()
protected boolean	isSkipMojo()

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

getAppName, getAppServicePlanName, getAppServicePlanResourceGroup, getAppSettings, getDeploymentStagingDirectoryPath, getDeploymentType, getResourceGroup, getResources

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

debug, doExecute, error, getAuthenticationSetting, getAuthType, getAzureClient, getBuildDirectoryAbsolutePath, getHttpProxyHost, getHttpProxyPort, getInstallationId, getMavenResourcesFiltering, getPluginName, getPluginVersion, getProject, getSession, getSessionId, getSettings, getSubscriptionId, getTelemetryProperties, getTelemetryProxy, getUserAgent, handleException, info, infoWithMultipleLines, initTelemetry, isFailingOnError, isTelemetryAllowed, trackMojoFailure, trackMojoSkip, trackMojoStart, trackMojoSuccess, warning

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

Methods inherited from interface com.microsoft.azure.maven.auth.AuthConfiguration

getLog

Field Detail

JDK_VERSION_ERROR

private static final String JDK_VERSION_ERROR

See Also:

Constant Field Values

pricingTier

@Parameter(property="functions.pricingTier")
protected com.microsoft.azure.maven.appservice.PricingTierEnum pricingTier

App Service pricing tier, which will only be used to create Functions App at the first time.
Below is the list of supported pricing tier:

• F1
• D1
• B1
• B2
• B3
• S1
• S2
• S3
• P1V2
• P2V2
• P3V2

finalName

@Parameter(defaultValue="${project.build.finalName}",
           readonly=true,
           required=true)
protected String finalName

outputDirectory

@Parameter(defaultValue="${project.build.outputDirectory}",
           readonly=true,
           required=true)
protected File outputDirectory

skip

@Parameter(property="functions.skip",
           defaultValue="false")
protected boolean skip

Skip execution.

Since:

0.1.0

region

@Parameter(property="functions.region",
           defaultValue="westeurope")
protected String region

App Service region, which will only be used to create App Service at the first time.

Constructor Detail

AbstractFunctionMojo

public AbstractFunctionMojo()

Method Detail

getPricingTier

public com.microsoft.azure.management.appservice.PricingTier getPricingTier()
                                                                     throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

getRegion

public String getRegion()

isSkipMojo

protected boolean isSkipMojo()

Overrides:

isSkipMojo in class com.microsoft.azure.maven.AbstractAzureMojo

getFinalName

public String getFinalName()

getFunctionApp

@Nullable
public com.microsoft.azure.management.appservice.FunctionApp getFunctionApp()
                                                                                throws com.microsoft.azure.maven.auth.AzureAuthFailureException

Throws:

com.microsoft.azure.maven.auth.AzureAuthFailureException

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException

Specified by:

execute in interface org.apache.maven.plugin.Mojo

Overrides:

execute in class com.microsoft.azure.maven.AbstractAzureMojo

Throws:

org.apache.maven.plugin.MojoExecutionException

checkJavaVersion

public void checkJavaVersion()
                      throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException