Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.EncryptContent/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.EncryptContent/index.html?rev=1775773&r1=1775772&r2=1775773&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.EncryptContent/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.EncryptContent/index.html Thu Dec 22 23:17:45 2016 @@ -1 +1 @@ -<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>EncryptContent</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Encrypts or Decrypts a FlowFile using either symmetric encryption with a password and randomly generated salt, or asymmetric encryption using a public and secret key.</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>encryption, decryption, password, JCE, OpenPGP, PGP, GPG</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property is considered "sensitive", meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the <strong>nifi.properties</strong> file has an entry for the property <strong>nifi.sensitive.props. key</strong>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Mode</strong></td><td id="default-value">Encrypt</td><td id="allowable-values"><ul><li>Encrypt</li><li>Decrypt</li></ul></td><td id="description">Specifies whether the content should be encrypted or decrypted</td></tr><tr><td id="name"><strong>Key Derivation Function</strong></td><td id="default-value">BCRYPT</td><td id="allowable-values"><ul><li>NiFi Legacy KDF <img src="../../html/images/iconInfo.png" alt="MD5 @ 1000 iterations" title="MD5 @ 1000 iterations"></img></li><li>OpenSSL EVP_BytesToKey <img src="../../html/images/iconInfo.png" alt="Single iteration MD5 compatible with PKCS#5 v1.5" title="Single iteration MD5 compatible with PKCS#5 v1.5"></img></li><li>Bcrypt <img src="../../html/images/iconInfo.png" alt="Bcrypt with configurable work factor. See Admin Guide" title="Bcrypt with configurable work factor. See Admin Guide" ></img></li><li>Scrypt <img src="../../html/images/iconInfo.png" alt="Scrypt >with configurable cost parameters. See Admin Guide" title="Scrypt with >configurable cost parameters. See Admin Guide"></img></li><li>PBKDF2 <img >src="../../html/images/iconInfo.png" alt="PBKDF2 with configurable hash >function and iteration count. See Admin Guide" title="PBKDF2 with >configurable hash function and iteration count. See Admin >Guide"></img></li><li>None <img src="../../html/images/iconInfo.png" alt="The >cipher is given a raw key conforming to the algorithm specifications" >title="The cipher is given a raw key conforming to the algorithm >specifications"></img></li></ul></td><td id="description">Specifies the key >derivation function to generate the key from the password (and >salt)</td></tr><tr><td id="name"><strong>Encryption >Algorithm</strong></td><td id="default-value">MD5_128AES</td><td >id="allowable-values"><ul><li>MD5_128AES <img >src="../../html/images/iconInfo.png" alt="org.apache.nifi.securi ty.util.EncryptionMethod@3db432c2[Algorithm name=PBEWITHMD5AND128BITAES-CBC-OPENSSL,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]" title="org.apache.nifi.security.util.EncryptionMethod@3db432c2[Algorithm name=PBEWITHMD5AND128BITAES-CBC-OPENSSL,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]"></img></li><li>MD5_192AES <img src="../../html/images/iconInfo.png" alt="EncryptionMethod[Algorithm name=PBEWITHMD5AND192BITAES-CBC-OPENSSL,Requires unlimited strength JCE policy=true,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]" title="EncryptionMethod[Algorithm name=PBEWITHMD5AND192BITAES-CBC-OPENSSL,Requires unlimited strength JCE policy=true,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]"></img></li><li>MD5_256AES <img src="../../html/images/iconInfo.png" alt="EncryptionMethod[Algorithm name=PBEWITHMD5AND256BITAES-CBC-OPENSSL,Requires unlimited strength JCE policy=true,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]" title="EncryptionMethod[Algorithm name=PBEWITHMD5AND256BITAES-CBC-OPENSSL,Requires unlimited strength JCE policy=true,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]"></img></li><li>MD5_DES <img src="../../html/images/iconInfo.png" alt="EncryptionMethod[Algorithm name=PBEWITHMD5ANDDES,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]" title="EncryptionMethod[Algorithm name=PBEWITHMD5ANDDES,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]"></img></li><li>MD5_RC2 <img src="../../html/images/iconInfo.png" alt="EncryptionMethod[Algorithm name=PBEWITHMD5ANDRC2,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Ke yed cipher=false]" title="EncryptionMethod[Algorithm name=PBEWITHMD5ANDRC2,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]"></img></li><li>SHA1_RC2 <img src="../../html/images/iconInfo.png" alt="EncryptionMethod[Algorithm name=PBEWITHSHA1ANDRC2,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]" title="EncryptionMethod[Algorithm name=PBEWITHSHA1ANDRC2,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]"></img></li><li>SHA1_DES <img src="../../html/images/iconInfo.png" alt="EncryptionMethod[Algorithm name=PBEWITHSHA1ANDDES,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]" title="EncryptionMethod[Algorithm name=PBEWITHSHA1ANDDES,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]"></img></li><li>SHA_128AES <img src="../../html/images/iconInfo.png" alt="EncryptionMethod[Algorithm name=PBEWITHSHAAND128BITAES-CBC-BC,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]" title="EncryptionMethod[Algorithm name=PBEWITHSHAAND128BITAES-CBC-BC,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]"></img></li><li>SHA_192AES <img src="../../html/images/iconInfo.png" alt="EncryptionMethod[Algorithm name=PBEWITHSHAAND192BITAES-CBC-BC,Requires unlimited strength JCE policy=true,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]" title="EncryptionMethod[Algorithm name=PBEWITHSHAAND192BITAES-CBC-BC,Requires unlimited strength JCE policy=true,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]"></img></li><li>SHA_256AES <img src="../../html/images/iconI nfo.png" alt="EncryptionMethod[Algorithm name=PBEWITHSHAAND256BITAES-CBC-BC,Requires unlimited strength JCE policy=true,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]" title="EncryptionMethod[Algorithm name=PBEWITHSHAAND256BITAES-CBC-BC,Requires unlimited strength JCE policy=true,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]"></img></li><li>SHA_40RC2 <img src="../../html/images/iconInfo.png" alt="EncryptionMethod[Algorithm name=PBEWITHSHAAND40BITRC2-CBC,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]" title="EncryptionMethod[Algorithm name=PBEWITHSHAAND40BITRC2-CBC,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]"></img></li><li>SHA_128RC2 <img src="../../html/images/iconInfo.png" alt="EncryptionMethod[Algorithm name=PBEWITHSHAAND128BITRC2-CBC,Requires unlimited strength JCE policy= false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]" title="EncryptionMethod[Algorithm name=PBEWITHSHAAND128BITRC2-CBC,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]"></img></li><li>SHA_40RC4 <img src="../../html/images/iconInfo.png" alt="EncryptionMethod[Algorithm name=PBEWITHSHAAND40BITRC4,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]" title="EncryptionMethod[Algorithm name=PBEWITHSHAAND40BITRC4,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]"></img></li><li>SHA_128RC4 <img src="../../html/images/iconInfo.png" alt="EncryptionMethod[Algorithm name=PBEWITHSHAAND128BITRC4,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]" title="EncryptionMethod[Algorithm name=PBEWIT HSHAAND128BITRC4,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]"></img></li><li>SHA256_128AES <img src="../../html/images/iconInfo.png" alt="EncryptionMethod[Algorithm name=PBEWITHSHA256AND128BITAES-CBC-BC,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]" title="EncryptionMethod[Algorithm name=PBEWITHSHA256AND128BITAES-CBC-BC,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]"></img></li><li>SHA256_192AES <img src="../../html/images/iconInfo.png" alt="EncryptionMethod[Algorithm name=PBEWITHSHA256AND192BITAES-CBC-BC,Requires unlimited strength JCE policy=true,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]" title="EncryptionMethod[Algorithm name=PBEWITHSHA256AND192BITAES-CBC-BC,Requires unlimited strength JCE policy=true,Algorithm Provider=BC,C ompatible with strong KDFs=false,Keyed cipher=false]"></img></li><li>SHA256_256AES <img src="../../html/images/iconInfo.png" alt="EncryptionMethod[Algorithm name=PBEWITHSHA256AND256BITAES-CBC-BC,Requires unlimited strength JCE policy=true,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]" title="EncryptionMethod[Algorithm name=PBEWITHSHA256AND256BITAES-CBC-BC,Requires unlimited strength JCE policy=true,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]"></img></li><li>SHA_2KEYTRIPLEDES <img src="../../html/images/iconInfo.png" alt="EncryptionMethod[Algorithm name=PBEWITHSHAAND2-KEYTRIPLEDES-CBC,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]" title="EncryptionMethod[Algorithm name=PBEWITHSHAAND2-KEYTRIPLEDES-CBC,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]"></img></li><li>SHA_3KEYTRIPLE DES <img src="../../html/images/iconInfo.png" alt="EncryptionMethod[Algorithm name=PBEWITHSHAAND3-KEYTRIPLEDES-CBC,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]" title="EncryptionMethod[Algorithm name=PBEWITHSHAAND3-KEYTRIPLEDES-CBC,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]"></img></li><li>SHA_TWOFISH <img src="../../html/images/iconInfo.png" alt="EncryptionMethod[Algorithm name=PBEWITHSHAANDTWOFISH-CBC,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]" title="EncryptionMethod[Algorithm name=PBEWITHSHAANDTWOFISH-CBC,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]"></img></li><li>PGP <img src="../../html/images/iconInfo.png" alt="EncryptionMethod[Algorithm name=PGP,Requires unlimited strengt h JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]" title="EncryptionMethod[Algorithm name=PGP,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]"></img></li><li>PGP_ASCII_ARMOR <img src="../../html/images/iconInfo.png" alt="EncryptionMethod[Algorithm name=PGP-ASCII-ARMOR,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]" title="EncryptionMethod[Algorithm name=PGP-ASCII-ARMOR,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]"></img></li><li>AES_CBC <img src="../../html/images/iconInfo.png" alt="EncryptionMethod[Algorithm name=AES/CBC/PKCS7Padding,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=true,Keyed cipher=true]" title="EncryptionMethod[Algorithm name=AES/CBC/PKCS7Padding,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=true,Keyed cipher=true]"></img></li><li>AES_CTR <img src="../../html/images/iconInfo.png" alt="EncryptionMethod[Algorithm name=AES/CTR/NoPadding,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=true,Keyed cipher=true]" title="EncryptionMethod[Algorithm name=AES/CTR/NoPadding,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=true,Keyed cipher=true]"></img></li><li>AES_GCM <img src="../../html/images/iconInfo.png" alt="EncryptionMethod[Algorithm name=AES/GCM/NoPadding,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=true,Keyed cipher=true]" title="EncryptionMethod[Algorithm name=AES/GCM/NoPadding,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=true,Keyed cipher=true]"></img></li></ul></td><td id="description">The Encry ption Algorithm to use</td></tr><tr><td id="name"><strong>Allow insecure cryptographic modes</strong></td><td id="default-value">not-allowed</td><td id="allowable-values"><ul><li>Allowed <img src="../../html/images/iconInfo.png" alt="Operation will not be blocked and no alerts will be presented when unsafe combinations of encryption algorithms and passwords are provided" title="Operation will not be blocked and no alerts will be presented when unsafe combinations of encryption algorithms and passwords are provided"></img></li><li>Not Allowed <img src="../../html/images/iconInfo.png" alt="When set, operation will be blocked and alerts will be presented to the user if unsafe combinations of encryption algorithms and passwords are provided on a JVM with limited strength crypto. To fix this, see the Admin Guide." title="When set, operation will be blocked and alerts will be presented to the user if unsafe combinations of encryption algorithms and passwords are provided on a JVM with lim ited strength crypto. To fix this, see the Admin Guide."></img></li></ul></td><td id="description">Overrides the default behavior to prevent unsafe combinations of encryption algorithms and short passwords on JVMs with limited strength cryptographic jurisdiction policies</td></tr><tr><td id="name">Password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The Password to use for encrypting or decrypting the data<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name">Raw Key (hexadecimal)</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">In keyed encryption, this is the raw key, encoded in hexadecimal<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name">Public Keyring File</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">In a PGP encrypt mode, this keyring contains the public key of the recipient</td></tr><tr><td id="name">Public Key User Id</td ><td id="default-value"></td><td id="allowable-values"></td><td >id="description">In a PGP encrypt mode, this user id of the >recipient</td></tr><tr><td id="name">Private Keyring File</td><td >id="default-value"></td><td id="allowable-values"></td><td >id="description">In a PGP decrypt mode, this keyring contains the private key >of the recipient</td></tr><tr><td id="name">Private Keyring >Passphrase</td><td id="default-value"></td><td id="allowable-values"></td><td >id="description">In a PGP decrypt mode, this is the private keyring >passphrase<br/><strong>Sensitive Property: >true</strong></td></tr></table><h3>Relationships: </h3><table >id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>Any > FlowFile that is successfully encrypted or decrypted will be routed to >success</td></tr><tr><td>failure</td><td>Any FlowFile that cannot be >encrypted or decrypted will be routed to failure</td></tr></table><h3>Reads >Attributes: </h3>None specified.<h3>Writes Attributes: </h3>None specified.<h3>State management: </h3>This processor has no state management.<h3>Restricted: </h3></body></html> \ No newline at end of file +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>EncryptContent</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Encrypts or Decrypts a FlowFile using either symmetric encryption with a password and randomly generated salt, or asymmetric encryption using a public and secret key.</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>encryption, decryption, password, JCE, OpenPGP, PGP, GPG</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property is considered "sensitive", meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the <strong>nifi.properties</strong> file has an entry for the property <strong>nifi.sensitive.props. key</strong>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Mode</strong></td><td id="default-value">Encrypt</td><td id="allowable-values"><ul><li>Encrypt</li><li>Decrypt</li></ul></td><td id="description">Specifies whether the content should be encrypted or decrypted</td></tr><tr><td id="name"><strong>Key Derivation Function</strong></td><td id="default-value">BCRYPT</td><td id="allowable-values"><ul><li>NiFi Legacy KDF <img src="../../html/images/iconInfo.png" alt="MD5 @ 1000 iterations" title="MD5 @ 1000 iterations"></img></li><li>OpenSSL EVP_BytesToKey <img src="../../html/images/iconInfo.png" alt="Single iteration MD5 compatible with PKCS#5 v1.5" title="Single iteration MD5 compatible with PKCS#5 v1.5"></img></li><li>Bcrypt <img src="../../html/images/iconInfo.png" alt="Bcrypt with configurable work factor. See Admin Guide" title="Bcrypt with configurable work factor. See Admin Guide" ></img></li><li>Scrypt <img src="../../html/images/iconInfo.png" alt="Scrypt >with configurable cost parameters. See Admin Guide" title="Scrypt with >configurable cost parameters. See Admin Guide"></img></li><li>PBKDF2 <img >src="../../html/images/iconInfo.png" alt="PBKDF2 with configurable hash >function and iteration count. See Admin Guide" title="PBKDF2 with >configurable hash function and iteration count. See Admin >Guide"></img></li><li>None <img src="../../html/images/iconInfo.png" alt="The >cipher is given a raw key conforming to the algorithm specifications" >title="The cipher is given a raw key conforming to the algorithm >specifications"></img></li></ul></td><td id="description">Specifies the key >derivation function to generate the key from the password (and >salt)</td></tr><tr><td id="name"><strong>Encryption >Algorithm</strong></td><td id="default-value">MD5_128AES</td><td >id="allowable-values"><ul><li>MD5_128AES <img >src="../../html/images/iconInfo.png" alt="org.apache.nifi.securi ty.util.EncryptionMethod@61ffd148[Algorithm name=PBEWITHMD5AND128BITAES-CBC-OPENSSL,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]" title="org.apache.nifi.security.util.EncryptionMethod@61ffd148[Algorithm name=PBEWITHMD5AND128BITAES-CBC-OPENSSL,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]"></img></li><li>MD5_192AES <img src="../../html/images/iconInfo.png" alt="EncryptionMethod[Algorithm name=PBEWITHMD5AND192BITAES-CBC-OPENSSL,Requires unlimited strength JCE policy=true,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]" title="EncryptionMethod[Algorithm name=PBEWITHMD5AND192BITAES-CBC-OPENSSL,Requires unlimited strength JCE policy=true,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]"></img></li><li>MD5_256AES <img src="../../html/images/iconInfo.png" alt="EncryptionMethod[Algorithm name=PBEWITHMD5AND256BITAES-CBC-OPENSSL,Requires unlimited strength JCE policy=true,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]" title="EncryptionMethod[Algorithm name=PBEWITHMD5AND256BITAES-CBC-OPENSSL,Requires unlimited strength JCE policy=true,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]"></img></li><li>MD5_DES <img src="../../html/images/iconInfo.png" alt="EncryptionMethod[Algorithm name=PBEWITHMD5ANDDES,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]" title="EncryptionMethod[Algorithm name=PBEWITHMD5ANDDES,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]"></img></li><li>MD5_RC2 <img src="../../html/images/iconInfo.png" alt="EncryptionMethod[Algorithm name=PBEWITHMD5ANDRC2,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Ke yed cipher=false]" title="EncryptionMethod[Algorithm name=PBEWITHMD5ANDRC2,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]"></img></li><li>SHA1_RC2 <img src="../../html/images/iconInfo.png" alt="EncryptionMethod[Algorithm name=PBEWITHSHA1ANDRC2,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]" title="EncryptionMethod[Algorithm name=PBEWITHSHA1ANDRC2,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]"></img></li><li>SHA1_DES <img src="../../html/images/iconInfo.png" alt="EncryptionMethod[Algorithm name=PBEWITHSHA1ANDDES,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]" title="EncryptionMethod[Algorithm name=PBEWITHSHA1ANDDES,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]"></img></li><li>SHA_128AES <img src="../../html/images/iconInfo.png" alt="EncryptionMethod[Algorithm name=PBEWITHSHAAND128BITAES-CBC-BC,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]" title="EncryptionMethod[Algorithm name=PBEWITHSHAAND128BITAES-CBC-BC,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]"></img></li><li>SHA_192AES <img src="../../html/images/iconInfo.png" alt="EncryptionMethod[Algorithm name=PBEWITHSHAAND192BITAES-CBC-BC,Requires unlimited strength JCE policy=true,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]" title="EncryptionMethod[Algorithm name=PBEWITHSHAAND192BITAES-CBC-BC,Requires unlimited strength JCE policy=true,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]"></img></li><li>SHA_256AES <img src="../../html/images/iconI nfo.png" alt="EncryptionMethod[Algorithm name=PBEWITHSHAAND256BITAES-CBC-BC,Requires unlimited strength JCE policy=true,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]" title="EncryptionMethod[Algorithm name=PBEWITHSHAAND256BITAES-CBC-BC,Requires unlimited strength JCE policy=true,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]"></img></li><li>SHA_40RC2 <img src="../../html/images/iconInfo.png" alt="EncryptionMethod[Algorithm name=PBEWITHSHAAND40BITRC2-CBC,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]" title="EncryptionMethod[Algorithm name=PBEWITHSHAAND40BITRC2-CBC,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]"></img></li><li>SHA_128RC2 <img src="../../html/images/iconInfo.png" alt="EncryptionMethod[Algorithm name=PBEWITHSHAAND128BITRC2-CBC,Requires unlimited strength JCE policy= false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]" title="EncryptionMethod[Algorithm name=PBEWITHSHAAND128BITRC2-CBC,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]"></img></li><li>SHA_40RC4 <img src="../../html/images/iconInfo.png" alt="EncryptionMethod[Algorithm name=PBEWITHSHAAND40BITRC4,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]" title="EncryptionMethod[Algorithm name=PBEWITHSHAAND40BITRC4,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]"></img></li><li>SHA_128RC4 <img src="../../html/images/iconInfo.png" alt="EncryptionMethod[Algorithm name=PBEWITHSHAAND128BITRC4,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]" title="EncryptionMethod[Algorithm name=PBEWIT HSHAAND128BITRC4,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]"></img></li><li>SHA256_128AES <img src="../../html/images/iconInfo.png" alt="EncryptionMethod[Algorithm name=PBEWITHSHA256AND128BITAES-CBC-BC,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]" title="EncryptionMethod[Algorithm name=PBEWITHSHA256AND128BITAES-CBC-BC,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]"></img></li><li>SHA256_192AES <img src="../../html/images/iconInfo.png" alt="EncryptionMethod[Algorithm name=PBEWITHSHA256AND192BITAES-CBC-BC,Requires unlimited strength JCE policy=true,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]" title="EncryptionMethod[Algorithm name=PBEWITHSHA256AND192BITAES-CBC-BC,Requires unlimited strength JCE policy=true,Algorithm Provider=BC,C ompatible with strong KDFs=false,Keyed cipher=false]"></img></li><li>SHA256_256AES <img src="../../html/images/iconInfo.png" alt="EncryptionMethod[Algorithm name=PBEWITHSHA256AND256BITAES-CBC-BC,Requires unlimited strength JCE policy=true,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]" title="EncryptionMethod[Algorithm name=PBEWITHSHA256AND256BITAES-CBC-BC,Requires unlimited strength JCE policy=true,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]"></img></li><li>SHA_2KEYTRIPLEDES <img src="../../html/images/iconInfo.png" alt="EncryptionMethod[Algorithm name=PBEWITHSHAAND2-KEYTRIPLEDES-CBC,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]" title="EncryptionMethod[Algorithm name=PBEWITHSHAAND2-KEYTRIPLEDES-CBC,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]"></img></li><li>SHA_3KEYTRIPLE DES <img src="../../html/images/iconInfo.png" alt="EncryptionMethod[Algorithm name=PBEWITHSHAAND3-KEYTRIPLEDES-CBC,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]" title="EncryptionMethod[Algorithm name=PBEWITHSHAAND3-KEYTRIPLEDES-CBC,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]"></img></li><li>SHA_TWOFISH <img src="../../html/images/iconInfo.png" alt="EncryptionMethod[Algorithm name=PBEWITHSHAANDTWOFISH-CBC,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]" title="EncryptionMethod[Algorithm name=PBEWITHSHAANDTWOFISH-CBC,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]"></img></li><li>PGP <img src="../../html/images/iconInfo.png" alt="EncryptionMethod[Algorithm name=PGP,Requires unlimited strengt h JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]" title="EncryptionMethod[Algorithm name=PGP,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]"></img></li><li>PGP_ASCII_ARMOR <img src="../../html/images/iconInfo.png" alt="EncryptionMethod[Algorithm name=PGP-ASCII-ARMOR,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]" title="EncryptionMethod[Algorithm name=PGP-ASCII-ARMOR,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]"></img></li><li>AES_CBC <img src="../../html/images/iconInfo.png" alt="EncryptionMethod[Algorithm name=AES/CBC/PKCS7Padding,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=true,Keyed cipher=true]" title="EncryptionMethod[Algorithm name=AES/CBC/PKCS7Padding,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=true,Keyed cipher=true]"></img></li><li>AES_CTR <img src="../../html/images/iconInfo.png" alt="EncryptionMethod[Algorithm name=AES/CTR/NoPadding,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=true,Keyed cipher=true]" title="EncryptionMethod[Algorithm name=AES/CTR/NoPadding,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=true,Keyed cipher=true]"></img></li><li>AES_GCM <img src="../../html/images/iconInfo.png" alt="EncryptionMethod[Algorithm name=AES/GCM/NoPadding,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=true,Keyed cipher=true]" title="EncryptionMethod[Algorithm name=AES/GCM/NoPadding,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=true,Keyed cipher=true]"></img></li></ul></td><td id="description">The Encry ption Algorithm to use</td></tr><tr><td id="name"><strong>Allow insecure cryptographic modes</strong></td><td id="default-value">not-allowed</td><td id="allowable-values"><ul><li>Allowed <img src="../../html/images/iconInfo.png" alt="Operation will not be blocked and no alerts will be presented when unsafe combinations of encryption algorithms and passwords are provided" title="Operation will not be blocked and no alerts will be presented when unsafe combinations of encryption algorithms and passwords are provided"></img></li><li>Not Allowed <img src="../../html/images/iconInfo.png" alt="When set, operation will be blocked and alerts will be presented to the user if unsafe combinations of encryption algorithms and passwords are provided on a JVM with limited strength crypto. To fix this, see the Admin Guide." title="When set, operation will be blocked and alerts will be presented to the user if unsafe combinations of encryption algorithms and passwords are provided on a JVM with lim ited strength crypto. To fix this, see the Admin Guide."></img></li></ul></td><td id="description">Overrides the default behavior to prevent unsafe combinations of encryption algorithms and short passwords on JVMs with limited strength cryptographic jurisdiction policies</td></tr><tr><td id="name">Password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The Password to use for encrypting or decrypting the data<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name">Raw Key (hexadecimal)</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">In keyed encryption, this is the raw key, encoded in hexadecimal<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name">Public Keyring File</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">In a PGP encrypt mode, this keyring contains the public key of the recipient</td></tr><tr><td id="name">Public Key User Id</td ><td id="default-value"></td><td id="allowable-values"></td><td >id="description">In a PGP encrypt mode, this user id of the >recipient</td></tr><tr><td id="name">Private Keyring File</td><td >id="default-value"></td><td id="allowable-values"></td><td >id="description">In a PGP decrypt mode, this keyring contains the private key >of the recipient</td></tr><tr><td id="name">Private Keyring >Passphrase</td><td id="default-value"></td><td id="allowable-values"></td><td >id="description">In a PGP decrypt mode, this is the private keyring >passphrase<br/><strong>Sensitive Property: >true</strong></td></tr></table><h3>Relationships: </h3><table >id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>Any > FlowFile that is successfully encrypted or decrypted will be routed to >success</td></tr><tr><td>failure</td><td>Any FlowFile that cannot be >encrypted or decrypted will be routed to failure</td></tr></table><h3>Reads >Attributes: </h3>None specified.<h3>Writes Attributes: </h3>None specified.<h3>State management: </h3>This processor has no state management.<h3>Restricted: </h3></body></html> \ No newline at end of file
Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.FetchFile/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.FetchFile/index.html?rev=1775773&r1=1775772&r2=1775773&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.FetchFile/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.FetchFile/index.html Thu Dec 22 23:17:45 2016 @@ -1 +1 @@ -<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>FetchFile</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Reads the contents of a file from disk and streams it into the contents of an incoming FlowFile. Once this is done, the file is optionally moved elsewhere or deleted to help keep the file system organized.</p><h3>Tags: </h3><p>local, files, filesystem, ingest, ingress, get, source, input, restricted</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the <a href="../../html/expression-language-guide.html">NiFi Expression Language</a>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>File to F etch</strong></td><td id="default-value">${absolute.path}/${filename}</td><td id="allowable-values"></td><td id="description">The fully-qualified filename of the file to fetch from the file system<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Completion Strategy</strong></td><td id="default-value">None</td><td id="allowable-values"><ul><li>None <img src="../../html/images/iconInfo.png" alt="Leave the file as-is" title="Leave the file as-is"></img></li><li>Move File <img src="../../html/images/iconInfo.png" alt="Moves the file to the directory specified by the <Move Destination Directory> property" title="Moves the file to the directory specified by the <Move Destination Directory> property"></img></li><li>Delete File <img src="../../html/images/iconInfo.png" alt="Deletes the original file from the file system" title="Deletes the original file from the file system"></img></li></ul></td><td id="description">Specifies what to do with the original file on the file system once it has been pulled into NiFi</td></tr><tr><td id="name">Move Destination Directory</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The directory to the move the original file to once it has been fetched from the file system. This property is ignored unless the Completion Strategy is set to "Move File". If the directory does not exist, it will be created.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Move Conflict Strategy</strong></td><td id="default-value">Rename</td><td id="allowable-values"><ul><li>Rename <img src="../../html/images/iconInfo.png" alt="The existing destination file should remain intact. The newly ingested file should be moved to the destination directory but be renamed to a random filename" title="The existing destination file should remain intact. The newly ingested file should be moved to the destination directory but be renamed to a ra ndom filename"></img></li><li>Replace File <img src="../../html/images/iconInfo.png" alt="The newly ingested file should replace the existing file in the Destination Directory" title="The newly ingested file should replace the existing file in the Destination Directory"></img></li><li>Keep Existing <img src="../../html/images/iconInfo.png" alt="The existing file should in the Destination Directory should stay intact and the newly ingested file should be deleted" title="The existing file should in the Destination Directory should stay intact and the newly ingested file should be deleted"></img></li><li>Fail <img src="../../html/images/iconInfo.png" alt="The existing destination file should remain intact and the incoming FlowFile should be routed to failure" title="The existing destination file should remain intact and the incoming FlowFile should be routed to failure"></img></li></ul></td><td id="description">If Completion Strategy is set to Move File and a file already exists in the destination directory with the same name, this property specifies how that naming conflict should be resolved</td></tr><tr><td id="name"><strong>Log level when file not found</strong></td><td id="default-value">ERROR</td><td id="allowable-values"><ul><li>TRACE</li><li>DEBUG</li><li>INFO</li><li>WARN</li><li>ERROR</li><li>FATAL</li></ul></td><td id="description">Log level to use in case the file does not exist when the processor is triggered</td></tr><tr><td id="name"><strong>Log level when permission denied</strong></td><td id="default-value">ERROR</td><td id="allowable-values"><ul><li>TRACE</li><li>DEBUG</li><li>INFO</li><li>WARN</li><li>ERROR</li><li>FATAL</li></ul></td><td id="description">Log level to use in case user jwitt does not have sufficient permissions to read the file</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>Any FlowFile that is successfully fetched from the file system will be transferred to this Relationship.</td></tr><tr><td>not.found</td><td>Any FlowFile that could not be fetched from the file system because the file could not be found will be transferred to this Relationship.</td></tr><tr><td>permission.denied</td><td>Any FlowFile that could not be fetched from the file system due to the user running NiFi not having sufficient permissions will be transferred to this Relationship.</td></tr><tr><td>failure</td><td>Any FlowFile that could not be fetched from the file system for any reason other than insufficient permissions or the file not existing will be transferred to this Relationship.</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3>None specified.<h3>State management: </h3>This processor has no state management.<h3>Restricted: </h3><td>Provides operator the ability to read from and delete any file that NiFi has access to.</td><h3>See Also:</h3><p><a href="../org.apache.nifi.processors.standard.GetFile/index.htm l">GetFile</a>, <a href="../org.apache.nifi.processors.standard.PutFile/index.html">PutFile</a>, <a href="../org.apache.nifi.processors.standard.ListFile/index.html">ListFile</a></p></body></html> \ No newline at end of file +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>FetchFile</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Reads the contents of a file from disk and streams it into the contents of an incoming FlowFile. Once this is done, the file is optionally moved elsewhere or deleted to help keep the file system organized.</p><h3>Tags: </h3><p>local, files, filesystem, ingest, ingress, get, source, input, restricted</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the <a href="../../html/expression-language-guide.html">NiFi Expression Language</a>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>File to F etch</strong></td><td id="default-value">${absolute.path}/${filename}</td><td id="allowable-values"></td><td id="description">The fully-qualified filename of the file to fetch from the file system<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Completion Strategy</strong></td><td id="default-value">None</td><td id="allowable-values"><ul><li>None <img src="../../html/images/iconInfo.png" alt="Leave the file as-is" title="Leave the file as-is"></img></li><li>Move File <img src="../../html/images/iconInfo.png" alt="Moves the file to the directory specified by the <Move Destination Directory> property" title="Moves the file to the directory specified by the <Move Destination Directory> property"></img></li><li>Delete File <img src="../../html/images/iconInfo.png" alt="Deletes the original file from the file system" title="Deletes the original file from the file system"></img></li></ul></td><td id="description">Specifies what to do with the original file on the file system once it has been pulled into NiFi</td></tr><tr><td id="name">Move Destination Directory</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The directory to the move the original file to once it has been fetched from the file system. This property is ignored unless the Completion Strategy is set to "Move File". If the directory does not exist, it will be created.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Move Conflict Strategy</strong></td><td id="default-value">Rename</td><td id="allowable-values"><ul><li>Rename <img src="../../html/images/iconInfo.png" alt="The existing destination file should remain intact. The newly ingested file should be moved to the destination directory but be renamed to a random filename" title="The existing destination file should remain intact. The newly ingested file should be moved to the destination directory but be renamed to a ra ndom filename"></img></li><li>Replace File <img src="../../html/images/iconInfo.png" alt="The newly ingested file should replace the existing file in the Destination Directory" title="The newly ingested file should replace the existing file in the Destination Directory"></img></li><li>Keep Existing <img src="../../html/images/iconInfo.png" alt="The existing file should in the Destination Directory should stay intact and the newly ingested file should be deleted" title="The existing file should in the Destination Directory should stay intact and the newly ingested file should be deleted"></img></li><li>Fail <img src="../../html/images/iconInfo.png" alt="The existing destination file should remain intact and the incoming FlowFile should be routed to failure" title="The existing destination file should remain intact and the incoming FlowFile should be routed to failure"></img></li></ul></td><td id="description">If Completion Strategy is set to Move File and a file already exists in the destination directory with the same name, this property specifies how that naming conflict should be resolved</td></tr><tr><td id="name"><strong>Log level when file not found</strong></td><td id="default-value">ERROR</td><td id="allowable-values"><ul><li>TRACE</li><li>DEBUG</li><li>INFO</li><li>WARN</li><li>ERROR</li><li>FATAL</li></ul></td><td id="description">Log level to use in case the file does not exist when the processor is triggered</td></tr><tr><td id="name"><strong>Log level when permission denied</strong></td><td id="default-value">ERROR</td><td id="allowable-values"><ul><li>TRACE</li><li>DEBUG</li><li>INFO</li><li>WARN</li><li>ERROR</li><li>FATAL</li></ul></td><td id="description">Log level to use in case user jpercivall does not have sufficient permissions to read the file</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>Any FlowFile that is successfully fetched from the file system wil l be transferred to this Relationship.</td></tr><tr><td>not.found</td><td>Any FlowFile that could not be fetched from the file system because the file could not be found will be transferred to this Relationship.</td></tr><tr><td>permission.denied</td><td>Any FlowFile that could not be fetched from the file system due to the user running NiFi not having sufficient permissions will be transferred to this Relationship.</td></tr><tr><td>failure</td><td>Any FlowFile that could not be fetched from the file system for any reason other than insufficient permissions or the file not existing will be transferred to this Relationship.</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3>None specified.<h3>State management: </h3>This processor has no state management.<h3>Restricted: </h3><td>Provides operator the ability to read from and delete any file that NiFi has access to.</td><h3>See Also:</h3><p><a href="../org.apache.nifi.processors.standard.GetFile/inde x.html">GetFile</a>, <a href="../org.apache.nifi.processors.standard.PutFile/index.html">PutFile</a>, <a href="../org.apache.nifi.processors.standard.ListFile/index.html">ListFile</a></p></body></html> \ No newline at end of file Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.PostHTTP/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.PostHTTP/index.html?rev=1775773&r1=1775772&r2=1775773&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.PostHTTP/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.PostHTTP/index.html Thu Dec 22 23:17:45 2016 @@ -1 +1 @@ -<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PostHTTP</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Performs an HTTP Post with the content of the FlowFile</p><h3>Tags: </h3><p>http, https, remote, copy, archive</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, whether a property supports the <a href="../../html/expression-language-guide.html">NiFi Expression Language</a>, and whether a property is considered "sensitive", meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the <strong>nifi.properties</strong> file has an entry for the property <strong>nifi.sensitive.props.key</strong>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowabl e Values</th><th>Description</th></tr><tr><td id="name"><strong>URL</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The URL to POST to. The first part of the URL must be static. However, the path of the URL may be defined using the Attribute Expression Language. For example, https://${hostname} is not valid, but https://1.1.1.1:8080/files/${nf.file.name} is valid.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Max Batch Size</td><td id="default-value">100 MB</td><td id="allowable-values"></td><td id="description">If the Send as FlowFile property is true, specifies the max data size for a batch of FlowFiles to send in a single HTTP POST. If not specified, each FlowFile will be sent separately. If the Send as FlowFile property is false, this property is ignored</td></tr><tr><td id="name">Max Data to Post per Second</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The max imum amount of data to send per second; this allows the bandwidth to be throttled to a specified data rate; if not specified, the data rate is not throttled</td></tr><tr><td id="name">SSL Context Service</td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>SSLContextService<br/><strong>Implementation:</strong><br/><a href="../org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a></td><td id="description">The Controller Service to use in order to obtain an SSL Context</td></tr><tr><td id="name">Username</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Username required to access the URL</td></tr><tr><td id="name">Password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Password required to access the URL<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name"><strong>Send as FlowFile</strong></td><td id="default-va lue">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">If true, will package the FlowFile's contents and attributes together and send the FlowFile Package; otherwise, will send only the FlowFile's content</td></tr><tr><td id="name">Use Chunked Encoding</td><td id="default-value"></td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Specifies whether or not to use Chunked Encoding to send the data. This property is ignored in the event the contents are compressed or sent as FlowFiles.</td></tr><tr><td id="name"><strong>Compression Level</strong></td><td id="default-value">0</td><td id="allowable-values"></td><td id="description">Determines the GZIP Compression Level to use when sending the file; the value must be in the range of 0-9. A value of 0 indicates that the file will not be GZIP'ed</td></tr><tr><td id="name"><strong>Connection Timeout</strong></td><td id="default-value">30 sec</td><td id="a llowable-values"></td><td id="description">How long to wait when attempting to connect to the remote server before giving up</td></tr><tr><td id="name"><strong>Data Timeout</strong></td><td id="default-value">30 sec</td><td id="allowable-values"></td><td id="description">How long to wait between receiving segments of data from the remote server before giving up and discarding the partial file</td></tr><tr><td id="name">Attributes to Send as HTTP Headers (Regex)</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Specifies the Regular Expression that determines the names of FlowFile attributes that should be sent as HTTP Headers</td></tr><tr><td id="name">User Agent</td><td id="default-value">Apache-HttpClient/4.4.1 (Java/1.8.0_66)</td><td id="allowable-values"></td><td id="description">What to report as the User Agent when we connect to the remote server</td></tr><tr><td id="name">Proxy Host</td><td id="default-value"></td><td id="allowable-values"></ td><td id="description">The fully qualified hostname or IP address of the proxy server</td></tr><tr><td id="name">Proxy Port</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The port of the proxy server</td></tr><tr><td id="name"><strong>Content-Type</strong></td><td id="default-value">${mime.type}</td><td id="allowable-values"></td><td id="description">The Content-Type to specify for the content of the FlowFile being POSTed if Send as FlowFile is false. In the case of an empty value after evaluating an expression language expression, Content-Type defaults to application/octet-stream<br/><strong>Supports Expression Language: true</strong></td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>Files that are successfully send will be transferred to success</td></tr><tr><td>failure</td><td>Files that fail to send will transferred to failure</td></tr></table><h3>Reads Attrib utes: </h3>None specified.<h3>Writes Attributes: </h3>None specified.<h3>State management: </h3>This processor has no state management.<h3>Restricted: </h3></body></html> \ No newline at end of file +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PostHTTP</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Performs an HTTP Post with the content of the FlowFile</p><h3>Tags: </h3><p>http, https, remote, copy, archive</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, whether a property supports the <a href="../../html/expression-language-guide.html">NiFi Expression Language</a>, and whether a property is considered "sensitive", meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the <strong>nifi.properties</strong> file has an entry for the property <strong>nifi.sensitive.props.key</strong>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowabl e Values</th><th>Description</th></tr><tr><td id="name"><strong>URL</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The URL to POST to. The first part of the URL must be static. However, the path of the URL may be defined using the Attribute Expression Language. For example, https://${hostname} is not valid, but https://1.1.1.1:8080/files/${nf.file.name} is valid.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Max Batch Size</td><td id="default-value">100 MB</td><td id="allowable-values"></td><td id="description">If the Send as FlowFile property is true, specifies the max data size for a batch of FlowFiles to send in a single HTTP POST. If not specified, each FlowFile will be sent separately. If the Send as FlowFile property is false, this property is ignored</td></tr><tr><td id="name">Max Data to Post per Second</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The max imum amount of data to send per second; this allows the bandwidth to be throttled to a specified data rate; if not specified, the data rate is not throttled</td></tr><tr><td id="name">SSL Context Service</td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>SSLContextService<br/><strong>Implementation:</strong><br/><a href="../org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a></td><td id="description">The Controller Service to use in order to obtain an SSL Context</td></tr><tr><td id="name">Username</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Username required to access the URL</td></tr><tr><td id="name">Password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Password required to access the URL<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name"><strong>Send as FlowFile</strong></td><td id="default-va lue">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">If true, will package the FlowFile's contents and attributes together and send the FlowFile Package; otherwise, will send only the FlowFile's content</td></tr><tr><td id="name">Use Chunked Encoding</td><td id="default-value"></td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Specifies whether or not to use Chunked Encoding to send the data. This property is ignored in the event the contents are compressed or sent as FlowFiles.</td></tr><tr><td id="name"><strong>Compression Level</strong></td><td id="default-value">0</td><td id="allowable-values"></td><td id="description">Determines the GZIP Compression Level to use when sending the file; the value must be in the range of 0-9. A value of 0 indicates that the file will not be GZIP'ed</td></tr><tr><td id="name"><strong>Connection Timeout</strong></td><td id="default-value">30 sec</td><td id="a llowable-values"></td><td id="description">How long to wait when attempting to connect to the remote server before giving up</td></tr><tr><td id="name"><strong>Data Timeout</strong></td><td id="default-value">30 sec</td><td id="allowable-values"></td><td id="description">How long to wait between receiving segments of data from the remote server before giving up and discarding the partial file</td></tr><tr><td id="name">Attributes to Send as HTTP Headers (Regex)</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Specifies the Regular Expression that determines the names of FlowFile attributes that should be sent as HTTP Headers</td></tr><tr><td id="name">User Agent</td><td id="default-value">Apache-HttpClient/4.4.1 (Java/1.8.0_74)</td><td id="allowable-values"></td><td id="description">What to report as the User Agent when we connect to the remote server</td></tr><tr><td id="name">Proxy Host</td><td id="default-value"></td><td id="allowable-values"></ td><td id="description">The fully qualified hostname or IP address of the proxy server</td></tr><tr><td id="name">Proxy Port</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The port of the proxy server</td></tr><tr><td id="name"><strong>Content-Type</strong></td><td id="default-value">${mime.type}</td><td id="allowable-values"></td><td id="description">The Content-Type to specify for the content of the FlowFile being POSTed if Send as FlowFile is false. In the case of an empty value after evaluating an expression language expression, Content-Type defaults to application/octet-stream<br/><strong>Supports Expression Language: true</strong></td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>Files that are successfully send will be transferred to success</td></tr><tr><td>failure</td><td>Files that fail to send will transferred to failure</td></tr></table><h3>Reads Attrib utes: </h3>None specified.<h3>Writes Attributes: </h3>None specified.<h3>State management: </h3>This processor has no state management.<h3>Restricted: </h3></body></html> \ No newline at end of file
