| <!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>HashRequest.Builder (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="HashRequest.Builder (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/HashRequest.Builder.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/hash/HashRequest.html" title="interface in org.apache.shiro.crypto.hash"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/shiro/crypto/hash/HashService.html" title="interface in org.apache.shiro.crypto.hash"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/shiro/crypto/hash/HashRequest.Builder.html" target="_top">Frames</a></li> |
| <li><a href="HashRequest.Builder.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.shiro.crypto.hash</div> |
| <h2 title="Class HashRequest.Builder" class="title">Class HashRequest.Builder</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://java.sun.com/javase/6/docs/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.shiro.crypto.hash.HashRequest.Builder</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>Enclosing interface:</dt> |
| <dd><a href="../../../../../org/apache/shiro/crypto/hash/HashRequest.html" title="interface in org.apache.shiro.crypto.hash">HashRequest</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public static class <a href="../../../../../src-html/org/apache/shiro/crypto/hash/HashRequest.html#line.85">HashRequest.Builder</a> |
| extends <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre> |
| <div class="block">A Builder class representing the Builder design pattern for constructing <a href="../../../../../org/apache/shiro/crypto/hash/HashRequest.html" title="interface in org.apache.shiro.crypto.hash"><code>HashRequest</code></a> instances.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>1.2</dd> |
| <dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/shiro/crypto/hash/SimpleHashRequest.html" title="class in org.apache.shiro.crypto.hash"><code>SimpleHashRequest</code></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/shiro/crypto/hash/HashRequest.Builder.html#HashRequest.Builder()">HashRequest.Builder</a></strong>()</code> |
| <div class="block">Default no-arg constructor.</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><a href="../../../../../org/apache/shiro/crypto/hash/HashRequest.html" title="interface in org.apache.shiro.crypto.hash">HashRequest</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/crypto/hash/HashRequest.Builder.html#build()">build</a></strong>()</code> |
| <div class="block">Builds a <a href="../../../../../org/apache/shiro/crypto/hash/HashRequest.html" title="interface in org.apache.shiro.crypto.hash"><code>HashRequest</code></a> instance reflecting the specified configuration.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/shiro/crypto/hash/HashRequest.Builder.html" title="class in org.apache.shiro.crypto.hash">HashRequest.Builder</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/crypto/hash/HashRequest.Builder.html#setAlgorithmName(java.lang.String)">setAlgorithmName</a></strong>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> algorithmName)</code> |
| <div class="block">Sets the name of the hash algorithm the <code>HashService</code> should use when computing the <a href="../../../../../org/apache/shiro/crypto/hash/Hash.html" title="interface in org.apache.shiro.crypto.hash"><code>Hash</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/shiro/crypto/hash/HashRequest.Builder.html" title="class in org.apache.shiro.crypto.hash">HashRequest.Builder</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/crypto/hash/HashRequest.Builder.html#setIterations(int)">setIterations</a></strong>(int iterations)</code> |
| <div class="block">Sets the number of requested hash iterations to be performed when computing the final <code>Hash</code> result.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/shiro/crypto/hash/HashRequest.Builder.html" title="class in org.apache.shiro.crypto.hash">HashRequest.Builder</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/crypto/hash/HashRequest.Builder.html#setSalt(org.apache.shiro.util.ByteSource)">setSalt</a></strong>(<a href="../../../../../org/apache/shiro/util/ByteSource.html" title="interface in org.apache.shiro.util">ByteSource</a> salt)</code> |
| <div class="block">Sets a salt to be used by the <a href="../../../../../org/apache/shiro/crypto/hash/HashService.html" title="interface in org.apache.shiro.crypto.hash"><code>HashService</code></a> during hash computation.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/shiro/crypto/hash/HashRequest.Builder.html" title="class in org.apache.shiro.crypto.hash">HashRequest.Builder</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/crypto/hash/HashRequest.Builder.html#setSalt(java.lang.Object)">setSalt</a></strong>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> salt)</code> |
| <div class="block">Sets a salt to be used by the <a href="../../../../../org/apache/shiro/crypto/hash/HashService.html" title="interface in org.apache.shiro.crypto.hash"><code>HashService</code></a> during hash computation.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/shiro/crypto/hash/HashRequest.Builder.html" title="class in org.apache.shiro.crypto.hash">HashRequest.Builder</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/crypto/hash/HashRequest.Builder.html#setSource(org.apache.shiro.util.ByteSource)">setSource</a></strong>(<a href="../../../../../org/apache/shiro/util/ByteSource.html" title="interface in org.apache.shiro.util">ByteSource</a> source)</code> |
| <div class="block">Sets the source data that will be hashed by a <a href="../../../../../org/apache/shiro/crypto/hash/HashService.html" title="interface in org.apache.shiro.crypto.hash"><code>HashService</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/shiro/crypto/hash/HashRequest.Builder.html" title="class in org.apache.shiro.crypto.hash">HashRequest.Builder</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/shiro/crypto/hash/HashRequest.Builder.html#setSource(java.lang.Object)">setSource</a></strong>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> source)</code> |
| <div class="block">Sets the source data that will be hashed by a <a href="../../../../../org/apache/shiro/crypto/hash/HashService.html" title="interface in org.apache.shiro.crypto.hash"><code>HashService</code></a>.</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="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://java.sun.com/javase/6/docs/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="HashRequest.Builder()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>HashRequest.Builder</h4> |
| <pre>public <a href="../../../../../src-html/org/apache/shiro/crypto/hash/HashRequest.Builder.html#line.95">HashRequest.Builder</a>()</pre> |
| <div class="block">Default no-arg constructor.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="setSource(org.apache.shiro.util.ByteSource)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSource</h4> |
| <pre>public <a href="../../../../../org/apache/shiro/crypto/hash/HashRequest.Builder.html" title="class in org.apache.shiro.crypto.hash">HashRequest.Builder</a> <a href="../../../../../src-html/org/apache/shiro/crypto/hash/HashRequest.Builder.html#line.108">setSource</a>(<a href="../../../../../org/apache/shiro/util/ByteSource.html" title="interface in org.apache.shiro.util">ByteSource</a> source)</pre> |
| <div class="block">Sets the source data that will be hashed by a <a href="../../../../../org/apache/shiro/crypto/hash/HashService.html" title="interface in org.apache.shiro.crypto.hash"><code>HashService</code></a>. For example, this might be a |
| <code>ByteSource</code> representation of a password, or file, etc.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>source</code> - the source data that will be hashed by a <a href="../../../../../org/apache/shiro/crypto/hash/HashService.html" title="interface in org.apache.shiro.crypto.hash"><code>HashService</code></a>.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>this <code>Builder</code> instance for method chaining.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/shiro/crypto/hash/HashRequest.html#getSource()"><code>HashRequest.getSource()</code></a>, |
| <a href="../../../../../org/apache/shiro/crypto/hash/HashRequest.Builder.html#setSource(java.lang.Object)"><code>setSource(Object)</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="setSource(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSource</h4> |
| <pre>public <a href="../../../../../org/apache/shiro/crypto/hash/HashRequest.Builder.html" title="class in org.apache.shiro.crypto.hash">HashRequest.Builder</a> <a href="../../../../../src-html/org/apache/shiro/crypto/hash/HashRequest.Builder.html#line.129">setSource</a>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> source) |
| throws <a href="http://java.sun.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></pre> |
| <div class="block">Sets the source data that will be hashed by a <a href="../../../../../org/apache/shiro/crypto/hash/HashService.html" title="interface in org.apache.shiro.crypto.hash"><code>HashService</code></a>. |
| <p/> |
| This is a convenience alternative to <a href="../../../../../org/apache/shiro/crypto/hash/HashRequest.Builder.html#setSource(org.apache.shiro.util.ByteSource)"><code>setSource(ByteSource)</code></a>: it will attempt to convert the |
| argument into a <a href="../../../../../org/apache/shiro/util/ByteSource.html" title="interface in org.apache.shiro.util"><code>ByteSource</code></a> instance using Shiro's default conversion heuristics |
| (as defined by <code>ByteSource.Util.isCompatible</code>. If the object |
| cannot be heuristically converted to a <code>ByteSource</code>, an <code>IllegalArgumentException</code> will be |
| thrown.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>source</code> - the byte-backed source data that will be hashed by a <a href="../../../../../org/apache/shiro/crypto/hash/HashService.html" title="interface in org.apache.shiro.crypto.hash"><code>HashService</code></a>.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>this <code>Builder</code> instance for method chaining.</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://java.sun.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if the argument cannot be heuristically converted to a <a href="../../../../../org/apache/shiro/util/ByteSource.html" title="interface in org.apache.shiro.util"><code>ByteSource</code></a> |
| instance.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/shiro/crypto/hash/HashRequest.html#getSource()"><code>HashRequest.getSource()</code></a>, |
| <a href="../../../../../org/apache/shiro/crypto/hash/HashRequest.Builder.html#setSource(org.apache.shiro.util.ByteSource)"><code>setSource(ByteSource)</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="setSalt(org.apache.shiro.util.ByteSource)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSalt</h4> |
| <pre>public <a href="../../../../../org/apache/shiro/crypto/hash/HashRequest.Builder.html" title="class in org.apache.shiro.crypto.hash">HashRequest.Builder</a> <a href="../../../../../src-html/org/apache/shiro/crypto/hash/HashRequest.Builder.html#line.147">setSalt</a>(<a href="../../../../../org/apache/shiro/util/ByteSource.html" title="interface in org.apache.shiro.util">ByteSource</a> salt)</pre> |
| <div class="block">Sets a salt to be used by the <a href="../../../../../org/apache/shiro/crypto/hash/HashService.html" title="interface in org.apache.shiro.crypto.hash"><code>HashService</code></a> during hash computation. |
| <p/> |
| <b>NOTE</b>: not calling this method does not necessarily mean a salt won't be used at all - it just |
| means that the request didn't include a salt. The servicing <a href="../../../../../org/apache/shiro/crypto/hash/HashService.html" title="interface in org.apache.shiro.crypto.hash"><code>HashService</code></a> is free to provide a salting |
| strategy for a request, even if the request did not specify one. You can always check the result |
| <code>Hash</code> <a href="../../../../../org/apache/shiro/crypto/hash/Hash.html#getSalt()"><code>getSalt()</code></a> method to see what the actual |
| salt was (if any), which may or may not match this request salt.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>salt</code> - a salt to be used by the <a href="../../../../../org/apache/shiro/crypto/hash/HashService.html" title="interface in org.apache.shiro.crypto.hash"><code>HashService</code></a> during hash computation</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>this <code>Builder</code> instance for method chaining.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/shiro/crypto/hash/HashRequest.html#getSalt()"><code>HashRequest.getSalt()</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="setSalt(java.lang.Object)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSalt</h4> |
| <pre>public <a href="../../../../../org/apache/shiro/crypto/hash/HashRequest.Builder.html" title="class in org.apache.shiro.crypto.hash">HashRequest.Builder</a> <a href="../../../../../src-html/org/apache/shiro/crypto/hash/HashRequest.Builder.html#line.168">setSalt</a>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> salt) |
| throws <a href="http://java.sun.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></pre> |
| <div class="block">Sets a salt to be used by the <a href="../../../../../org/apache/shiro/crypto/hash/HashService.html" title="interface in org.apache.shiro.crypto.hash"><code>HashService</code></a> during hash computation. |
| <p/> |
| This is a convenience alternative to <a href="../../../../../org/apache/shiro/crypto/hash/HashRequest.Builder.html#setSalt(org.apache.shiro.util.ByteSource)"><code>setSalt(ByteSource)</code></a>: it will attempt to convert the |
| argument into a <a href="../../../../../org/apache/shiro/util/ByteSource.html" title="interface in org.apache.shiro.util"><code>ByteSource</code></a> instance using Shiro's default conversion heuristics |
| (as defined by <code>ByteSource.Util.isCompatible</code>. If the object |
| cannot be heuristically converted to a <code>ByteSource</code>, an <code>IllegalArgumentException</code> will be |
| thrown.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>salt</code> - a salt to be used by the <a href="../../../../../org/apache/shiro/crypto/hash/HashService.html" title="interface in org.apache.shiro.crypto.hash"><code>HashService</code></a> during hash computation.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>this <code>Builder</code> instance for method chaining.</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://java.sun.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if the argument cannot be heuristically converted to a <a href="../../../../../org/apache/shiro/util/ByteSource.html" title="interface in org.apache.shiro.util"><code>ByteSource</code></a> |
| instance.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/shiro/crypto/hash/HashRequest.Builder.html#setSalt(org.apache.shiro.util.ByteSource)"><code>setSalt(ByteSource)</code></a>, |
| <a href="../../../../../org/apache/shiro/crypto/hash/HashRequest.html#getSalt()"><code>HashRequest.getSalt()</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="setIterations(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setIterations</h4> |
| <pre>public <a href="../../../../../org/apache/shiro/crypto/hash/HashRequest.Builder.html" title="class in org.apache.shiro.crypto.hash">HashRequest.Builder</a> <a href="../../../../../src-html/org/apache/shiro/crypto/hash/HashRequest.Builder.html#line.189">setIterations</a>(int iterations)</pre> |
| <div class="block">Sets the number of requested hash iterations to be performed when computing the final <code>Hash</code> result. |
| Not calling this method or setting a non-positive value (0 or less) indicates that the <code>HashService</code>'s |
| default iteration configuration should be used. A positive value overrides the <code>HashService</code>'s |
| configuration for a single request. |
| <p/> |
| Note that a <code>HashService</code> is free to ignore this number if it determines the number is not sufficient |
| to meet a desired level of security. You can always check the result |
| <code>Hash</code> <a href="../../../../../org/apache/shiro/crypto/hash/Hash.html#getIterations()"><code>getIterations()</code></a> method to see what the actual |
| number of iterations was, which may or may not match this request salt.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>iterations</code> - the number of requested hash iterations to be performed when computing the final |
| <code>Hash</code> result.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>this <code>Builder</code> instance for method chaining.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/shiro/crypto/hash/HashRequest.html#getIterations()"><code>HashRequest.getIterations()</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="setAlgorithmName(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAlgorithmName</h4> |
| <pre>public <a href="../../../../../org/apache/shiro/crypto/hash/HashRequest.Builder.html" title="class in org.apache.shiro.crypto.hash">HashRequest.Builder</a> <a href="../../../../../src-html/org/apache/shiro/crypto/hash/HashRequest.Builder.html#line.211">setAlgorithmName</a>(<a href="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> algorithmName)</pre> |
| <div class="block">Sets the name of the hash algorithm the <code>HashService</code> should use when computing the <a href="../../../../../org/apache/shiro/crypto/hash/Hash.html" title="interface in org.apache.shiro.crypto.hash"><code>Hash</code></a>. |
| Not calling this method or setting it to <code>null</code> indicates the the default algorithm configuration of |
| the <code>HashService</code> should be used. A non-null value |
| overrides the <code>HashService</code>'s configuration for a single request. |
| <p/> |
| Note that a <code>HashService</code> is free to ignore this value if it determines that the algorithm is not |
| sufficient to meet a desired level of security. You can always check the result |
| <code>Hash</code> <a href="../../../../../org/apache/shiro/crypto/hash/Hash.html#getAlgorithmName()"><code>getAlgorithmName()</code></a> method to see what the actual |
| algorithm was, which may or may not match this request salt.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>algorithmName</code> - the name of the hash algorithm the <code>HashService</code> should use when computing the |
| <a href="../../../../../org/apache/shiro/crypto/hash/Hash.html" title="interface in org.apache.shiro.crypto.hash"><code>Hash</code></a>, or <code>null</code> if the default algorithm configuration of the |
| <code>HashService</code> should be used.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>this <code>Builder</code> instance for method chaining.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/shiro/crypto/hash/HashRequest.html#getAlgorithmName()"><code>HashRequest.getAlgorithmName()</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="build()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>build</h4> |
| <pre>public <a href="../../../../../org/apache/shiro/crypto/hash/HashRequest.html" title="interface in org.apache.shiro.crypto.hash">HashRequest</a> <a href="../../../../../src-html/org/apache/shiro/crypto/hash/HashRequest.Builder.html#line.221">build</a>()</pre> |
| <div class="block">Builds a <a href="../../../../../org/apache/shiro/crypto/hash/HashRequest.html" title="interface in org.apache.shiro.crypto.hash"><code>HashRequest</code></a> instance reflecting the specified configuration.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>a <a href="../../../../../org/apache/shiro/crypto/hash/HashRequest.html" title="interface in org.apache.shiro.crypto.hash"><code>HashRequest</code></a> instance reflecting the specified configuration.</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/HashRequest.Builder.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/hash/HashRequest.html" title="interface in org.apache.shiro.crypto.hash"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/shiro/crypto/hash/HashService.html" title="interface in org.apache.shiro.crypto.hash"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/shiro/crypto/hash/HashRequest.Builder.html" target="_top">Frames</a></li> |
| <li><a href="HashRequest.Builder.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 ======= --> |
| <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> |