| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>Base64</title> |
| <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="Base64"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":9,"i3":10,"i4":10,"i5":9,"i6":9,"i7":9,"i8":9}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static 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> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/openejb/util/AsynchronousRunner.html" title="class in org.apache.openejb.util"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/openejb/util/CircularReferencesException.html" title="class in org.apache.openejb.util"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/openejb/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.openejb.util</div> |
| <h2 title="Class Base64" class="title">Class Base64</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.openejb.util.Base64</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">Base64</span> |
| extends java.lang.Object</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></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.0-dev</dd> |
| <dt><span class="seeLabel">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="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/apache/openejb/util/Base64.html#Base64--">Base64</a></span>()</code> </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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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>byte[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openejb/util/Base64.html#decode-byte:A-">decode</a></span>(byte[] pArray)</code> |
| <div class="block">Decodes a byte[] containing containing |
| characters in the Base64 alphabet.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>java.lang.Object</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openejb/util/Base64.html#decode-java.lang.Object-">decode</a></span>(java.lang.Object pObject)</code> |
| <div class="block">Decodes an Object using the base64 algorithm.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static byte[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openejb/util/Base64.html#decodeBase64-byte:A-">decodeBase64</a></span>(byte[] base64Data)</code> |
| <div class="block">Decodes Base64 data into octects</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>byte[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openejb/util/Base64.html#encode-byte:A-">encode</a></span>(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 id="i4" class="altColor"> |
| <td class="colFirst"><code>java.lang.Object</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openejb/util/Base64.html#encode-java.lang.Object-">encode</a></span>(java.lang.Object pObject)</code> |
| <div class="block">Encodes an Object using the base64 algorithm.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>static byte[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openejb/util/Base64.html#encodeBase64-byte:A-">encodeBase64</a></span>(byte[] binaryData)</code> |
| <div class="block">Encodes binary data using the base64 algorithm but |
| does not chunk the output.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>static byte[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openejb/util/Base64.html#encodeBase64-byte:A-boolean-">encodeBase64</a></span>(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 id="i7" class="rowColor"> |
| <td class="colFirst"><code>static byte[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openejb/util/Base64.html#encodeBase64Chunked-byte:A-">encodeBase64Chunked</a></span>(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 id="i8" class="altColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openejb/util/Base64.html#isArrayByteBase64-byte:A-">isArrayByteBase64</a></span>(byte[] arrayOctect)</code> |
| <div class="block">Tests a given byte array to see if it contains |
| only valid characters within the Base64 alphabet.</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"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="Base64--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>Base64</h4> |
| <pre>public Base64()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="isArrayByteBase64-byte:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isArrayByteBase64</h4> |
| <pre>public static boolean isArrayByteBase64(byte[] arrayOctect)</pre> |
| <div class="block">Tests a given byte array to see if it contains |
| only valid characters within the Base64 alphabet.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>arrayOctect</code> - byte array to test</dd> |
| <dt><span class="returnLabel">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-"> |
| <!-- --> |
| </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="paramLabel">Parameters:</span></dt> |
| <dd><code>binaryData</code> - binary data to encode</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Base64 characters</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="encodeBase64Chunked-byte:A-"> |
| <!-- --> |
| </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="paramLabel">Parameters:</span></dt> |
| <dd><code>binaryData</code> - binary data to encode</dd> |
| <dt><span class="returnLabel">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 java.lang.Object decode(java.lang.Object pObject) |
| throws java.io.IOException</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[].</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pObject</code> - Object to decode</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>An object (of type byte[]) containing the |
| binary data which corresponds to the byte[] supplied.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code> - if the parameter supplied is not |
| of type byte[]</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="decode-byte:A-"> |
| <!-- --> |
| </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="paramLabel">Parameters:</span></dt> |
| <dd><code>pArray</code> - A byte array containing Base64 character data</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a byte array containing binary data</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="encodeBase64-byte:A-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="paramLabel">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="returnLabel">Returns:</span></dt> |
| <dd>Base64-encoded data.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="decodeBase64-byte:A-"> |
| <!-- --> |
| </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 octects</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>base64Data</code> - Byte array containing Base64 data</dd> |
| <dt><span class="returnLabel">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 java.lang.Object encode(java.lang.Object pObject) |
| throws java.io.IOException</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="paramLabel">Parameters:</span></dt> |
| <dd><code>pObject</code> - Object to encode</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>An object (of type byte[]) containing the |
| base64 encoded data which corresponds to the byte[] supplied.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code> - if the parameter supplied is not |
| of type byte[]</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="encode-byte:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <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="paramLabel">Parameters:</span></dt> |
| <dd><code>pArray</code> - a byte array containing binary data</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A byte array containing only Base64 character data</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> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/openejb/util/AsynchronousRunner.html" title="class in org.apache.openejb.util"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/openejb/util/CircularReferencesException.html" title="class in org.apache.openejb.util"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/openejb/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> |
