/usr/share/doc/libbcpg-java/api/org/bouncycastle/openpgp/PGPEncryptedDataGenerator.html is in libbcpg-java-doc 1.59-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html>
<head>
<title>PGPEncryptedDataGenerator (Bouncy Castle Library 1.59 API Specification)</title>
<meta name="date" content="2018-01-16">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="PGPEncryptedDataGenerator (Bouncy Castle Library 1.59 API Specification)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><b>Bouncy Castle Cryptography Library 1.59</b></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../org/bouncycastle/openpgp/PGPEncryptedData.TruncatedStream.html" title="class in org.bouncycastle.openpgp"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../org/bouncycastle/openpgp/PGPEncryptedDataList.html" title="class in org.bouncycastle.openpgp"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/bouncycastle/openpgp/PGPEncryptedDataGenerator.html" target="_top">Frames</a></li>
<li><a href="PGPEncryptedDataGenerator.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#field.summary">Field</a> | </li>
<li><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field.detail">Field</a> | </li>
<li><a href="#constructor.detail">Constr</a> | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.bouncycastle.openpgp</div>
<h2 title="Class PGPEncryptedDataGenerator" class="title">Class PGPEncryptedDataGenerator</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.bouncycastle.openpgp.PGPEncryptedDataGenerator</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../org/bouncycastle/bcpg/SymmetricKeyAlgorithmTags.html" title="interface in org.bouncycastle.bcpg">SymmetricKeyAlgorithmTags</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">PGPEncryptedDataGenerator</span>
extends java.lang.Object
implements <a href="../../../org/bouncycastle/bcpg/SymmetricKeyAlgorithmTags.html" title="interface in org.bouncycastle.bcpg">SymmetricKeyAlgorithmTags</a></pre>
<div class="block">Generator for encrypted objects.
<p>
A PGPEncryptedDataGenerator is used by configuring one or more <a href="../../../org/bouncycastle/openpgp/PGPEncryptedDataGenerator.html#methods"><code>encryption
methods</code></a>, and then invoking one of the open functions to create an OutputStream that raw data can
be supplied to for encryption:</p>
<ul>
<li>If the length of the data to be written is known in advance, use
<a href="../../../org/bouncycastle/openpgp/PGPEncryptedDataGenerator.html#open-java.io.OutputStream-long-"><code>open(OutputStream, long)</code></a> to create a packet containing a single encrypted object.</li>
<li>If the length of the data is unknown, use <a href="../../../org/bouncycastle/openpgp/PGPEncryptedDataGenerator.html#open-java.io.OutputStream-byte:A-"><code>open(OutputStream, byte[])</code></a> to create an
packet consisting of a series of encrypted objects (partials).</li>
</ul>
<p>
Raw data is not typically written directly to the OutputStream obtained from a
PGPEncryptedDataGenerator. The OutputStream is usually wrapped by a
<a href="../../../org/bouncycastle/openpgp/PGPLiteralDataGenerator.html" title="class in org.bouncycastle.openpgp"><code>PGPLiteralDataGenerator</code></a>, and often with a <a href="../../../org/bouncycastle/openpgp/PGPCompressedDataGenerator.html" title="class in org.bouncycastle.openpgp"><code>PGPCompressedDataGenerator</code></a> between.
</p><p>
Once plaintext data for encryption has been written to the constructed OutputStream, writing of
the encrypted object stream is completed by closing the OutputStream obtained from the
<code>open()</code> method, or equivalently invoking <a href="../../../org/bouncycastle/openpgp/PGPEncryptedDataGenerator.html#close--"><code>close()</code></a> on this generator.
</p></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/bouncycastle/openpgp/PGPEncryptedDataGenerator.html#S2K_SHA1">S2K_SHA1</a></span></code>
<div class="block">Specifier for SHA-1 S2K PBE generator.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/bouncycastle/openpgp/PGPEncryptedDataGenerator.html#S2K_SHA224">S2K_SHA224</a></span></code>
<div class="block">Specifier for SHA-224 S2K PBE generator.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/bouncycastle/openpgp/PGPEncryptedDataGenerator.html#S2K_SHA256">S2K_SHA256</a></span></code>
<div class="block">Specifier for SHA-256 S2K PBE generator.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/bouncycastle/openpgp/PGPEncryptedDataGenerator.html#S2K_SHA384">S2K_SHA384</a></span></code>
<div class="block">Specifier for SHA-384 S2K PBE generator.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/bouncycastle/openpgp/PGPEncryptedDataGenerator.html#S2K_SHA512">S2K_SHA512</a></span></code>
<div class="block">Specifier for SHA-512 S2K PBE generator.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.bouncycastle.bcpg.SymmetricKeyAlgorithmTags">
<!-- -->
</a>
<h3>Fields inherited from interface org.bouncycastle.bcpg.<a href="../../../org/bouncycastle/bcpg/SymmetricKeyAlgorithmTags.html" title="interface in org.bouncycastle.bcpg">SymmetricKeyAlgorithmTags</a></h3>
<code><a href="../../../org/bouncycastle/bcpg/SymmetricKeyAlgorithmTags.html#AES_128">AES_128</a>, <a href="../../../org/bouncycastle/bcpg/SymmetricKeyAlgorithmTags.html#AES_192">AES_192</a>, <a href="../../../org/bouncycastle/bcpg/SymmetricKeyAlgorithmTags.html#AES_256">AES_256</a>, <a href="../../../org/bouncycastle/bcpg/SymmetricKeyAlgorithmTags.html#BLOWFISH">BLOWFISH</a>, <a href="../../../org/bouncycastle/bcpg/SymmetricKeyAlgorithmTags.html#CAMELLIA_128">CAMELLIA_128</a>, <a href="../../../org/bouncycastle/bcpg/SymmetricKeyAlgorithmTags.html#CAMELLIA_192">CAMELLIA_192</a>, <a href="../../../org/bouncycastle/bcpg/SymmetricKeyAlgorithmTags.html#CAMELLIA_256">CAMELLIA_256</a>, <a href="../../../org/bouncycastle/bcpg/SymmetricKeyAlgorithmTags.html#CAST5">CAST5</a>, <a href="../../../org/bouncycastle/bcpg/SymmetricKeyAlgorithmTags.html#DES">DES</a>, <a href="../../../org/bouncycastle/bcpg/SymmetricKeyAlgorithmTags.html#IDEA">IDEA</a>, <a href="../../../org/bouncycastle/bcpg/SymmetricKeyAlgorithmTags.html#NULL">NULL</a>, <a href="../../../org/bouncycastle/bcpg/SymmetricKeyAlgorithmTags.html#SAFER">SAFER</a>, <a href="../../../org/bouncycastle/bcpg/SymmetricKeyAlgorithmTags.html#TRIPLE_DES">TRIPLE_DES</a>, <a href="../../../org/bouncycastle/bcpg/SymmetricKeyAlgorithmTags.html#TWOFISH">TWOFISH</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../org/bouncycastle/openpgp/PGPEncryptedDataGenerator.html#PGPEncryptedDataGenerator-org.bouncycastle.openpgp.operator.PGPDataEncryptorBuilder-">PGPEncryptedDataGenerator</a></span>(<a href="../../../org/bouncycastle/openpgp/operator/PGPDataEncryptorBuilder.html" title="interface in org.bouncycastle.openpgp.operator">PGPDataEncryptorBuilder</a> encryptorBuilder)</code>
<div class="block">Base constructor.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../org/bouncycastle/openpgp/PGPEncryptedDataGenerator.html#PGPEncryptedDataGenerator-org.bouncycastle.openpgp.operator.PGPDataEncryptorBuilder-boolean-">PGPEncryptedDataGenerator</a></span>(<a href="../../../org/bouncycastle/openpgp/operator/PGPDataEncryptorBuilder.html" title="interface in org.bouncycastle.openpgp.operator">PGPDataEncryptorBuilder</a> encryptorBuilder,
boolean oldFormat)</code>
<div class="block">Base constructor with the option to turn on formatting for PGP 2.6.x compatibility.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/bouncycastle/openpgp/PGPEncryptedDataGenerator.html#addMethod-org.bouncycastle.openpgp.operator.PGPKeyEncryptionMethodGenerator-">addMethod</a></span>(<a href="../../../org/bouncycastle/openpgp/operator/PGPKeyEncryptionMethodGenerator.html" title="class in org.bouncycastle.openpgp.operator">PGPKeyEncryptionMethodGenerator</a> method)</code>
<div class="block">Add a key encryption method to be used to encrypt the session data associated with this
encrypted data.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/bouncycastle/openpgp/PGPEncryptedDataGenerator.html#close--">close</a></span>()</code>
<div class="block">Close off the encrypted object - this is equivalent to calling close on the stream returned
by the <code>open()</code> methods.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.io.OutputStream</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/bouncycastle/openpgp/PGPEncryptedDataGenerator.html#open-java.io.OutputStream-byte:A-">open</a></span>(java.io.OutputStream out,
byte[] buffer)</code>
<div class="block">Create an OutputStream which will encrypt the data as it is written to it.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.io.OutputStream</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/bouncycastle/openpgp/PGPEncryptedDataGenerator.html#open-java.io.OutputStream-long-">open</a></span>(java.io.OutputStream out,
long length)</code>
<div class="block">Create an OutputStream based on the configured methods to write a single encrypted object of
known length.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="S2K_SHA1">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>S2K_SHA1</h4>
<pre>public static final int S2K_SHA1</pre>
<div class="block">Specifier for SHA-1 S2K PBE generator.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../constant-values.html#org.bouncycastle.openpgp.PGPEncryptedDataGenerator.S2K_SHA1">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="S2K_SHA224">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>S2K_SHA224</h4>
<pre>public static final int S2K_SHA224</pre>
<div class="block">Specifier for SHA-224 S2K PBE generator.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../constant-values.html#org.bouncycastle.openpgp.PGPEncryptedDataGenerator.S2K_SHA224">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="S2K_SHA256">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>S2K_SHA256</h4>
<pre>public static final int S2K_SHA256</pre>
<div class="block">Specifier for SHA-256 S2K PBE generator.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../constant-values.html#org.bouncycastle.openpgp.PGPEncryptedDataGenerator.S2K_SHA256">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="S2K_SHA384">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>S2K_SHA384</h4>
<pre>public static final int S2K_SHA384</pre>
<div class="block">Specifier for SHA-384 S2K PBE generator.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../constant-values.html#org.bouncycastle.openpgp.PGPEncryptedDataGenerator.S2K_SHA384">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="S2K_SHA512">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>S2K_SHA512</h4>
<pre>public static final int S2K_SHA512</pre>
<div class="block">Specifier for SHA-512 S2K PBE generator.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../constant-values.html#org.bouncycastle.openpgp.PGPEncryptedDataGenerator.S2K_SHA512">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="PGPEncryptedDataGenerator-org.bouncycastle.openpgp.operator.PGPDataEncryptorBuilder-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PGPEncryptedDataGenerator</h4>
<pre>public PGPEncryptedDataGenerator(<a href="../../../org/bouncycastle/openpgp/operator/PGPDataEncryptorBuilder.html" title="interface in org.bouncycastle.openpgp.operator">PGPDataEncryptorBuilder</a> encryptorBuilder)</pre>
<div class="block">Base constructor.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>encryptorBuilder</code> - builder to create actual data encryptor.</dd>
</dl>
</li>
</ul>
<a name="PGPEncryptedDataGenerator-org.bouncycastle.openpgp.operator.PGPDataEncryptorBuilder-boolean-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>PGPEncryptedDataGenerator</h4>
<pre>public PGPEncryptedDataGenerator(<a href="../../../org/bouncycastle/openpgp/operator/PGPDataEncryptorBuilder.html" title="interface in org.bouncycastle.openpgp.operator">PGPDataEncryptorBuilder</a> encryptorBuilder,
boolean oldFormat)</pre>
<div class="block">Base constructor with the option to turn on formatting for PGP 2.6.x compatibility.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>encryptorBuilder</code> - builder to create actual data encryptor.</dd>
<dd><code>oldFormat</code> - PGP 2.6.x compatibility required.</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="addMethod-org.bouncycastle.openpgp.operator.PGPKeyEncryptionMethodGenerator-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addMethod</h4>
<pre>public void addMethod(<a href="../../../org/bouncycastle/openpgp/operator/PGPKeyEncryptionMethodGenerator.html" title="class in org.bouncycastle.openpgp.operator">PGPKeyEncryptionMethodGenerator</a> method)</pre>
<div class="block">Add a key encryption method to be used to encrypt the session data associated with this
encrypted data.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>method</code> - key encryption method to use.</dd>
</dl>
</li>
</ul>
<a name="open-java.io.OutputStream-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>open</h4>
<pre>public java.io.OutputStream open(java.io.OutputStream out,
long length)
throws java.io.IOException,
<a href="../../../org/bouncycastle/openpgp/PGPException.html" title="class in org.bouncycastle.openpgp">PGPException</a></pre>
<div class="block">Create an OutputStream based on the configured methods to write a single encrypted object of
known length.
<p>
The stream created can be closed off by either calling close() on the stream or close() on
the generator. Closing the returned stream does not close off the OutputStream parameter out.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>out</code> - the stream to write encrypted packets to.</dd>
<dd><code>length</code> - the length of the data to be encrypted.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the output stream to write data to for encryption.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if an error occurs writing stream header information to the provider
output stream.</dd>
<dd><code><a href="../../../org/bouncycastle/openpgp/PGPException.html" title="class in org.bouncycastle.openpgp">PGPException</a></code> - if an error occurs initialising PGP encryption for the configured
encryption methods.</dd>
<dd><code>java.lang.IllegalStateException</code> - if this generator already has an open OutputStream, or no
<a href="../../../org/bouncycastle/openpgp/PGPEncryptedDataGenerator.html#addMethod-org.bouncycastle.openpgp.operator.PGPKeyEncryptionMethodGenerator-"><code>encryption methods</code></a> are
configured.</dd>
</dl>
</li>
</ul>
<a name="open-java.io.OutputStream-byte:A-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>open</h4>
<pre>public java.io.OutputStream open(java.io.OutputStream out,
byte[] buffer)
throws java.io.IOException,
<a href="../../../org/bouncycastle/openpgp/PGPException.html" title="class in org.bouncycastle.openpgp">PGPException</a></pre>
<div class="block">Create an OutputStream which will encrypt the data as it is written to it. The stream of
encrypted data will be written out in chunks (partial packets) according to the size of the
passed in buffer.
<p>
The stream created can be closed off by either calling close() on the stream or close() on
the generator. Closing the returned stream does not close off the OutputStream parameter out.
<p>
<b>Note</b>: if the buffer is not a power of 2 in length only the largest power of 2 bytes
worth of the buffer will be used.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>out</code> - the stream to write encrypted packets to.</dd>
<dd><code>buffer</code> - a buffer to use to buffer and write partial packets. The returned stream takes
ownership of the buffer and will use it to buffer plaintext data for encryption.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the output stream to write data to for encryption.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if an error occurs writing stream header information to the provider
output stream.</dd>
<dd><code><a href="../../../org/bouncycastle/openpgp/PGPException.html" title="class in org.bouncycastle.openpgp">PGPException</a></code> - if an error occurs initialising PGP encryption for the configured
encryption methods.</dd>
<dd><code>java.lang.IllegalStateException</code> - if this generator already has an open OutputStream, or no
<a href="../../../org/bouncycastle/openpgp/PGPEncryptedDataGenerator.html#addMethod-org.bouncycastle.openpgp.operator.PGPKeyEncryptionMethodGenerator-"><code>encryption methods</code></a> are
configured.</dd>
</dl>
</li>
</ul>
<a name="close--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>close</h4>
<pre>public void close()
throws java.io.IOException</pre>
<div class="block">Close off the encrypted object - this is equivalent to calling close on the stream returned
by the <code>open()</code> methods.
<p>
<b>Note</b>: This does not close the underlying output stream, only the stream on top of it
created by the <code>open()</code> method.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if an error occurs writing trailing information (such as integrity check
information) to the underlying stream.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><b>Bouncy Castle Cryptography Library 1.59</b></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../org/bouncycastle/openpgp/PGPEncryptedData.TruncatedStream.html" title="class in org.bouncycastle.openpgp"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../org/bouncycastle/openpgp/PGPEncryptedDataList.html" title="class in org.bouncycastle.openpgp"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/bouncycastle/openpgp/PGPEncryptedDataGenerator.html" target="_top">Frames</a></li>
<li><a href="PGPEncryptedDataGenerator.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#field.summary">Field</a> | </li>
<li><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field.detail">Field</a> | </li>
<li><a href="#constructor.detail">Constr</a> | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
|