/usr/share/doc/libcommons-net2-java/api/org/apache/commons/net/util/Base64.html is in libcommons-net2-java-doc 2.2-2.
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 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_03) on Wed May 30 10:19:43 UTC 2012 -->
<title>Base64 (libcommons-net2-java API)</title>
<meta name="date" content="2012-05-30">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Base64 (libcommons-net2-java API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li><a href="../../../../../org/apache/commons/net/util/ListenerList.html" title="class in org.apache.commons.net.util"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/commons/net/util/Base64.html" target="_top">Frames</a></li>
<li><a href="Base64.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>Field | </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>Field | </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.apache.commons.net.util</div>
<h2 title="Class Base64" class="title">Class Base64</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.commons.net.util.Base64</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">Base64</span>
extends <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">Provides Base64 encoding and decoding as defined by RFC 2045.
<p>
This class implements section <cite>6.8. Base64 Content-Transfer-Encoding</cite> from RFC 2045 <cite>Multipurpose
Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies</cite> by Freed and Borenstein.
</p>
<p>
The class can be parameterized in the following manner with various constructors:
<ul>
<li>URL-safe mode: Default off.</li>
<li>Line length: Default 76. Line length that aren't multiples of 4 will still essentially end up being multiples of
4 in the encoded data.
<li>Line separator: Default is CRLF ("\r\n")</li>
</ul>
</p>
<p>
Since this class operates directly on byte streams, and not character streams, it is hard-coded to only encode/decode
character encodings which are compatible with the lower 127 ASCII chart (ISO-8859-1, Windows-1252, UTF-8, etc).
</p></div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>2.2</dd>
<dt><span class="strong">Version:</span></dt>
<dd>$Id$</dd>
<dt><span class="strong">Author:</span></dt>
<dd>Apache Software Foundation</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="http://www.ietf.org/rfc/rfc2045.txt">RFC 2045</a></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" 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><strong><a href="../../../../../org/apache/commons/net/util/Base64.html#Base64()">Base64</a></strong>()</code>
<div class="block">Creates a Base64 codec used for decoding (all modes) and encoding in URL-unsafe mode.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/commons/net/util/Base64.html#Base64(boolean)">Base64</a></strong>(boolean urlSafe)</code>
<div class="block">Creates a Base64 codec used for decoding (all modes) and encoding in the given URL-safe mode.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/commons/net/util/Base64.html#Base64(int)">Base64</a></strong>(int lineLength)</code>
<div class="block">Creates a Base64 codec used for decoding (all modes) and encoding in URL-unsafe mode.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/commons/net/util/Base64.html#Base64(int, byte[])">Base64</a></strong>(int lineLength,
byte[] lineSeparator)</code>
<div class="block">Creates a Base64 codec used for decoding (all modes) and encoding in URL-unsafe mode.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/commons/net/util/Base64.html#Base64(int, byte[], boolean)">Base64</a></strong>(int lineLength,
byte[] lineSeparator,
boolean urlSafe)</code>
<div class="block">Creates a Base64 codec used for decoding (all modes) and encoding in URL-unsafe mode.</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>byte[]</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/net/util/Base64.html#decode(byte[])">decode</a></strong>(byte[] pArray)</code>
<div class="block">Decodes a byte[] containing containing characters in the Base64 alphabet.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/net/util/Base64.html#decode(java.lang.Object)">decode</a></strong>(<a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> pObject)</code>
<div class="block">Decodes an Object using the base64 algorithm.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>byte[]</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/net/util/Base64.html#decode(java.lang.String)">decode</a></strong>(<a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> pArray)</code>
<div class="block">Decodes a String containing containing characters in the Base64 alphabet.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static byte[]</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/net/util/Base64.html#decodeBase64(byte[])">decodeBase64</a></strong>(byte[] base64Data)</code>
<div class="block">Decodes Base64 data into octets</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static byte[]</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/net/util/Base64.html#decodeBase64(java.lang.String)">decodeBase64</a></strong>(<a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> base64String)</code>
<div class="block">Decodes a Base64 String into octets</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="file:///usr/share/doc/default-jdk-doc/api/java/math/BigInteger.html?is-external=true" title="class or interface in java.math">BigInteger</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/net/util/Base64.html#decodeInteger(byte[])">decodeInteger</a></strong>(byte[] pArray)</code>
<div class="block">Decodes a byte64-encoded integer according to crypto standards such as W3C's XML-Signature</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>byte[]</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/net/util/Base64.html#encode(byte[])">encode</a></strong>(byte[] pArray)</code>
<div class="block">Encodes a byte[] containing binary data, into a byte[] containing characters in the Base64 alphabet.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/net/util/Base64.html#encode(java.lang.Object)">encode</a></strong>(<a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> pObject)</code>
<div class="block">Encodes an Object using the base64 algorithm.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static byte[]</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/net/util/Base64.html#encodeBase64(byte[])">encodeBase64</a></strong>(byte[] binaryData)</code>
<div class="block">Encodes binary data using the base64 algorithm but does not chunk the output.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static byte[]</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/net/util/Base64.html#encodeBase64(byte[], boolean)">encodeBase64</a></strong>(byte[] binaryData,
boolean isChunked)</code>
<div class="block">Encodes binary data using the base64 algorithm, optionally chunking the output into 76 character blocks.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static byte[]</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/net/util/Base64.html#encodeBase64(byte[], boolean, boolean)">encodeBase64</a></strong>(byte[] binaryData,
boolean isChunked,
boolean urlSafe)</code>
<div class="block">Encodes binary data using the base64 algorithm, optionally chunking the output into 76 character blocks.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static byte[]</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/net/util/Base64.html#encodeBase64(byte[], boolean, boolean, int)">encodeBase64</a></strong>(byte[] binaryData,
boolean isChunked,
boolean urlSafe,
int maxResultSize)</code>
<div class="block">Encodes binary data using the base64 algorithm, optionally chunking the output into 76 character blocks.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static byte[]</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/net/util/Base64.html#encodeBase64Chunked(byte[])">encodeBase64Chunked</a></strong>(byte[] binaryData)</code>
<div class="block">Encodes binary data using the base64 algorithm and chunks the encoded output into 76 character blocks</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/net/util/Base64.html#encodeBase64String(byte[])">encodeBase64String</a></strong>(byte[] binaryData)</code>
<div class="block">Encodes binary data using the base64 algorithm into 76 character blocks separated by CRLF.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static byte[]</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/net/util/Base64.html#encodeBase64URLSafe(byte[])">encodeBase64URLSafe</a></strong>(byte[] binaryData)</code>
<div class="block">Encodes binary data using a URL-safe variation of the base64 algorithm but does not chunk the output.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/net/util/Base64.html#encodeBase64URLSafeString(byte[])">encodeBase64URLSafeString</a></strong>(byte[] binaryData)</code>
<div class="block">Encodes binary data using a URL-safe variation of the base64 algorithm but does not chunk the output.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static byte[]</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/net/util/Base64.html#encodeInteger(java.math.BigInteger)">encodeInteger</a></strong>(<a href="file:///usr/share/doc/default-jdk-doc/api/java/math/BigInteger.html?is-external=true" title="class or interface in java.math">BigInteger</a> bigInt)</code>
<div class="block">Encodes to a byte64-encoded integer according to crypto standards such as W3C's XML-Signature</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/net/util/Base64.html#encodeToString(byte[])">encodeToString</a></strong>(byte[] pArray)</code>
<div class="block">Encodes a byte[] containing binary data, into a String containing characters in the Base64 alphabet.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/net/util/Base64.html#isArrayByteBase64(byte[])">isArrayByteBase64</a></strong>(byte[] arrayOctet)</code>
<div class="block">Tests a given byte array to see if it contains only valid characters within the Base64 alphabet.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/net/util/Base64.html#isBase64(byte)">isBase64</a></strong>(byte octet)</code>
<div class="block">Returns whether or not the <code>octet</code> is in the base 64 alphabet.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/net/util/Base64.html#isUrlSafe()">isUrlSafe</a></strong>()</code>
<div class="block">Returns our current encode mode.</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.<a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Base64()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Base64</h4>
<pre>public Base64()</pre>
<div class="block">Creates a Base64 codec used for decoding (all modes) and encoding in URL-unsafe mode.
<p>
When encoding the line length is 76, the line separator is CRLF, and the encoding table is STANDARD_ENCODE_TABLE.
</p>
<p>
When decoding all variants are supported.
</p></div>
</li>
</ul>
<a name="Base64(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Base64</h4>
<pre>public Base64(boolean urlSafe)</pre>
<div class="block">Creates a Base64 codec used for decoding (all modes) and encoding in the given URL-safe mode.
<p>
When encoding the line length is 76, the line separator is CRLF, and the encoding table is STANDARD_ENCODE_TABLE.
</p>
<p>
When decoding all variants are supported.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>urlSafe</code> - if <code>true</code>, URL-safe encoding is used. In most cases this should be set to
<code>false</code>.</dd><dt><span class="strong">Since:</span></dt>
<dd>1.4</dd></dl>
</li>
</ul>
<a name="Base64(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Base64</h4>
<pre>public Base64(int lineLength)</pre>
<div class="block">Creates a Base64 codec used for decoding (all modes) and encoding in URL-unsafe mode.
<p>
When encoding the line length is given in the constructor, the line separator is CRLF, and the encoding table is
STANDARD_ENCODE_TABLE.
</p>
<p>
Line lengths that aren't multiples of 4 will still essentially end up being multiples of 4 in the encoded data.
</p>
<p>
When decoding all variants are supported.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>lineLength</code> - Each line of encoded data will be at most of the given length (rounded down to nearest multiple of 4).
If lineLength <= 0, then the output will not be divided into lines (chunks). Ignored when decoding.</dd><dt><span class="strong">Since:</span></dt>
<dd>1.4</dd></dl>
</li>
</ul>
<a name="Base64(int, byte[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Base64</h4>
<pre>public Base64(int lineLength,
byte[] lineSeparator)</pre>
<div class="block">Creates a Base64 codec used for decoding (all modes) and encoding in URL-unsafe mode.
<p>
When encoding the line length and line separator are given in the constructor, and the encoding table is
STANDARD_ENCODE_TABLE.
</p>
<p>
Line lengths that aren't multiples of 4 will still essentially end up being multiples of 4 in the encoded data.
</p>
<p>
When decoding all variants are supported.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>lineLength</code> - Each line of encoded data will be at most of the given length (rounded down to nearest multiple of 4).
If lineLength <= 0, then the output will not be divided into lines (chunks). Ignored when decoding.</dd><dd><code>lineSeparator</code> - Each line of encoded data will end with this sequence of bytes.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - Thrown when the provided lineSeparator included some base64 characters.</dd><dt><span class="strong">Since:</span></dt>
<dd>1.4</dd></dl>
</li>
</ul>
<a name="Base64(int, byte[], boolean)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Base64</h4>
<pre>public Base64(int lineLength,
byte[] lineSeparator,
boolean urlSafe)</pre>
<div class="block">Creates a Base64 codec used for decoding (all modes) and encoding in URL-unsafe mode.
<p>
When encoding the line length and line separator are given in the constructor, and the encoding table is
STANDARD_ENCODE_TABLE.
</p>
<p>
Line lengths that aren't multiples of 4 will still essentially end up being multiples of 4 in the encoded data.
</p>
<p>
When decoding all variants are supported.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>lineLength</code> - Each line of encoded data will be at most of the given length (rounded down to nearest multiple of 4).
If lineLength <= 0, then the output will not be divided into lines (chunks). Ignored when decoding.</dd><dd><code>lineSeparator</code> - Each line of encoded data will end with this sequence of bytes.</dd><dd><code>urlSafe</code> - Instead of emitting '+' and '/' we emit '-' and '_' respectively. urlSafe is only applied to encode
operations. Decoding seamlessly handles both modes.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - The provided lineSeparator included some base64 characters. That's not going to work!</dd><dt><span class="strong">Since:</span></dt>
<dd>1.4</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="isUrlSafe()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isUrlSafe</h4>
<pre>public boolean isUrlSafe()</pre>
<div class="block">Returns our current encode mode. True if we're URL-SAFE, false otherwise.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if we're in URL-SAFE mode, false otherwise.</dd><dt><span class="strong">Since:</span></dt>
<dd>1.4</dd></dl>
</li>
</ul>
<a name="isBase64(byte)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isBase64</h4>
<pre>public static boolean isBase64(byte octet)</pre>
<div class="block">Returns whether or not the <code>octet</code> is in the base 64 alphabet.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>octet</code> - The value to test</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the value is defined in the the base 64 alphabet, <code>false</code> otherwise.</dd><dt><span class="strong">Since:</span></dt>
<dd>1.4</dd></dl>
</li>
</ul>
<a name="isArrayByteBase64(byte[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isArrayByteBase64</h4>
<pre>public static boolean isArrayByteBase64(byte[] arrayOctet)</pre>
<div class="block">Tests a given byte array to see if it contains only valid characters within the Base64 alphabet. Currently the
method treats whitespace as valid.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>arrayOctet</code> - byte array to test</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if all bytes are valid characters in the Base64 alphabet or if the byte array is empty;
false, otherwise</dd></dl>
</li>
</ul>
<a name="encodeBase64(byte[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encodeBase64</h4>
<pre>public static byte[] encodeBase64(byte[] binaryData)</pre>
<div class="block">Encodes binary data using the base64 algorithm but does not chunk the output.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>binaryData</code> - binary data to encode</dd>
<dt><span class="strong">Returns:</span></dt><dd>byte[] containing Base64 characters in their UTF-8 representation.</dd></dl>
</li>
</ul>
<a name="encodeBase64String(byte[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encodeBase64String</h4>
<pre>public static <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> encodeBase64String(byte[] binaryData)</pre>
<div class="block">Encodes binary data using the base64 algorithm into 76 character blocks separated by CRLF.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>binaryData</code> - binary data to encode</dd>
<dt><span class="strong">Returns:</span></dt><dd>String containing Base64 characters.</dd><dt><span class="strong">Since:</span></dt>
<dd>1.4</dd></dl>
</li>
</ul>
<a name="encodeBase64URLSafe(byte[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encodeBase64URLSafe</h4>
<pre>public static byte[] encodeBase64URLSafe(byte[] binaryData)</pre>
<div class="block">Encodes binary data using a URL-safe variation of the base64 algorithm but does not chunk the output. The
url-safe variation emits - and _ instead of + and / characters.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>binaryData</code> - binary data to encode</dd>
<dt><span class="strong">Returns:</span></dt><dd>byte[] containing Base64 characters in their UTF-8 representation.</dd><dt><span class="strong">Since:</span></dt>
<dd>1.4</dd></dl>
</li>
</ul>
<a name="encodeBase64URLSafeString(byte[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encodeBase64URLSafeString</h4>
<pre>public static <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> encodeBase64URLSafeString(byte[] binaryData)</pre>
<div class="block">Encodes binary data using a URL-safe variation of the base64 algorithm but does not chunk the output. The
url-safe variation emits - and _ instead of + and / characters.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>binaryData</code> - binary data to encode</dd>
<dt><span class="strong">Returns:</span></dt><dd>String containing Base64 characters</dd><dt><span class="strong">Since:</span></dt>
<dd>1.4</dd></dl>
</li>
</ul>
<a name="encodeBase64Chunked(byte[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encodeBase64Chunked</h4>
<pre>public static byte[] encodeBase64Chunked(byte[] binaryData)</pre>
<div class="block">Encodes binary data using the base64 algorithm and chunks the encoded output into 76 character blocks</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>binaryData</code> - binary data to encode</dd>
<dt><span class="strong">Returns:</span></dt><dd>Base64 characters chunked in 76 character blocks</dd></dl>
</li>
</ul>
<a name="decode(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>decode</h4>
<pre>public <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> decode(<a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> pObject)</pre>
<div class="block">Decodes an Object using the base64 algorithm. This method is provided in order to satisfy the requirements of the
Decoder interface, and will throw a DecoderException if the supplied object is not of type byte[] or String.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pObject</code> - Object to decode</dd>
<dt><span class="strong">Returns:</span></dt><dd>An object (of type byte[]) containing the binary data which corresponds to the byte[] or String supplied.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/RuntimeException.html?is-external=true" title="class or interface in java.lang">RuntimeException</a></code> - if the parameter supplied is not of type byte[]</dd></dl>
</li>
</ul>
<a name="decode(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>decode</h4>
<pre>public byte[] decode(<a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> pArray)</pre>
<div class="block">Decodes a String containing containing characters in the Base64 alphabet.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pArray</code> - A String containing Base64 character data</dd>
<dt><span class="strong">Returns:</span></dt><dd>a byte array containing binary data</dd><dt><span class="strong">Since:</span></dt>
<dd>1.4</dd></dl>
</li>
</ul>
<a name="decode(byte[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>decode</h4>
<pre>public byte[] decode(byte[] pArray)</pre>
<div class="block">Decodes a byte[] containing containing characters in the Base64 alphabet.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pArray</code> - A byte array containing Base64 character data</dd>
<dt><span class="strong">Returns:</span></dt><dd>a byte array containing binary data</dd></dl>
</li>
</ul>
<a name="encodeBase64(byte[], boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encodeBase64</h4>
<pre>public static byte[] encodeBase64(byte[] binaryData,
boolean isChunked)</pre>
<div class="block">Encodes binary data using the base64 algorithm, optionally chunking the output into 76 character blocks.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>binaryData</code> - Array containing binary data to encode.</dd><dd><code>isChunked</code> - if <code>true</code> this encoder will chunk the base64 output into 76 character blocks</dd>
<dt><span class="strong">Returns:</span></dt><dd>Base64-encoded data.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - Thrown when the input array needs an output array bigger than <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Integer.html?is-external=true#MAX_VALUE" title="class or interface in java.lang"><code>Integer.MAX_VALUE</code></a></dd></dl>
</li>
</ul>
<a name="encodeBase64(byte[], boolean, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encodeBase64</h4>
<pre>public static byte[] encodeBase64(byte[] binaryData,
boolean isChunked,
boolean urlSafe)</pre>
<div class="block">Encodes binary data using the base64 algorithm, optionally chunking the output into 76 character blocks.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>binaryData</code> - Array containing binary data to encode.</dd><dd><code>isChunked</code> - if <code>true</code> this encoder will chunk the base64 output into 76 character blocks</dd><dd><code>urlSafe</code> - if <code>true</code> this encoder will emit - and _ instead of the usual + and / characters.</dd>
<dt><span class="strong">Returns:</span></dt><dd>Base64-encoded data.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - Thrown when the input array needs an output array bigger than <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Integer.html?is-external=true#MAX_VALUE" title="class or interface in java.lang"><code>Integer.MAX_VALUE</code></a></dd><dt><span class="strong">Since:</span></dt>
<dd>1.4</dd></dl>
</li>
</ul>
<a name="encodeBase64(byte[], boolean, boolean, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encodeBase64</h4>
<pre>public static byte[] encodeBase64(byte[] binaryData,
boolean isChunked,
boolean urlSafe,
int maxResultSize)</pre>
<div class="block">Encodes binary data using the base64 algorithm, optionally chunking the output into 76 character blocks.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>binaryData</code> - Array containing binary data to encode.</dd><dd><code>isChunked</code> - if <code>true</code> this encoder will chunk the base64 output into 76 character blocks</dd><dd><code>urlSafe</code> - if <code>true</code> this encoder will emit - and _ instead of the usual + and / characters.</dd><dd><code>maxResultSize</code> - The maximum result size to accept.</dd>
<dt><span class="strong">Returns:</span></dt><dd>Base64-encoded data.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - Thrown when the input array needs an output array bigger than maxResultSize</dd><dt><span class="strong">Since:</span></dt>
<dd>1.4</dd></dl>
</li>
</ul>
<a name="decodeBase64(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>decodeBase64</h4>
<pre>public static byte[] decodeBase64(<a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> base64String)</pre>
<div class="block">Decodes a Base64 String into octets</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>base64String</code> - String containing Base64 data</dd>
<dt><span class="strong">Returns:</span></dt><dd>Array containing decoded data.</dd><dt><span class="strong">Since:</span></dt>
<dd>1.4</dd></dl>
</li>
</ul>
<a name="decodeBase64(byte[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>decodeBase64</h4>
<pre>public static byte[] decodeBase64(byte[] base64Data)</pre>
<div class="block">Decodes Base64 data into octets</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>base64Data</code> - Byte array containing Base64 data</dd>
<dt><span class="strong">Returns:</span></dt><dd>Array containing decoded data.</dd></dl>
</li>
</ul>
<a name="encode(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encode</h4>
<pre>public <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> encode(<a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> pObject)</pre>
<div class="block">Encodes an Object using the base64 algorithm. This method is provided in order to satisfy the requirements of the
Encoder interface, and will throw an EncoderException if the supplied object is not of type byte[].</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pObject</code> - Object to encode</dd>
<dt><span class="strong">Returns:</span></dt><dd>An object (of type byte[]) containing the base64 encoded data which corresponds to the byte[] supplied.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/RuntimeException.html?is-external=true" title="class or interface in java.lang">RuntimeException</a></code> - if the parameter supplied is not of type byte[]</dd></dl>
</li>
</ul>
<a name="encodeToString(byte[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encodeToString</h4>
<pre>public <a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> encodeToString(byte[] pArray)</pre>
<div class="block">Encodes a byte[] containing binary data, into a String containing characters in the Base64 alphabet.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pArray</code> - a byte array containing binary data</dd>
<dt><span class="strong">Returns:</span></dt><dd>A String containing only Base64 character data</dd><dt><span class="strong">Since:</span></dt>
<dd>1.4</dd></dl>
</li>
</ul>
<a name="encode(byte[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>encode</h4>
<pre>public byte[] encode(byte[] pArray)</pre>
<div class="block">Encodes a byte[] containing binary data, into a byte[] containing characters in the Base64 alphabet.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pArray</code> - a byte array containing binary data</dd>
<dt><span class="strong">Returns:</span></dt><dd>A byte array containing only Base64 character data</dd></dl>
</li>
</ul>
<a name="decodeInteger(byte[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>decodeInteger</h4>
<pre>public static <a href="file:///usr/share/doc/default-jdk-doc/api/java/math/BigInteger.html?is-external=true" title="class or interface in java.math">BigInteger</a> decodeInteger(byte[] pArray)</pre>
<div class="block">Decodes a byte64-encoded integer according to crypto standards such as W3C's XML-Signature</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pArray</code> - a byte array containing base64 character data</dd>
<dt><span class="strong">Returns:</span></dt><dd>A BigInteger</dd><dt><span class="strong">Since:</span></dt>
<dd>1.4</dd></dl>
</li>
</ul>
<a name="encodeInteger(java.math.BigInteger)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>encodeInteger</h4>
<pre>public static byte[] encodeInteger(<a href="file:///usr/share/doc/default-jdk-doc/api/java/math/BigInteger.html?is-external=true" title="class or interface in java.math">BigInteger</a> bigInt)</pre>
<div class="block">Encodes to a byte64-encoded integer according to crypto standards such as W3C's XML-Signature</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>bigInt</code> - a BigInteger</dd>
<dt><span class="strong">Returns:</span></dt><dd>A byte array containing base64 character data</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="file:///usr/share/doc/default-jdk-doc/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if null is passed in</dd><dt><span class="strong">Since:</span></dt>
<dd>1.4</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li><a href="../../../../../org/apache/commons/net/util/ListenerList.html" title="class in org.apache.commons.net.util"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/commons/net/util/Base64.html" target="_top">Frames</a></li>
<li><a href="Base64.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>Field | </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>Field | </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>
|