Class CryptoDataFormat


  • @Metadata(firstVersion="2.3.0",
              label="dataformat,transformation,security",
              title="Crypto (Java Cryptographic Extension)")
    public class CryptoDataFormat
    extends DataFormatDefinition
    Encrypt and decrypt messages using Java Cryptography Extension (JCE).
    • Constructor Detail

      • CryptoDataFormat

        public CryptoDataFormat()
    • Method Detail

      • getAlgorithm

        public String getAlgorithm()
      • setAlgorithm

        public void setAlgorithm​(String algorithm)
        The JCE algorithm name indicating the cryptographic algorithm that will be used.
      • getCryptoProvider

        public String getCryptoProvider()
      • setCryptoProvider

        public void setCryptoProvider​(String cryptoProvider)
        The name of the JCE Security Provider that should be used.
      • getKeyRef

        public String getKeyRef()
      • setKeyRef

        public void setKeyRef​(String keyRef)
        Refers to the secret key to lookup from the register to use.
      • getInitVectorRef

        public String getInitVectorRef()
      • setInitVectorRef

        public void setInitVectorRef​(String initVectorRef)
        Refers to a byte array containing the Initialization Vector that will be used to initialize the Cipher.
      • getAlgorithmParameterRef

        public String getAlgorithmParameterRef()
      • setAlgorithmParameterRef

        public void setAlgorithmParameterRef​(String algorithmParameterRef)
        A JCE AlgorithmParameterSpec used to initialize the Cipher.

        Will lookup the type using the given name as a AlgorithmParameterSpec type.

      • getBufferSize

        public String getBufferSize()
      • setBufferSize

        public void setBufferSize​(String bufferSize)
        The size of the buffer used in the signature process.
      • getMacAlgorithm

        public String getMacAlgorithm()
      • setMacAlgorithm

        public void setMacAlgorithm​(String macAlgorithm)
        The JCE algorithm name indicating the Message Authentication algorithm.
      • getShouldAppendHMAC

        public String getShouldAppendHMAC()
      • setShouldAppendHMAC

        public void setShouldAppendHMAC​(String shouldAppendHMAC)
        Flag indicating that a Message Authentication Code should be calculated and appended to the encrypted data.
      • getInline

        public String getInline()
      • setInline

        public void setInline​(String inline)
        Flag indicating that the configured IV should be inlined into the encrypted data stream.

        Is by default false.