com.microsoft.azure.maven

Class AbstractAppServiceMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.microsoft.azure.maven.AbstractAzureMojo

com.microsoft.azure.maven.AbstractAppServiceMojo

All Implemented Interfaces:

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

public abstract class AbstractAppServiceMojo
extends AbstractAzureMojo

Base abstract class for all Azure App Service Mojos.

Nested Class Summary

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

AbstractAzureMojo.DefaultUncaughtExceptionHandler

Field Summary

Fields

Modifier and Type	Field and Description
protected String	appName App Service name.
protected String	appServicePlanName App Service Plan name.
protected String	appServicePlanResourceGroup Resource group of App Service Plan.
protected Properties	appSettings Application settings of App Service, in the form of name-value pairs.
protected String	deploymentType Deployment type to deploy Web App or Function App.
protected static String	MAVEN_PLUGIN_POSTFIX
protected String	region App Service region, which will only be used to create App Service at the first time.
protected String	resourceGroup Resource group of App Service.

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

allowTelemetry, AUTH_TYPE, authentication, AZURE_INIT_FAIL, buildDirectory, failsOnError, FAILURE_REASON, 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
AbstractAppServiceMojo()

Method Summary

Modifier and Type	Method and Description
String	getAppName()
String	getAppServicePlanName()
String	getAppServicePlanResourceGroup()
Map	getAppSettings()
String	getDeploymentStagingDirectoryPath()
DeploymentType	getDeploymentType()
String	getRegion()
String	getResourceGroup()
List<org.apache.maven.model.Resource>	getResources()

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

debug, doExecute, error, execute, getAuthenticationSetting, getAuthType, getAzureClient, getBuildDirectoryAbsolutePath, getInstallationId, getMavenResourcesFiltering, getPluginName, getPluginVersion, getProject, getSession, getSessionId, getSettings, getSubscriptionId, getTelemetryProperties, getTelemetryProxy, getUserAgent, handleException, info, infoWithMultipleLines, initTelemetry, isFailingOnError, isSkipMojo, 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

MAVEN_PLUGIN_POSTFIX

protected static final String MAVEN_PLUGIN_POSTFIX

See Also:

Constant Field Values

resourceGroup

@Parameter(property="resourceGroup",
           required=true)
protected String resourceGroup

Resource group of App Service. It will be created if it doesn't exist.

appName

@Parameter(property="appName",
           required=true)
protected String appName

App Service name. It will be created if it doesn't exist.

deploymentType

@Parameter(property="deploymentType")
protected String deploymentType

Deployment type to deploy Web App or Function App. Supported values for Web App:

• FTP - <resources> specifies configurations for this kind of deployment.
• ZIP - <resources> specifies configurations for this kind of deployment.
• WAR - <warFile> and <path> specifies configurations for this kind of deployment.
• JAR - <jarFile> and <path> specifies configurations for this kind of deployment.
• AUTO - inspects <packaging> of the Maven project and uses WAR, JAR
• NONE - does nothing
• * defaults to AUTO if nothing is specified

Supported values for Function App:

• MSDEPLOY
• FTP
• ZIP
• * defaults to ZIP if nothing is specified

Since:

0.1.0

appServicePlanResourceGroup

@Parameter(property="appServicePlanResourceGroup")
protected String appServicePlanResourceGroup

Resource group of App Service Plan. It will be created if it doesn't exist.

appServicePlanName

@Parameter(property="appServicePlanName")
protected String appServicePlanName

App Service Plan name. It will be created if it doesn't exist.

region

@Parameter(property="region",
           defaultValue="westus")
protected String region

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

appSettings

@Parameter
protected Properties appSettings

Application settings of App Service, in the form of name-value pairs.

 
 <appSettings>
         <property>
                 <name>setting-name</name>
                 <value>setting-value</value>
         </property>
 </appSettings>
 
 

Constructor Detail

AbstractAppServiceMojo

public AbstractAppServiceMojo()

Method Detail

getResourceGroup

public String getResourceGroup()

getAppName

public String getAppName()

getAppServicePlanResourceGroup

public String getAppServicePlanResourceGroup()

getAppServicePlanName

public String getAppServicePlanName()

getRegion

public String getRegion()

getAppSettings

public Map getAppSettings()

getDeploymentType

public DeploymentType getDeploymentType()
                                 throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

getResources

public List<org.apache.maven.model.Resource> getResources()

getDeploymentStagingDirectoryPath

public String getDeploymentStagingDirectoryPath()