com.microsoft.azure.maven.function

Class AddMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.microsoft.azure.maven.AbstractAzureMojo

com.microsoft.azure.maven.AbstractAppServiceMojo

com.microsoft.azure.maven.function.AbstractFunctionMojo

com.microsoft.azure.maven.function.AddMojo

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

@Mojo(name="add")
public class AddMojo
extends AbstractFunctionMojo

Create new Azure Functions (as Java class) and add to current project.

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 File	basedir
protected List<String>	compileSourceRoots
static String	DEFAULT_INPUT_ERROR_MESSAGE
static String	FILE_EXIST
static String	FIND_TEMPLATE
static String	FIND_TEMPLATE_DONE
static String	FIND_TEMPLATE_FAIL
static String	FOUND_VALID_VALUE
private static String	FUNCTION_NAME_REGEXP
protected String	functionName Name of the new function.
protected String	functionPackageName Package name of the new function.
protected String	functionTemplate Template for the new function
static String	LOAD_BINDING_TEMPLATES_FAIL
static String	LOAD_TEMPLATES
static String	LOAD_TEMPLATES_DONE
static String	LOAD_TEMPLATES_FAIL
static String	PREPARE_PARAMS
static String	PROMPT_STRING_WITH_DEFAULTVALUE
static String	PROMPT_STRING_WITHOUT_DEFAULTVALUE
static String	SAVE_FILE
static String	SAVE_FILE_DONE

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

finalName, outputDirectory, pricingTier, region, skip

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
AddMojo()

Method Summary

Modifier and Type	Method and Description
protected void	assureInputFromUser(String prompt, String initValue, java.util.function.Function<String,Boolean> validator, String errorMessage, java.util.function.Consumer<String> setter)
protected void	assureInputFromUser(String prompt, String initValue, List<String> options, java.util.function.Consumer<String> setter)
protected void	assureInputInBatchMode(String input, java.util.function.Function<String,Boolean> validator, java.util.function.Consumer<String> setter, boolean required)
protected void	createPackageDirIfNotExist(File packageDir)
protected void	displayParameters(Map<String,String> params)
protected void	doExecute()
private String	findElementInOptions(List<String> options, String item)
protected FunctionTemplate	findTemplateByName(List<FunctionTemplate> templates, String templateName)
protected String	getBasedir()
String	getClassName()
String	getFunctionName()
String	getFunctionPackageName()
String	getFunctionTemplate()
protected FunctionTemplate	getFunctionTemplate(List<FunctionTemplate> templates)
private List<String>	getOptionsForUserPrompt(String promptName)
protected File	getPackageDir()
protected Scanner	getScanner()
protected String	getSourceRoot()
protected String	getStringInputErrorMessage(FunctionSettingTemplate template)
protected String	getStringInputFromUser(String attributeName, String initValue, FunctionSettingTemplate template)
protected String	getStringInputPromptString(String attributeName, String defaultValue)
protected java.util.function.Function<String,Boolean>	getStringInputValidator(FunctionSettingTemplate template)
protected File	getTargetFile(File packageDir)
protected List<String>	getTemplateNames(List<FunctionTemplate> templates)
protected List<FunctionTemplate>	loadAllFunctionTemplates()
protected BindingTemplate	loadBindingTemplate(String type)
protected List<FunctionTemplate>	parseTemplateJson(String templateJson)
protected void	prepareFunctionName()
protected void	preparePackageName()
protected Map<String,String>	prepareRequiredParameters(FunctionTemplate template, BindingTemplate bindingTemplate)
protected Map<String,String>	prepareTemplateParameters(FunctionTemplate template, BindingTemplate bindingTemplate, Map<String,String> params)
protected void	saveNewFunctionToFile(String newFunctionClass)
protected void	saveToTargetFile(File targetFile, String newFunctionClass)
protected void	setFunctionName(String functionName)
protected void	setFunctionPackageName(String functionPackageName)
protected void	setFunctionTemplate(String functionTemplate)
protected String	substituteParametersInTemplate(FunctionTemplate template, Map<String,String> params)

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

checkJavaVersion, execute, getFinalName, getFunctionApp, getPricingTier, getRegion, 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, 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

LOAD_TEMPLATES

public static final String LOAD_TEMPLATES

See Also:

Constant Field Values

LOAD_TEMPLATES_DONE

public static final String LOAD_TEMPLATES_DONE

See Also:

Constant Field Values

LOAD_TEMPLATES_FAIL

public static final String LOAD_TEMPLATES_FAIL

See Also:

Constant Field Values

FIND_TEMPLATE

public static final String FIND_TEMPLATE

See Also:

Constant Field Values

FIND_TEMPLATE_DONE

public static final String FIND_TEMPLATE_DONE

See Also:

Constant Field Values

FIND_TEMPLATE_FAIL

public static final String FIND_TEMPLATE_FAIL

See Also:

Constant Field Values

LOAD_BINDING_TEMPLATES_FAIL

public static final String LOAD_BINDING_TEMPLATES_FAIL

See Also:

Constant Field Values

PREPARE_PARAMS

public static final String PREPARE_PARAMS

See Also:

Constant Field Values

FOUND_VALID_VALUE

public static final String FOUND_VALID_VALUE

See Also:

Constant Field Values

SAVE_FILE

public static final String SAVE_FILE

See Also:

Constant Field Values

SAVE_FILE_DONE

