Package org.apache.tools.ant.taskdefs
Class GenerateKey
- java.lang.Object
- 
- org.apache.tools.ant.ProjectComponent
- 
- org.apache.tools.ant.Task
- 
- org.apache.tools.ant.taskdefs.GenerateKey
 
 
 
- 
- All Implemented Interfaces:
- java.lang.Cloneable
 
 public class GenerateKey extends Task Generates a key in a keystore.- Since:
- Ant 1.2
 
- 
- 
Nested Class SummaryNested Classes Modifier and Type Class Description static classGenerateKey.DistinguishedNameA class corresponding to the dname nested element.static classGenerateKey.DnameParamA DistinguishedName parameter.
 - 
Field SummaryFields Modifier and Type Field Description protected java.lang.StringaliasThe alias of signer.protected java.lang.Stringdnameprotected GenerateKey.DistinguishedNameexpandedDnameprotected java.lang.Stringkeyalgprotected java.lang.Stringkeypassprotected intkeysizeprotected java.lang.StringkeystoreThe name of keystore file.protected java.lang.Stringsanameprotected java.lang.Stringsigalgprotected java.lang.Stringstorepassprotected java.lang.Stringstoretypeprotected intvalidityprotected booleanverbose- 
Fields inherited from class org.apache.tools.ant.ProjectComponentdescription, location, project
 
- 
 - 
Constructor SummaryConstructors Constructor Description GenerateKey()
 - 
Method SummaryModifier and Type Method Description GenerateKey.DistinguishedNamecreateDname()Distinguished name list.voidexecute()Execute the task.voidsetAlias(java.lang.String alias)The alias to add under.voidsetDname(java.lang.String dname)The distinguished name for entity.voidsetKeyalg(java.lang.String keyalg)The method to use when generating name-value pair.voidsetKeypass(java.lang.String keypass)Password for private key (if different).voidsetKeysize(java.lang.String keysize)Indicates the size of key generated.voidsetKeystore(java.lang.String keystore)Keystore location.voidsetSaname(java.lang.String saname)The subject alternative name for entity.voidsetSigalg(java.lang.String sigalg)The algorithm to use in signing.voidsetStorepass(java.lang.String storepass)Password for keystore integrity.voidsetStoretype(java.lang.String storetype)Keystore type.voidsetValidity(java.lang.String validity)Indicates how many days certificate is valid.voidsetVerbose(boolean verbose)If true, verbose output when signing.- 
Methods inherited from class org.apache.tools.ant.TaskbindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
 - 
Methods inherited from class org.apache.tools.ant.ProjectComponentclone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
 
- 
 
- 
- 
- 
Field Detail- 
aliasprotected java.lang.String alias The alias of signer.
 - 
keystoreprotected java.lang.String keystore The name of keystore file.
 - 
storepassprotected java.lang.String storepass 
 - 
storetypeprotected java.lang.String storetype 
 - 
keypassprotected java.lang.String keypass 
 - 
sigalgprotected java.lang.String sigalg 
 - 
keyalgprotected java.lang.String keyalg 
 - 
sanameprotected java.lang.String saname 
 - 
dnameprotected java.lang.String dname 
 - 
expandedDnameprotected GenerateKey.DistinguishedName expandedDname 
 - 
keysizeprotected int keysize 
 - 
validityprotected int validity 
 - 
verboseprotected boolean verbose 
 
- 
 - 
Method Detail- 
createDnamepublic GenerateKey.DistinguishedName createDname() throws BuildException Distinguished name list.- Returns:
- Distinguished name container.
- Throws:
- BuildException- If specified more than once or dname attribute is used.
 
 - 
setDnamepublic void setDname(java.lang.String dname) The distinguished name for entity.- Parameters:
- dname- distinguished name
 
 - 
setSanamepublic void setSaname(java.lang.String saname) The subject alternative name for entity.- Parameters:
- saname- subject alternative name
- Since:
- Ant 1.9.14
 
 - 
setAliaspublic void setAlias(java.lang.String alias) The alias to add under.- Parameters:
- alias- alias to add under
 
 - 
setKeystorepublic void setKeystore(java.lang.String keystore) Keystore location.- Parameters:
- keystore- location
 
 - 
setStorepasspublic void setStorepass(java.lang.String storepass) Password for keystore integrity. Must be at least 6 characters long.- Parameters:
- storepass- password
 
 - 
setStoretypepublic void setStoretype(java.lang.String storetype) Keystore type.- Parameters:
- storetype- type
 
 - 
setKeypasspublic void setKeypass(java.lang.String keypass) Password for private key (if different).- Parameters:
- keypass- password
 
 - 
setSigalgpublic void setSigalg(java.lang.String sigalg) The algorithm to use in signing.- Parameters:
- sigalg- algorithm
 
 - 
setKeyalgpublic void setKeyalg(java.lang.String keyalg) The method to use when generating name-value pair.- Parameters:
- keyalg- algorithm
 
 - 
setKeysizepublic void setKeysize(java.lang.String keysize) throws BuildExceptionIndicates the size of key generated.- Parameters:
- keysize- size of key
- Throws:
- BuildException- If not an Integer
- To do:
- Could convert this to a plain Integer setter.
 
 - 
setValiditypublic void setValidity(java.lang.String validity) throws BuildExceptionIndicates how many days certificate is valid.- Parameters:
- validity- days valid
- Throws:
- BuildException- If not an Integer
 
 - 
setVerbosepublic void setVerbose(boolean verbose) If true, verbose output when signing.- Parameters:
- verbose- verbose or not
 
 - 
executepublic void execute() throws BuildExceptionExecute the task.- Overrides:
- executein class- Task
- Throws:
- BuildException- on error
 
 
- 
 
-