Package org.apache.tools.ant.taskdefs
Class AbstractJarSignerTask
java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
org.apache.tools.ant.taskdefs.AbstractJarSignerTask
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected StringThe alias of signer.static final Stringerror string for unit test verification: "jar must be set through jar attribute or nested filesets"the filesets of the jars to signprotected FileThe name of the jar file.protected static final Stringname of JDK program we are looking forprotected Stringpassword for the key in the storeprotected StringThe url or path of keystore file.protected StringThe maximum amount of memory to use for Jar signerprotected Stringpassword for the storeprotected Stringtype of store,-storetype paramprotected booleanstrict checkingprotected booleanverbose outputFields inherited from class org.apache.tools.ant.ProjectComponent
description, location, project -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidAdds a nested <arg> element that can be used to specify command line arguments not supported via specific attributes.protected voidaddArgument(ExecTask cmd, Commandline.Argument arg) add an argument to a commandvoidaddFileset(FileSet set) Adds a set of files to signvoidAdd a system property.protected voidadd a value argument to a commandprotected voidinit processing logic; this is retained through our execution(s)protected voidbindToKeystore(ExecTask cmd) bind to a keystore if the attributes are thereprotected ExecTaskcreate the jarsigner executable taskAdds a path of files to sign.protected Pathclone our path and add all explicitly specified FileSets as well, patch in the jar attribute as a new fileset if it is defined.clone our filesets vector, and patch in the jar attribute as a new fileset, if is definedprotected voiddeclareSysProperty(ExecTask cmd, Environment.Variable property) protected voidany cleanup logicget the redirector.protected booleanHas either a path or a fileset been specified?voidthe alias to sign under; requiredprotected voidsetCommonOptions(ExecTask cmd) these are options common to signing and verifyingvoidsetExecutable(String executable) Sets the actual executable command to invoke, instead of the binaryjarsignerfound in Ant's JDK.voidthe jar file to sign; requiredvoidsetKeypass(String keypass) password for private key (if different); optionalvoidsetKeystore(String keystore) keystore location; requiredvoidsetMaxmemory(String max) Set the maximum memory to be used by the jarsigner processvoidsetProviderArg(String providerArg) Sets the value for the -providerArg command line argument.voidsetProviderClass(String providerClass) Sets the value for the -providerClass command line argument.voidsetProviderName(String providerName) Sets the value for the -providerName command line argument.voidsetStorepass(String storepass) password for keystore integrity; requiredvoidsetStoretype(String storetype) keystore type; optionalvoidsetStrict(boolean strict) do strict checkingvoidsetVerbose(boolean verbose) Enable verbose output when signing; optional: default falseMethods inherited from class org.apache.tools.ant.Task
bindToOwner, execute, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskTypeMethods inherited from class org.apache.tools.ant.ProjectComponent
clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
-
Field Details
-
ERROR_NO_SOURCE
error string for unit test verification: "jar must be set through jar attribute or nested filesets"- See Also:
-
JARSIGNER_COMMAND
-
jar
The name of the jar file. -
alias
The alias of signer. -
keystore
The url or path of keystore file. -
storepass
password for the store -
storetype
type of store,-storetype param -
keypass
password for the key in the store -
verbose
protected boolean verboseverbose output -
strict
protected boolean strictstrict checking- Since:
- Ant 1.9.1
-
maxMemory
The maximum amount of memory to use for Jar signer -
filesets
-
-
Constructor Details
-
AbstractJarSignerTask
public AbstractJarSignerTask()
-
-
Method Details
-
setMaxmemory
Set the maximum memory to be used by the jarsigner process- Parameters:
max- a string indicating the maximum memory according to the JVM conventions (e.g. 128m is 128 Megabytes)
-
setJar
-
setAlias
the alias to sign under; required- Parameters:
alias- the alias to sign under
-
setKeystore
keystore location; required- Parameters:
keystore- the keystore location
-
setStorepass
password for keystore integrity; required- Parameters:
storepass- the password for the keystore
-
setStoretype
keystore type; optional- Parameters:
storetype- the keystore type
-
setKeypass
password for private key (if different); optional- Parameters:
keypass- the password for the key (if different)
-
setVerbose
public void setVerbose(boolean verbose) Enable verbose output when signing; optional: default false- Parameters:
verbose- if true enable verbose output
-
setStrict
public void setStrict(boolean strict) do strict checking- Parameters:
strict- boolean- Since:
- Ant 1.9.1
-
addFileset
Adds a set of files to sign- Parameters:
set- a set of files to sign- Since:
- Ant 1.4
-
addSysproperty
Add a system property.- Parameters:
sysp- system property.
-
createPath
Adds a path of files to sign.- Returns:
- a path of files to sign.
- Since:
- Ant 1.7
-
setProviderName
Sets the value for the -providerName command line argument.- Parameters:
providerName- the value for the -providerName command line argument- Since:
- Ant 1.10.6
-
setProviderClass
Sets the value for the -providerClass command line argument.- Parameters:
providerClass- the value for the -providerClass command line argument- Since:
- Ant 1.10.6
-
setProviderArg
Sets the value for the -providerArg command line argument.- Parameters:
providerArg- the value for the -providerArg command line argument- Since:
- Ant 1.10.6
-
addArg
Adds a nested <arg> element that can be used to specify command line arguments not supported via specific attributes.- Parameters:
arg- the argument to add- Since:
- Ant 1.10.6
-
beginExecution
protected void beginExecution()init processing logic; this is retained through our execution(s) -
endExecution
protected void endExecution()any cleanup logic -
getRedirector
get the redirector. Non-null between invocations ofbeginExecution()andendExecution()- Returns:
- a redirector or null
-
setExecutable
Sets the actual executable command to invoke, instead of the binaryjarsignerfound in Ant's JDK.- Parameters:
executable- the command to invoke.- Since:
- Ant 1.8.0
-
setCommonOptions
these are options common to signing and verifying- Parameters:
cmd- command to configure
-
declareSysProperty
protected void declareSysProperty(ExecTask cmd, Environment.Variable property) throws BuildException - Parameters:
cmd- command to configureproperty- property to set- Throws:
BuildException- if the property is not correctly defined.
-
bindToKeystore
bind to a keystore if the attributes are there- Parameters:
cmd- command to configure
-
createJarSigner
create the jarsigner executable task- Returns:
- a task set up with the executable of jarsigner, failonerror=true and bound to our redirector
-
createUnifiedSources
-
createUnifiedSourcePath
clone our path and add all explicitly specified FileSets as well, patch in the jar attribute as a new fileset if it is defined.- Returns:
- a path that contains all files to sign
- Since:
- Ant 1.7
-
hasResources
protected boolean hasResources()Has either a path or a fileset been specified?- Returns:
- true if a path or fileset has been specified.
- Since:
- Ant 1.7
-
addValue
-
addArgument
add an argument to a command- Parameters:
cmd- command to manipulatearg- argument to add
-