com.zenjava.javafx.maven.plugin

Class GenerateKeyStoreMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.zenjava.javafx.maven.plugin.GenerateKeyStoreMojo

All Implemented Interfaces:

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

public class GenerateKeyStoreMojo
extends org.apache.maven.plugin.AbstractMojo

Generates a development keysstore that can be used for signing web based distribution bundles based on POM settings. You only need to run this command once and then you can include the resulting keystore in your source control. There is no harm in re-running the command however, it will simply overwrite the keystore with a new one. The resulting keystore is useful for simplifying development but should not be used in a production environment. You should get a legitimate certificate from a certifier and include that keystore in your codebase. Using this testing keystore will result in your users seeing the ugly warning about untrusted code.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	certCountry The 'country' code that your organisation is based in.
protected String	certDomain The 'domain' to use for the certificate.
protected String	certOrg The 'organisation' name to use for the certificate.
protected String	certOrgUnit The 'organisational unit' to use for the certificate.
protected String	certState The 'state' (province, etc) that your organisation is based in.
protected String	keyPassword The password to use when accessing the key within the keystore.
protected File	keyStore The location of the keystore.
protected String	keyStoreAlias The alias to use when accessing the keystore.
protected String	keyStorePassword The password to use when accessing the keystore.
protected boolean	overwriteKeyStore Set this to true to sliently overwrite the keystore.
protected org.apache.maven.plugin.BuildPluginManager	pluginManager The Maven PluginManager Object
protected org.apache.maven.project.MavenProject	project The Maven Project Object
protected org.apache.maven.execution.MavenSession	session The Maven Session Object

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

ROLE

Constructor Summary

Constructors

Constructor and Description
GenerateKeyStoreMojo()

Method Summary

Methods

Modifier and Type	Method and Description
void	execute()
protected void	generateKeyStore(File keyStore, String keyStoreAlias, String keyStorePassword, String keyPassword, String domainName)

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

project

protected org.apache.maven.project.MavenProject project

The Maven Project Object

session

protected org.apache.maven.execution.MavenSession session

The Maven Session Object

pluginManager

protected org.apache.maven.plugin.BuildPluginManager pluginManager

The Maven PluginManager Object

overwriteKeyStore

protected boolean overwriteKeyStore

Set this to true to sliently overwrite the keystore. If this is set to false (the default) then if a keystore already exists, this Mojo will fail with an error. This is just to stop you inadvertantly overwritting a keystore you really didn't want to lose.

keyStore

protected File keyStore

The location of the keystore. If not set, this will default to src/main/deploy/kesytore.jks which is usually fine to use for most cases.

keyStoreAlias

protected String keyStoreAlias

The alias to use when accessing the keystore. This will default to "myalias".

keyStorePassword

protected String keyStorePassword

The password to use when accessing the keystore. This will default to "password".

keyPassword

protected String keyPassword

The password to use when accessing the key within the keystore. If not set, this will default to keyStorePassword.

certDomain

protected String certDomain

The 'domain' to use for the certificate. Typically this is your company's domain name.

certOrgUnit

protected String certOrgUnit

The 'organisational unit' to use for the certificate. Your department or team name typically.

certOrg

protected String certOrg

The 'organisation' name to use for the certificate.

certState

protected String certState

The 'state' (province, etc) that your organisation is based in.

certCountry

protected String certCountry

The 'country' code that your organisation is based in. This should be a proper country code, e.g. Australia is 'AU'

Constructor Detail

GenerateKeyStoreMojo

public GenerateKeyStoreMojo()

Method Detail

execute

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

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

generateKeyStore

protected void generateKeyStore(File keyStore,
                    String keyStoreAlias,
                    String keyStorePassword,
                    String keyPassword,
                    String domainName)
                         throws org.apache.maven.plugin.MojoExecutionException,
                                org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException