Package org.gradle.plugins.signing
Class SignOperation
java.lang.Object
org.gradle.plugins.signing.SignOperation
- All Implemented Interfaces:
SignatureSpec
A sign operation creates digital signatures for one or more files or
publish artifacts.
The external representation of the signature is specified by the signature type property, while the signatory property specifies who is to sign.
A sign
operation manages one or more Signature objects. The sign methods are used to register things to generate signatures for. The execute() method generates the signatures for
all of the registered items at that time.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionExecutes the given closure against this object.execute()Generates actual signature files for all of the registered signatures.All of the files that will be signed by this operation.The signatory that will be performing the signing.All of the signature files that will be generated by this operation.The registered signatures.The signature representation that will be created.Returns the single registered signature.booleanWhether or not it is required that this signature be generated.voidsetRequired(boolean required) Whether or not it is required that this signature be generated.voidsetSignatory(Signatory signatory) Sets the signatory that will be signing the input.voidsetSignatureType(SignatureType signatureType) Sets the signature representation that the signatures will be produced as.Registers signatures for the given files.Registers signatures (with the given classifier) for the given filessign(PublishArtifact... artifacts) Registers signatures for the given artifacts.Change the signatory for signature generation.signatureType(SignatureType type) Change the signature type for signature generation.protected abstract FileCollectiontoFileCollection(List<File> files) toString()
-
Constructor Details
-
SignOperation
public SignOperation()
-
-
Method Details
-
getDisplayName
-
toString
-
setSignatureType
Description copied from interface:SignatureSpecSets the signature representation that the signatures will be produced as.- Specified by:
setSignatureTypein interfaceSignatureSpec- Parameters:
signatureType- the signature type to use
-
getSignatureType
Description copied from interface:SignatureSpecThe signature representation that will be created.- Specified by:
getSignatureTypein interfaceSignatureSpec- Returns:
- the signature type, or
nullif none specified.
-
setSignatory
Description copied from interface:SignatureSpecSets the signatory that will be signing the input.- Specified by:
setSignatoryin interfaceSignatureSpec- Parameters:
signatory- The signatory
-
getSignatory
Description copied from interface:SignatureSpecThe signatory that will be performing the signing.- Specified by:
getSignatoryin interfaceSignatureSpec- Returns:
- the signatory, or
nullif none specified.
-
setRequired
public void setRequired(boolean required) Description copied from interface:SignatureSpecWhether or not it is required that this signature be generated.- Specified by:
setRequiredin interfaceSignatureSpec- Parameters:
required- Whether or not it is required that this signature be generated.- See Also:
-
isRequired
public boolean isRequired()Description copied from interface:SignatureSpecWhether or not it is required that this signature be generated. A signature may not be able to be generated if a signatory and/or a signature type have not been specified. If it is required and cannot be generated, an exception will be thrown. Otherwise, it will not be generated.- Specified by:
isRequiredin interfaceSignatureSpec- Returns:
- Whether or not it is required that this signature be generated.
-
sign
Registers signatures for the given artifacts.- Returns:
- this
- See Also:
-
sign
Registers signatures for the given files.- Returns:
- this
- See Also:
-
sign
Registers signatures (with the given classifier) for the given files- Returns:
- this
- See Also:
-
signatureType
Change the signature type for signature generation. -
signatory
Change the signatory for signature generation. -
configure
Executes the given closure against this object. -
execute
Generates actual signature files for all of the registered signatures.The signatures are generated with the configuration they have at this time, which includes the signature type and signatory of this operation at this time.
This method can be called multiple times, with the signatures being generated with their current configuration each time.
- Returns:
- this
- See Also:
-
getSignatures
The registered signatures. -
getSingleSignature
Returns the single registered signature.- Returns:
- The signature.
- Throws:
IllegalStateException- if there is not exactly one registered signature.
-
getFilesToSign
All of the files that will be signed by this operation. -
getSignatureFiles
All of the signature files that will be generated by this operation. -
toFileCollection
-