com.microsoft.azure.maven

Class AbstractAzureMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.microsoft.azure.maven.AbstractAzureMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractAppServiceMojo

public abstract class AbstractAzureMojo
extends org.apache.maven.plugin.AbstractMojo
implements TelemetryConfiguration, AuthConfiguration

Base abstract class for all Azure Mojos.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AbstractAzureMojo.DefaultUncaughtExceptionHandler

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	allowTelemetry Boolean flag to turn on/off telemetry within current Maven plugin.
static String	AUTH_TYPE
protected AuthenticationSetting	authentication Authentication setting for Azure Management API. Below are the supported sub-elements within <authentication>.
private com.microsoft.azure.management.Azure	azure
static String	AZURE_INIT_FAIL
private AzureAuthHelper	azureAuthHelper
protected File	buildDirectory
private static String	CONFIGURATION_PATH
protected boolean	failsOnError Boolean flag to control whether throwing exception from current Maven plugin when meeting any error. If set to true, the exception from current Maven plugin will fail the current Maven run.
static String	FAILURE_REASON
private static String	FIRST_RUN_KEY
static String	INIT_FAILURE
static String	INSTALLATION_ID_KEY
private String	installationId
protected org.apache.maven.shared.filtering.MavenResourcesFiltering	mavenResourcesFiltering
protected org.apache.maven.plugin.descriptor.PluginDescriptor	plugin
static String	PLUGIN_NAME_KEY
static String	PLUGIN_VERSION_KEY
private static String	PRIVACY_STATEMENT
protected org.apache.maven.project.MavenProject	project
protected org.apache.maven.execution.MavenSession	session
static String	SESSION_ID_KEY
private String	sessionId
protected org.apache.maven.settings.Settings	settings The system settings for Maven.
static String	SUBSCRIPTION_ID_KEY
protected String	subscriptionId Azure subscription Id.
static String	TELEMETRY_NOT_ALLOWED
private TelemetryProxy	telemetryProxy

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractAzureMojo()

Method Summary

Modifier and Type	Method and Description
void	debug(String message)
protected abstract void	doExecute() Entry point of sub-class.
void	error(String message)
void	execute()
AuthenticationSetting	getAuthenticationSetting()
String	getAuthType()
com.microsoft.azure.management.Azure	getAzureClient()
String	getBuildDirectoryAbsolutePath()
String	getInstallationId()
org.apache.maven.shared.filtering.MavenResourcesFiltering	getMavenResourcesFiltering()
String	getPluginName()
String	getPluginVersion()
org.apache.maven.project.MavenProject	getProject()
org.apache.maven.execution.MavenSession	getSession()
String	getSessionId()
org.apache.maven.settings.Settings	getSettings()
String	getSubscriptionId()
Map<String,String>	getTelemetryProperties()
TelemetryProxy	getTelemetryProxy()
String	getUserAgent()
protected void	handleException(Exception exception)
void	info(String message)
void	infoWithMultipleLines(String messages)
protected void	initTelemetry()
boolean	isFailingOnError()
private boolean	isFirstRun(Properties prop)
protected boolean	isSkipMojo() Sub-class can override this method to decide whether skip execution.
boolean	isTelemetryAllowed()
protected void	trackMojoFailure(String message)
protected void	trackMojoSkip()
protected void	trackMojoStart()
protected void	trackMojoSuccess()
private void	updateConfigurationFile(Properties prop)
void	warning(String message)

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

PLUGIN_NAME_KEY

public static final String PLUGIN_NAME_KEY

See Also:

Constant Field Values

PLUGIN_VERSION_KEY

public static final String PLUGIN_VERSION_KEY

See Also:

Constant Field Values

INSTALLATION_ID_KEY

public static final String INSTALLATION_ID_KEY

See Also:

Constant Field Values

SESSION_ID_KEY

public static final String SESSION_ID_KEY

See Also:

Constant Field Values

SUBSCRIPTION_ID_KEY

public static final String SUBSCRIPTION_ID_KEY

See Also:

Constant Field Values

AUTH_TYPE

public static final String AUTH_TYPE

See Also:

Constant Field Values

TELEMETRY_NOT_ALLOWED

public static final String TELEMETRY_NOT_ALLOWED

See Also:

Constant Field Values

INIT_FAILURE

public static final String INIT_FAILURE

See Also:

Constant Field Values

AZURE_INIT_FAIL

public static final String AZURE_INIT_FAIL

See Also:

Constant Field Values

FAILURE_REASON

public static final String FAILURE_REASON

See Also:

Constant Field Values

CONFIGURATION_PATH

private static final String CONFIGURATION_PATH

FIRST_RUN_KEY

private static final String FIRST_RUN_KEY

See Also:

Constant Field Values

PRIVACY_STATEMENT

private static final String PRIVACY_STATEMENT

See Also:

Constant Field Values

project