public static final String SAVE_FILE_DONE

See Also:

Constant Field Values

FILE_EXIST

public static final String FILE_EXIST

See Also:

Constant Field Values

DEFAULT_INPUT_ERROR_MESSAGE

public static final String DEFAULT_INPUT_ERROR_MESSAGE

See Also:

Constant Field Values

PROMPT_STRING_WITH_DEFAULTVALUE

public static final String PROMPT_STRING_WITH_DEFAULTVALUE

See Also:

Constant Field Values

PROMPT_STRING_WITHOUT_DEFAULTVALUE

public static final String PROMPT_STRING_WITHOUT_DEFAULTVALUE

See Also:

Constant Field Values

FUNCTION_NAME_REGEXP

private static final String FUNCTION_NAME_REGEXP

See Also:

Constant Field Values

basedir

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

compileSourceRoots

@Parameter(defaultValue="${project.compileSourceRoots}",
           readonly=true,
           required=true)
protected List<String> compileSourceRoots

functionPackageName

@Parameter(property="functions.package")
protected String functionPackageName

Package name of the new function.

Since:

0.1.0

functionName

@Parameter(property="functions.name")
protected String functionName

Name of the new function.

Since:

0.1.0

functionTemplate

@Parameter(property="functions.template")
protected String functionTemplate

Template for the new function

Since:

0.1.0

Constructor Detail

AddMojo

public AddMojo()

Method Detail

getFunctionPackageName

public String getFunctionPackageName()

getFunctionName

public String getFunctionName()

getClassName

public String getClassName()

getFunctionTemplate

public String getFunctionTemplate()

getBasedir

protected String getBasedir()

getSourceRoot

protected String getSourceRoot()

setFunctionPackageName

protected void setFunctionPackageName(String functionPackageName)

setFunctionName

protected void setFunctionName(String functionName)

setFunctionTemplate

protected void setFunctionTemplate(String functionTemplate)

doExecute

protected void doExecute()
                  throws Exception

Specified by:

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

Throws:

Exception

loadBindingTemplate

protected BindingTemplate loadBindingTemplate(String type)

loadAllFunctionTemplates

protected List<FunctionTemplate> loadAllFunctionTemplates()
                                                   throws Exception

Throws:

Exception

parseTemplateJson

protected List<FunctionTemplate> parseTemplateJson(String templateJson)
                                            throws Exception

Throws:

Exception

getFunctionTemplate

protected FunctionTemplate getFunctionTemplate(List<FunctionTemplate> templates)
                                        throws Exception

Throws:

Exception

getTemplateNames

protected List<String> getTemplateNames(List<FunctionTemplate> templates)

findTemplateByName

protected FunctionTemplate findTemplateByName(List<FunctionTemplate> templates,
                                              String templateName)
                                       throws Exception

Throws:

Exception

prepareRequiredParameters

protected Map<String,String> prepareRequiredParameters(FunctionTemplate template,
                                                       BindingTemplate bindingTemplate)
                                                throws org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoFailureException

prepareFunctionName

protected void prepareFunctionName()
                            throws org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoFailureException

preparePackageName

protected void preparePackageName()
                           throws org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoFailureException

prepareTemplateParameters

protected Map<String,String> prepareTemplateParameters(FunctionTemplate template,
                                                       BindingTemplate bindingTemplate,
                                                       Map<String,String> params)
                                                throws org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoFailureException

getStringInputFromUser

protected String getStringInputFromUser(String attributeName,
                                        String initValue,
                                        FunctionSettingTemplate template)

getStringInputErrorMessage

protected String getStringInputErrorMessage(FunctionSettingTemplate template)

getStringInputPromptString

protected String getStringInputPromptString(String attributeName,
                                            String defaultValue)

getStringInputValidator

protected java.util.function.Function<String,Boolean> getStringInputValidator(FunctionSettingTemplate template)

displayParameters

protected void displayParameters(Map<String,String> params)

substituteParametersInTemplate

protected String substituteParametersInTemplate(FunctionTemplate template,
                                                Map<String,String> params)

saveNewFunctionToFile

protected void saveNewFunctionToFile(String newFunctionClass)
                              throws Exception

Throws:

Exception

getPackageDir

protected File getPackageDir()

getTargetFile

protected File getTargetFile(File packageDir)
                      throws Exception

Throws:

Exception

createPackageDirIfNotExist

protected void createPackageDirIfNotExist(File packageDir)

saveToTargetFile

protected void saveToTargetFile(File targetFile,
                                String newFunctionClass)
                         throws Exception

Throws:

Exception

assureInputFromUser

protected void assureInputFromUser(String prompt,
                                   String initValue,
                                   List<String> options,
                                   java.util.function.Consumer<String> setter)

assureInputFromUser

protected void assureInputFromUser(String prompt,
                                   String initValue,
                                   java.util.function.Function<String,Boolean> validator,
                                   String errorMessage,
                                   java.util.function.Consumer<String> setter)

assureInputInBatchMode

protected void assureInputInBatchMode(String input,
                                      java.util.function.Function<String,Boolean> validator,
                                      java.util.function.Consumer<String> setter,
                                      boolean required)
                               throws org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoFailureException

getScanner

protected Scanner getScanner()

findElementInOptions

@Nullable
private String findElementInOptions(List<String> options,
                                               String item)

getOptionsForUserPrompt

@Nullable
private List<String> getOptionsForUserPrompt(String promptName)