| <!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_25) on Wed May 25 23:25:54 EDT 2016 --> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>RandomNumberGenerator (Apache Shiro 1.2.5 API)</title> |
| <meta name="date" content="2016-05-25"> |
| <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="RandomNumberGenerator (Apache Shiro 1.2.5 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="class-use/RandomNumberGenerator.html">Use</a></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/shiro/crypto/PaddingScheme.html" title="enum in org.apache.shiro.crypto"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/shiro/crypto/SecureRandomNumberGenerator.html" title="class in org.apache.shiro.crypto"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/shiro/crypto/RandomNumberGenerator.html" target="_top">Frames</a></li> |
| <li><a href="RandomNumberGenerator.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>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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.shiro.crypto</div> |
| <h2 title="Interface RandomNumberGenerator" class="title">Interface RandomNumberGenerator</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../org/apache/shiro/crypto/SecureRandomNumberGenerator.html" title="class in org.apache.shiro.crypto">SecureRandomNumberGenerator</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <a href="../../../../src-html/org/apache/shiro/crypto/RandomNumberGenerator.html#line.49">RandomNumberGenerator</a></pre> |
| <div class="block">A component that can generate random number/byte values as needed. Useful in cryptography or security scenarios |
| where random byte arrays are needed, such as for password salts, nonces, initialization vectors and other seeds. |
| <p/> |
| This is essentially the same as a <a href="http://java.sun.com/javase/6/docs/api/java/security/SecureRandom.html?is-external=true" title="class or interface in java.security"><code>SecureRandom</code></a>, and indeed implementations |
| of this interface will probably all use <a href="http://java.sun.com/javase/6/docs/api/java/security/SecureRandom.html?is-external=true" title="class or interface in java.security"><code>SecureRandom</code></a> instances, but this |
| interface provides a few additional benefits to end-users: |
| <ul> |
| <li>It is an interface rather than the JDK's <code>SecureRandom</code> concrete implementation. Implementation details |
| can be customized as necessary based on the application's needs</li> |
| <li>Default per-instance behavior can be customized on implementations, typically via JavaBeans mutators.</li> |
| <li>Perhaps most important for Shiro end-users, tt can more easily be used as a source of cryptographic seed data, |
| and the data returned is already in a more convenient <a href="../../../../org/apache/shiro/util/ByteSource.html" title="interface in org.apache.shiro.util"><code>ByteSource</code></a> format in case that data needs |
| to be <a href="../../../../org/apache/shiro/util/ByteSource.html#toHex()"><code>hex</code></a> or |
| <a href="../../../../org/apache/shiro/util/ByteSource.html#toBase64()"><code>base64</code></a>-encoded.</li> |
| </ul> |
| For example, consider the following example generating password salts for new user accounts: |
| <pre> |
| RandomNumberGenerator saltGenerator = new <a href="../../../../org/apache/shiro/crypto/SecureRandomNumberGenerator.html" title="class in org.apache.shiro.crypto"><code>SecureRandomNumberGenerator</code></a>(); |
| User user = new User(); |
| user.setPasswordSalt(saltGenerator.nextBytes().toBase64()); |
| userDAO.save(user); |
| </pre></div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>1.1</dd></dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== 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><a href="../../../../org/apache/shiro/util/ByteSource.html" title="interface in org.apache.shiro.util">ByteSource</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/shiro/crypto/RandomNumberGenerator.html#nextBytes()">nextBytes</a></strong>()</code> |
| <div class="block">Generates a byte array of fixed length filled with random data, often useful for generating salts, |
| initialization vectors or other seed data.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/shiro/util/ByteSource.html" title="interface in org.apache.shiro.util">ByteSource</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/shiro/crypto/RandomNumberGenerator.html#nextBytes(int)">nextBytes</a></strong>(int numBytes)</code> |
| <div class="block">Generates a byte array of the specified length filled with random data.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="nextBytes()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>nextBytes</h4> |
| <pre><a href="../../../../org/apache/shiro/util/ByteSource.html" title="interface in org.apache.shiro.util">ByteSource</a> <a href="../../../../src-html/org/apache/shiro/crypto/RandomNumberGenerator.html#line.62">nextBytes</a>()</pre> |
| <div class="block">Generates a byte array of fixed length filled with random data, often useful for generating salts, |
| initialization vectors or other seed data. The length is specified as a configuration |
| value on the underlying implementation. |
| <p/> |
| If you'd like per-invocation control the number of bytes generated, use the |
| <a href="../../../../org/apache/shiro/crypto/RandomNumberGenerator.html#nextBytes(int)"><code>nextBytes(int)</code></a> method instead.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>a byte array of fixed length filled with random data.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/shiro/crypto/RandomNumberGenerator.html#nextBytes(int)"><code>nextBytes(int)</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="nextBytes(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>nextBytes</h4> |
| <pre><a href="../../../../org/apache/shiro/util/ByteSource.html" title="interface in org.apache.shiro.util">ByteSource</a> <a href="../../../../src-html/org/apache/shiro/crypto/RandomNumberGenerator.html#line.71">nextBytes</a>(int numBytes)</pre> |
| <div class="block">Generates a byte array of the specified length filled with random data.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>numBytes</code> - the number of bytes to be populated with random data.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>a byte array of the specified length filled with random data.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/shiro/crypto/RandomNumberGenerator.html#nextBytes()"><code>nextBytes()</code></a></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="class-use/RandomNumberGenerator.html">Use</a></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/shiro/crypto/PaddingScheme.html" title="enum in org.apache.shiro.crypto"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/shiro/crypto/SecureRandomNumberGenerator.html" title="class in org.apache.shiro.crypto"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/shiro/crypto/RandomNumberGenerator.html" target="_top">Frames</a></li> |
| <li><a href="RandomNumberGenerator.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>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2004-2016 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p> |
| </body> |
| </html> |
