1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
5 <!-- Generated by javadoc (version 1.6.0_27) on Thu Oct 17 21:45:31 EDT 2013 -->
6 <meta http-equiv="Content-Type" content="text/html" charset="utf-8">
7 <title>RegexRulesPasswordProvider (Solr 4.5.1 API)</title>
8 <meta name="date" content="2013-10-17">
9 <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
12 <script type="text/javascript"><!--
13 if (location.href.indexOf('is-external=true') == -1) {
14 parent.document.title="RegexRulesPasswordProvider (Solr 4.5.1 API)";
19 <div>JavaScript is disabled on your browser.</div>
21 <!-- ========= START OF TOP NAVBAR ======= -->
22 <div class="topNav"><a name="navbar_top">
24 </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
27 <ul class="navList" title="Navigation">
28 <li><a href="../../../../../overview-summary.html">Overview</a></li>
29 <li><a href="../../../../../org/apache/solr/handler/extraction/package-summary.html">Package</a></li>
30 <li class="navBarCell1Rev">Class</li>
31 <li><a href="class-use/RegexRulesPasswordProvider.html">Use</a></li>
32 <li><a href="package-tree.html">Tree</a></li>
33 <li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
34 <li><a href="../../../../../help-doc.html">Help</a></li>
39 <li><a href="../../../../../org/apache/solr/handler/extraction/ExtractingRequestHandler.html" title="class in org.apache.solr.handler.extraction"><span class="strong">PREV CLASS</span></a></li>
40 <li><a href="../../../../../org/apache/solr/handler/extraction/SolrContentHandler.html" title="class in org.apache.solr.handler.extraction"><span class="strong">NEXT CLASS</span></a></li>
43 <li><a href="../../../../../index.html?org/apache/solr/handler/extraction/RegexRulesPasswordProvider.html" target="_top">FRAMES</a></li>
44 <li><a href="RegexRulesPasswordProvider.html" target="_top">NO FRAMES</a></li>
46 <ul class="navList" id="allclasses_navbar_top">
47 <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
50 <script type="text/javascript"><!--
51 allClassesLink = document.getElementById("allclasses_navbar_top");
53 allClassesLink.style.display = "block";
56 allClassesLink.style.display = "none";
62 <ul class="subNavList">
63 <li>SUMMARY: </li>
64 <li>NESTED | </li>
65 <li>FIELD | </li>
66 <li><a href="#constructor_summary">CONSTR</a> | </li>
67 <li><a href="#method_summary">METHOD</a></li>
69 <ul class="subNavList">
70 <li>DETAIL: </li>
71 <li>FIELD | </li>
72 <li><a href="#constructor_detail">CONSTR</a> | </li>
73 <li><a href="#method_detail">METHOD</a></li>
76 <a name="skip-navbar_top">
79 <!-- ========= END OF TOP NAVBAR ========= -->
80 <!-- ======== START OF CLASS DATA ======== -->
82 <p class="subTitle">org.apache.solr.handler.extraction</p>
83 <h2 title="Class RegexRulesPasswordProvider" class="title">Class RegexRulesPasswordProvider</h2>
85 <div class="contentContainer">
86 <ul class="inheritance">
87 <li><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
89 <ul class="inheritance">
90 <li>org.apache.solr.handler.extraction.RegexRulesPasswordProvider</li>
94 <div class="description">
95 <ul class="blockList">
96 <li class="blockList">
98 <dt>All Implemented Interfaces:</dt>
99 <dd>org.apache.tika.parser.PasswordProvider</dd>
103 <pre>public class <strong>RegexRulesPasswordProvider</strong>
104 extends <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
105 implements org.apache.tika.parser.PasswordProvider</pre>
106 <div class="block">Password provider for Extracting request handler which finds correct
107 password based on file name matching against a list of regular expressions.
108 The list of passwords is supplied in an optional Map.
109 If an explicit password is set, it will be used.</div>
113 <div class="summary">
114 <ul class="blockList">
115 <li class="blockList">
116 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
117 <ul class="blockList">
118 <li class="blockList"><a name="constructor_summary">
121 <h3>Constructor Summary</h3>
122 <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
123 <caption><span>Constructors</span><span class="tabEnd"> </span></caption>
125 <th class="colOne" scope="col">Constructor and Description</th>
127 <tr class="altColor">
128 <td class="colOne"><code><strong><a href="../../../../../org/apache/solr/handler/extraction/RegexRulesPasswordProvider.html#RegexRulesPasswordProvider()">RegexRulesPasswordProvider</a></strong>()</code> </td>
133 <!-- ========== METHOD SUMMARY =========== -->
134 <ul class="blockList">
135 <li class="blockList"><a name="method_summary">
138 <h3>Method Summary</h3>
139 <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
140 <caption><span>Methods</span><span class="tabEnd"> </span></caption>
142 <th class="colFirst" scope="col">Modifier and Type</th>
143 <th class="colLast" scope="col">Method and Description</th>
145 <tr class="altColor">
146 <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
147 <td class="colLast"><code><strong><a href="../../../../../org/apache/solr/handler/extraction/RegexRulesPasswordProvider.html#getExplicitPassword()">getExplicitPassword</a></strong>()</code>
148 <div class="block">Gets the explicit password, if set</div>
151 <tr class="rowColor">
152 <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
153 <td class="colLast"><code><strong><a href="../../../../../org/apache/solr/handler/extraction/RegexRulesPasswordProvider.html#getPassword(org.apache.tika.metadata.Metadata)">getPassword</a></strong>(org.apache.tika.metadata.Metadata meta)</code> </td>
155 <tr class="altColor">
156 <td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/LinkedHashMap.html?is-external=true" title="class or interface in java.util">LinkedHashMap</a><<a href="http://download.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html?is-external=true" title="class or interface in java.util.regex">Pattern</a>,<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td>
157 <td class="colLast"><code><strong><a href="../../../../../org/apache/solr/handler/extraction/RegexRulesPasswordProvider.html#getPasswordMap()">getPasswordMap</a></strong>()</code> </td>
159 <tr class="rowColor">
160 <td class="colFirst"><code>void</code></td>
161 <td class="colLast"><code><strong><a href="../../../../../org/apache/solr/handler/extraction/RegexRulesPasswordProvider.html#parse(java.io.InputStream)">parse</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> is)</code>
162 <div class="block">Initialize rules through file input stream.</div>
165 <tr class="altColor">
166 <td class="colFirst"><code>static <a href="http://download.oracle.com/javase/6/docs/api/java/util/LinkedHashMap.html?is-external=true" title="class or interface in java.util">LinkedHashMap</a><<a href="http://download.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html?is-external=true" title="class or interface in java.util.regex">Pattern</a>,<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>></code></td>
167 <td class="colLast"><code><strong><a href="../../../../../org/apache/solr/handler/extraction/RegexRulesPasswordProvider.html#parseRulesFile(java.io.InputStream)">parseRulesFile</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> is)</code>
168 <div class="block">Parses rule file from stream and returns a Map of all rules found</div>
171 <tr class="rowColor">
172 <td class="colFirst"><code>void</code></td>
173 <td class="colLast"><code><strong><a href="../../../../../org/apache/solr/handler/extraction/RegexRulesPasswordProvider.html#resetExplicitPassword()">resetExplicitPassword</a></strong>()</code>
174 <div class="block">Resets explicit password, so that map will be used for lookups</div>
177 <tr class="altColor">
178 <td class="colFirst"><code>void</code></td>
179 <td class="colLast"><code><strong><a href="../../../../../org/apache/solr/handler/extraction/RegexRulesPasswordProvider.html#setExplicitPassword(java.lang.String)">setExplicitPassword</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> explicitPassword)</code>
180 <div class="block">Sets an explicit password which will be used instead of password map</div>
183 <tr class="rowColor">
184 <td class="colFirst"><code>void</code></td>
185 <td class="colLast"><code><strong><a href="../../../../../org/apache/solr/handler/extraction/RegexRulesPasswordProvider.html#setPasswordMap(java.util.LinkedHashMap)">setPasswordMap</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/util/LinkedHashMap.html?is-external=true" title="class or interface in java.util">LinkedHashMap</a><<a href="http://download.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html?is-external=true" title="class or interface in java.util.regex">Pattern</a>,<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> linkedHashMap)</code> </td>
188 <ul class="blockList">
189 <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
192 <h3>Methods inherited from class java.lang.<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
193 <code><a href="http://download.oracle.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://download.oracle.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://download.oracle.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://download.oracle.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://download.oracle.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://download.oracle.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://download.oracle.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://download.oracle.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://download.oracle.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://download.oracle.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://download.oracle.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>
200 <div class="details">
201 <ul class="blockList">
202 <li class="blockList">
203 <!-- ========= CONSTRUCTOR DETAIL ======== -->
204 <ul class="blockList">
205 <li class="blockList"><a name="constructor_detail">
208 <h3>Constructor Detail</h3>
209 <a name="RegexRulesPasswordProvider()">
212 <ul class="blockListLast">
213 <li class="blockList">
214 <h4>RegexRulesPasswordProvider</h4>
215 <pre>public RegexRulesPasswordProvider()</pre>
220 <!-- ============ METHOD DETAIL ========== -->
221 <ul class="blockList">
222 <li class="blockList"><a name="method_detail">
225 <h3>Method Detail</h3>
226 <a name="getPassword(org.apache.tika.metadata.Metadata)">
229 <ul class="blockList">
230 <li class="blockList">
232 <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getPassword(org.apache.tika.metadata.Metadata meta)</pre>
234 <dt><strong>Specified by:</strong></dt>
235 <dd><code>getPassword</code> in interface <code>org.apache.tika.parser.PasswordProvider</code></dd>
239 <a name="parseRulesFile(java.io.InputStream)">
242 <ul class="blockList">
243 <li class="blockList">
244 <h4>parseRulesFile</h4>
245 <pre>public static <a href="http://download.oracle.com/javase/6/docs/api/java/util/LinkedHashMap.html?is-external=true" title="class or interface in java.util">LinkedHashMap</a><<a href="http://download.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html?is-external=true" title="class or interface in java.util.regex">Pattern</a>,<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> parseRulesFile(<a href="http://download.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> is)</pre>
246 <div class="block">Parses rule file from stream and returns a Map of all rules found</div>
247 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>is</code> - input stream for the file</dd></dl>
250 <a name="parse(java.io.InputStream)">
253 <ul class="blockList">
254 <li class="blockList">
256 <pre>public void parse(<a href="http://download.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> is)</pre>
257 <div class="block">Initialize rules through file input stream. This is a convenience for first calling
258 setPasswordMap(parseRulesFile(is)).</div>
259 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>is</code> - the input stream with rules file, one line per rule on format regex=password</dd></dl>
262 <a name="getPasswordMap()">
265 <ul class="blockList">
266 <li class="blockList">
267 <h4>getPasswordMap</h4>
268 <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/util/LinkedHashMap.html?is-external=true" title="class or interface in java.util">LinkedHashMap</a><<a href="http://download.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html?is-external=true" title="class or interface in java.util.regex">Pattern</a>,<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> getPasswordMap()</pre>
271 <a name="setPasswordMap(java.util.LinkedHashMap)">
274 <ul class="blockList">
275 <li class="blockList">
276 <h4>setPasswordMap</h4>
277 <pre>public void setPasswordMap(<a href="http://download.oracle.com/javase/6/docs/api/java/util/LinkedHashMap.html?is-external=true" title="class or interface in java.util">LinkedHashMap</a><<a href="http://download.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html?is-external=true" title="class or interface in java.util.regex">Pattern</a>,<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> linkedHashMap)</pre>
280 <a name="getExplicitPassword()">
283 <ul class="blockList">
284 <li class="blockList">
285 <h4>getExplicitPassword</h4>
286 <pre>public <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getExplicitPassword()</pre>
287 <div class="block">Gets the explicit password, if set</div>
288 <dl><dt><span class="strong">Returns:</span></dt><dd>the password, or null if not set</dd></dl>
291 <a name="setExplicitPassword(java.lang.String)">
294 <ul class="blockList">
295 <li class="blockList">
296 <h4>setExplicitPassword</h4>
297 <pre>public void setExplicitPassword(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> explicitPassword)</pre>
298 <div class="block">Sets an explicit password which will be used instead of password map</div>
299 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>explicitPassword</code> - the password to use</dd></dl>
302 <a name="resetExplicitPassword()">
305 <ul class="blockListLast">
306 <li class="blockList">
307 <h4>resetExplicitPassword</h4>
308 <pre>public void resetExplicitPassword()</pre>
309 <div class="block">Resets explicit password, so that map will be used for lookups</div>
318 <!-- ========= END OF CLASS DATA ========= -->
319 <!-- ======= START OF BOTTOM NAVBAR ====== -->
320 <div class="bottomNav"><a name="navbar_bottom">
322 </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
325 <ul class="navList" title="Navigation">
326 <li><a href="../../../../../overview-summary.html">Overview</a></li>
327 <li><a href="../../../../../org/apache/solr/handler/extraction/package-summary.html">Package</a></li>
328 <li class="navBarCell1Rev">Class</li>
329 <li><a href="class-use/RegexRulesPasswordProvider.html">Use</a></li>
330 <li><a href="package-tree.html">Tree</a></li>
331 <li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
332 <li><a href="../../../../../help-doc.html">Help</a></li>
337 <li><a href="../../../../../org/apache/solr/handler/extraction/ExtractingRequestHandler.html" title="class in org.apache.solr.handler.extraction"><span class="strong">PREV CLASS</span></a></li>
338 <li><a href="../../../../../org/apache/solr/handler/extraction/SolrContentHandler.html" title="class in org.apache.solr.handler.extraction"><span class="strong">NEXT CLASS</span></a></li>
341 <li><a href="../../../../../index.html?org/apache/solr/handler/extraction/RegexRulesPasswordProvider.html" target="_top">FRAMES</a></li>
342 <li><a href="RegexRulesPasswordProvider.html" target="_top">NO FRAMES</a></li>
344 <ul class="navList" id="allclasses_navbar_bottom">
345 <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
348 <script type="text/javascript"><!--
349 allClassesLink = document.getElementById("allclasses_navbar_bottom");
351 allClassesLink.style.display = "block";
354 allClassesLink.style.display = "none";
360 <ul class="subNavList">
361 <li>SUMMARY: </li>
362 <li>NESTED | </li>
363 <li>FIELD | </li>
364 <li><a href="#constructor_summary">CONSTR</a> | </li>
365 <li><a href="#method_summary">METHOD</a></li>
367 <ul class="subNavList">
368 <li>DETAIL: </li>
369 <li>FIELD | </li>
370 <li><a href="#constructor_detail">CONSTR</a> | </li>
371 <li><a href="#method_detail">METHOD</a></li>
374 <a name="skip-navbar_bottom">
377 <!-- ======== END OF BOTTOM NAVBAR ======= -->
378 <p class="legalCopy"><small>
379 <i>Copyright © 2000-2013 Apache Software Foundation. All Rights Reserved.</i>
380 <script src='../../../../../prettify.js' type='text/javascript'></script>
381 <script type='text/javascript'>
383 var oldonload = window.onload;
384 if (typeof oldonload != 'function') {
385 window.onload = prettyPrint;
387 window.onload = function() {