@Parameter(defaultValue="${project}",
           readonly=true,
           required=true)
protected org.apache.maven.project.MavenProject project

session

@Parameter(defaultValue="${session}",
           readonly=true,
           required=true)
protected org.apache.maven.execution.MavenSession session

buildDirectory

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

plugin

@Parameter(defaultValue="${plugin}",
           readonly=true,
           required=true)
protected org.apache.maven.plugin.descriptor.PluginDescriptor plugin

settings

@Parameter(defaultValue="${settings}",
           readonly=true,
           required=true)
protected org.apache.maven.settings.Settings settings

The system settings for Maven. This is the instance resulting from merging global and user-level settings files.

mavenResourcesFiltering

@Component(role=org.apache.maven.shared.filtering.MavenResourcesFiltering.class,
           hint="default")
protected org.apache.maven.shared.filtering.MavenResourcesFiltering mavenResourcesFiltering

authentication

@Parameter
protected AuthenticationSetting authentication

Authentication setting for Azure Management API.
Below are the supported sub-elements within <authentication>. You can use one of them to authenticate with azure
<serverId> specifies the credentials of your Azure service principal, by referencing a server definition in Maven's settings.xml
<file> specifies the absolute path of your authentication file for Azure.

Since:

0.1.0

subscriptionId

@Parameter
protected String subscriptionId

Azure subscription Id. You only need to specify it when:

• you are using authentication file
• there are more than one subscription in the authentication file

Since:

0.1.0

allowTelemetry

@Parameter(property="allowTelemetry",
           defaultValue="true")
protected boolean allowTelemetry

Boolean flag to turn on/off telemetry within current Maven plugin.

Since:

0.1.0

failsOnError

@Parameter(property="failsOnError",
           defaultValue="true")
protected boolean failsOnError

Boolean flag to control whether throwing exception from current Maven plugin when meeting any error.
If set to true, the exception from current Maven plugin will fail the current Maven run.

Since:

0.1.0

azureAuthHelper

private AzureAuthHelper azureAuthHelper

azure

private com.microsoft.azure.management.Azure azure

telemetryProxy

private TelemetryProxy telemetryProxy

sessionId

private String sessionId

installationId

private String installationId

Constructor Detail

AbstractAzureMojo

public AbstractAzureMojo()

Method Detail

getProject

public org.apache.maven.project.MavenProject getProject()

getSession

public org.apache.maven.execution.MavenSession getSession()

getBuildDirectoryAbsolutePath

public String getBuildDirectoryAbsolutePath()

getMavenResourcesFiltering

public org.apache.maven.shared.filtering.MavenResourcesFiltering getMavenResourcesFiltering()

getSettings

public org.apache.maven.settings.Settings getSettings()

Specified by:

getSettings in interface AuthConfiguration

getAuthenticationSetting

public AuthenticationSetting getAuthenticationSetting()

Specified by:

getAuthenticationSetting in interface AuthConfiguration

getSubscriptionId

public String getSubscriptionId()

Specified by:

getSubscriptionId in interface AuthConfiguration

isTelemetryAllowed

public boolean isTelemetryAllowed()

isFailingOnError

public boolean isFailingOnError()

getSessionId

public String getSessionId()

getInstallationId

public String getInstallationId()

getPluginName

public String getPluginName()

getPluginVersion

public String getPluginVersion()

getUserAgent

public String getUserAgent()

Specified by:

getUserAgent in interface AuthConfiguration

getAzureClient

public com.microsoft.azure.management.Azure getAzureClient()
                                                    throws AzureAuthFailureException

Throws:

AzureAuthFailureException

getTelemetryProxy

public TelemetryProxy getTelemetryProxy()

initTelemetry

protected void initTelemetry()

getTelemetryProperties

public Map<String,String> getTelemetryProperties()

Specified by:

getTelemetryProperties in interface TelemetryConfiguration

getAuthType

public String getAuthType()

execute

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

Specified by:

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

Throws:

org.apache.maven.plugin.MojoExecutionException

isSkipMojo

protected boolean isSkipMojo()

Sub-class can override this method to decide whether skip execution.

Returns:

Boolean to indicate whether skip execution.

doExecute

protected abstract void doExecute()
                           throws Exception

Entry point of sub-class. Sub-class should implement this method to do real work.

Throws:

Exception

trackMojoSkip

protected void trackMojoSkip()

trackMojoStart

protected void trackMojoStart()

trackMojoSuccess

protected void trackMojoSuccess()

trackMojoFailure

protected void trackMojoFailure(String message)

handleException

protected void handleException(Exception exception)
                        throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

isFirstRun

private boolean isFirstRun(Properties prop)

updateConfigurationFile

private void updateConfigurationFile(Properties prop)

debug

public void debug(String message)

info

public void info(String message)

infoWithMultipleLines

public void infoWithMultipleLines(String messages)

warning

public void warning(String message)

error

public void error(String message)