Package org.apache.maven.shared.jarsigner

Class AbstractJarSignerRequest

  • All Implemented Interfaces:
    JarSignerRequest, org.apache.maven.shared.utils.cli.javatool.JavaToolRequest
    Direct Known Subclasses:
    JarSignerSignRequest, JarSignerVerifyRequest
    public abstract class AbstractJarSignerRequest
extends org.apache.maven.shared.utils.cli.javatool.AbstractJavaToolRequest
implements JarSignerRequest
    Specifies the commons parameters used to control a jar signer invocation.
    Since:
    1.0

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getAlias()
      Gets the value of the alias field.
      java.io.File getArchive()
      Gets the value of the archive field.
      java.lang.String[] getArguments()
      Gets the value of the maxMemory field.
      java.lang.String getKeystore()
      Gets the value of the keystore field.
      java.lang.String getMaxMemory()
      Gets the value of the maxMemory field.
      java.lang.String getProviderArg()
      Gets the value of the providerArg field.
      java.lang.String getProviderClass()
      Gets the value of the providerClass field.
      java.lang.String getProviderName()
      Gets the value of the providerName field.
      java.lang.String getStorepass()
      Gets the value of the storepass field.
      java.lang.String getStoretype()
      Gets the value of the storetype field.
      java.io.File getWorkingDirectory()
      Gets the value of the workingDirectory field.
      boolean isProtectedAuthenticationPath()
      Gets the value of the command line tool parameter
      boolean isVerbose()
      Gets the value of the verbose field.
      void setAlias​(java.lang.String alias)
      Sets the new given value to the field alias of the request.
      void setArchive​(java.io.File archive)
      Sets the new given value to the field archive of the request.
      void setArguments​(java.lang.String... arguments)
      Sets the new given value to the field arguments of the request.
      void setKeystore​(java.lang.String keystore)
      Sets the new given value to the field keystore of the request.
      void setMaxMemory​(java.lang.String maxMemory)
      Sets the new given value to the field maxMemory of the request.
      void setProtectedAuthenticationPath​(boolean protect)
      Sets the value of the command line tool parameter
      void setProviderArg​(java.lang.String providerArg)
      Sets the new given value to the field providerArg of the request.
      void setProviderClass​(java.lang.String providerClass)
      Sets the new given value to the field providerClass of the request.
      void setProviderName​(java.lang.String providerName)
      Sets the new given value to the field providerName of the request.
      void setStorepass​(java.lang.String storepass)
      Sets the new given value to the field storepass of the request.
      void setStoretype​(java.lang.String storetype)
      Sets the new given value to the field storetype of the request.
      void setVerbose​(boolean verbose)
      Sets the new given value to the field verbose of the request.
      void setWorkingDirectory​(java.io.File workingDirectory)
      Sets the new given value to the field workingDirectory of the request.

      • Methods inherited from class org.apache.maven.shared.utils.cli.javatool.AbstractJavaToolRequest

        getSystemErrorStreamConsumer, getSystemOutStreamConsumer, setSystemErrorStreamConsumer, setSystemOutStreamConsumer

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

      • Methods inherited from interface org.apache.maven.shared.utils.cli.javatool.JavaToolRequest

        getSystemErrorStreamConsumer, getSystemOutStreamConsumer, setSystemErrorStreamConsumer, setSystemOutStreamConsumer

    • Field Detail

      • verbose

        private boolean verbose
        See options.

      • keystore

        private java.lang.String keystore
        See options.

      • storetype

        private java.lang.String storetype
        See options.

      • storepass

        private java.lang.String storepass
        See options.

      • alias

        private java.lang.String alias
        See options.

      • providerName

        private java.lang.String providerName
        See options.

      • providerClass

        private java.lang.String providerClass
        See options.

      • providerArg

        private java.lang.String providerArg
        See options.

      • maxMemory

        private java.lang.String maxMemory
        The maximum memory available to the JAR signer, e.g. 256M. See -Xmx for more details.

      • arguments

        private java.lang.String[] arguments
        List of additional arguments to append to the jarsigner command line.

      • workingDirectory

        private java.io.File workingDirectory
        Location of the working directory.

      • archive

        private java.io.File archive
        Archive to treat.

      • protectedAuthenticationPath

        protected boolean protectedAuthenticationPath
        See options.

    • Constructor Detail

      • AbstractJarSignerRequest

        public AbstractJarSignerRequest()

    • Method Detail

      • isVerbose

        public boolean isVerbose()
        Gets the value of the verbose field.
        Specified by:
        isVerbose in interface JarSignerRequest
        Returns:
        the value of the verbose field.

      • getKeystore

        public java.lang.String getKeystore()
        Gets the value of the keystore field.
        Specified by:
        getKeystore in interface JarSignerRequest
        Returns:
        the value of the keystore field.

      • getStoretype

        public java.lang.String getStoretype()
        Gets the value of the storetype field.
        Specified by:
        getStoretype in interface JarSignerRequest
        Returns:
        the value of the storetype field.

      • getStorepass

        public java.lang.String getStorepass()
        Gets the value of the storepass field.
        Specified by:
        getStorepass in interface JarSignerRequest
        Returns:
        the value of the storepass field.

      • getAlias

        public java.lang.String getAlias()
        Gets the value of the alias field.
        Specified by:
        getAlias in interface JarSignerRequest
        Returns:
        the value of the alias field.

      • getProviderName

        public java.lang.String getProviderName()
        Gets the value of the providerName field.
        Specified by:
        getProviderName in interface JarSignerRequest
        Returns:
        the value of the providerName field.

      • getProviderClass

        public java.lang.String getProviderClass()
        Gets the value of the providerClass field.
        Specified by:
        getProviderClass in interface JarSignerRequest
        Returns:
        the value of the providerClass field.

      • getProviderArg

        public java.lang.String getProviderArg()
        Gets the value of the providerArg field.
        Specified by:
        getProviderArg in interface JarSignerRequest
        Returns:
        the value of the providerArg field.

      • getMaxMemory

        public java.lang.String getMaxMemory()
        Gets the value of the maxMemory field.
        Specified by:
        getMaxMemory in interface JarSignerRequest
        Returns:
        the value of the maxMemory field.

      • getArguments

        public java.lang.String[] getArguments()
        Gets the value of the maxMemory field.
        Specified by:
        getArguments in interface JarSignerRequest
        Returns:
        the value of the maxMemory field.

      • getWorkingDirectory

        public java.io.File getWorkingDirectory()
        Gets the value of the workingDirectory field.
        Specified by:
        getWorkingDirectory in interface JarSignerRequest
        Returns:
        the value of the workingDirectory field.

      • getArchive

        public java.io.File getArchive()
        Gets the value of the archive field.

        The archive field is in fact the file on which the jarsigner request will be executed.

        Specified by:
        getArchive in interface JarSignerRequest
        Returns:
        the value of the archive field.

      • isProtectedAuthenticationPath

        public boolean isProtectedAuthenticationPath()
        Gets the value of the command line tool parameter 
        protected
        Specified by:
        isProtectedAuthenticationPath in interface JarSignerRequest
        Returns:
        true iff the password must be given via a protected authentication path such as a dedicated PIN reader

      • setVerbose

        public void setVerbose​(boolean verbose)
        Sets the new given value to the field verbose of the request.
        Specified by:
        setVerbose in interface JarSignerRequest
        Parameters:
        verbose - the new value of the field verbose.

      • setKeystore

        public void setKeystore​(java.lang.String keystore)
        Sets the new given value to the field keystore of the request.
        Specified by:
        setKeystore in interface JarSignerRequest
        Parameters:
        keystore - the new value of the field keystore.

      • setStoretype

        public void setStoretype​(java.lang.String storetype)
        Sets the new given value to the field storetype of the request.
        Specified by:
        setStoretype in interface JarSignerRequest
        Parameters:
        storetype - the new value of the field storetype.

      • setStorepass

        public void setStorepass​(java.lang.String storepass)
        Sets the new given value to the field storepass of the request.
        Specified by:
        setStorepass in interface JarSignerRequest
        Parameters:
        storepass - the new value of the field storepass.

      • setProviderName

        public void setProviderName​(java.lang.String providerName)
        Sets the new given value to the field providerName of the request.
        Specified by:
        setProviderName in interface JarSignerRequest
        Parameters:
        providerName - the new value of the field providerName.

      • setProviderClass

        public void setProviderClass​(java.lang.String providerClass)
        Sets the new given value to the field providerClass of the request.
        Specified by:
        setProviderClass in interface JarSignerRequest
        Parameters:
        providerClass - the new value of the field providerClass.

      • setProviderArg

        public void setProviderArg​(java.lang.String providerArg)
        Sets the new given value to the field providerArg of the request.
        Specified by:
        setProviderArg in interface JarSignerRequest
        Parameters:
        providerArg - the new value of the field providerArg.

      • setAlias

        public void setAlias​(java.lang.String alias)
        Sets the new given value to the field alias of the request.
        Specified by:
        setAlias in interface JarSignerRequest
        Parameters:
        alias - the new value of the field alias.

      • setMaxMemory

        public void setMaxMemory​(java.lang.String maxMemory)
        Sets the new given value to the field maxMemory of the request.
        Specified by:
        setMaxMemory in interface JarSignerRequest
        Parameters:
        maxMemory - the new value of the field maxMemory.

      • setArguments

        public void setArguments​(java.lang.String... arguments)
        Sets the new given value to the field arguments of the request.
        Specified by:
        setArguments in interface JarSignerRequest
        Parameters:
        arguments - the new value of the field arguments.

      • setWorkingDirectory

        public void setWorkingDirectory​(java.io.File workingDirectory)
        Sets the new given value to the field workingDirectory of the request.
        Specified by:
        setWorkingDirectory in interface JarSignerRequest
        Parameters:
        workingDirectory - the new value of the field workingDirectory.

      • setArchive

        public void setArchive​(java.io.File archive)
        Sets the new given value to the field archive of the request.
        Specified by:
        setArchive in interface JarSignerRequest
        Parameters:
        archive - the new value of the field archive.

      • setProtectedAuthenticationPath

        public void setProtectedAuthenticationPath​(boolean protect)
        Sets the value of the command line tool parameter 
        protected
        Specified by:
        setProtectedAuthenticationPath in interface JarSignerRequest
        Parameters:
        protect - iff the password must be given via a protected authentication path such as a dedicated PIN reader