📄 htmlformcredential.html
字号:
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"><head><meta http-equiv="content-type" content="text/html; charset=UTF-8" /><title>HtmlFormCredential xref</title><link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /></head><body><div id="overview"><a href="../../../../../../apidocs/org/archive/crawler/datamodel/credential/HtmlFormCredential.html">View Javadoc</a></div><pre><a name="1" href="#1">1</a> <em class="comment">/*<em class="comment"> HtmlFormCredential</em></em><a name="2" href="#2">2</a> <em class="comment"> *</em><a name="3" href="#3">3</a> <em class="comment"> * Created on Apr 7, 2004</em><a name="4" href="#4">4</a> <em class="comment"> *</em><a name="5" href="#5">5</a> <em class="comment"> * Copyright (C) 2004 Internet Archive.</em><a name="6" href="#6">6</a> <em class="comment"> *</em><a name="7" href="#7">7</a> <em class="comment"> * This file is part of the Heritrix web crawler (crawler.archive.org).</em><a name="8" href="#8">8</a> <em class="comment"> *</em><a name="9" href="#9">9</a> <em class="comment"> * Heritrix is free software; you can redistribute it and/or modify</em><a name="10" href="#10">10</a> <em class="comment"> * it under the terms of the GNU Lesser Public License as published by</em><a name="11" href="#11">11</a> <em class="comment"> * the Free Software Foundation; either version 2.1 of the License, or</em><a name="12" href="#12">12</a> <em class="comment"> * any later version.</em><a name="13" href="#13">13</a> <em class="comment"> *</em><a name="14" href="#14">14</a> <em class="comment"> * Heritrix is distributed in the hope that it will be useful,</em><a name="15" href="#15">15</a> <em class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</em><a name="16" href="#16">16</a> <em class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</em><a name="17" href="#17">17</a> <em class="comment"> * GNU Lesser Public License for more details.</em><a name="18" href="#18">18</a> <em class="comment"> *</em><a name="19" href="#19">19</a> <em class="comment"> * You should have received a copy of the GNU Lesser Public License</em><a name="20" href="#20">20</a> <em class="comment"> * along with Heritrix; if not, write to the Free Software</em><a name="21" href="#21">21</a> <em class="comment"> * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA</em><a name="22" href="#22">22</a> <em class="comment"> */</em><a name="23" href="#23">23</a> <strong>package</strong> <a href="../../../../../org/archive/crawler/datamodel/credential/package-summary.html">org.archive.crawler.datamodel.credential</a>;<a name="24" href="#24">24</a> <a name="25" href="#25">25</a> <strong>import</strong> java.util.HashMap;<a name="26" href="#26">26</a> <strong>import</strong> java.util.Iterator;<a name="27" href="#27">27</a> <strong>import</strong> java.util.Map;<a name="28" href="#28">28</a> <strong>import</strong> java.util.logging.Logger;<a name="29" href="#29">29</a> <a name="30" href="#30">30</a> <strong>import</strong> javax.management.Attribute;<a name="31" href="#31">31</a> <strong>import</strong> javax.management.AttributeNotFoundException;<a name="32" href="#32">32</a> <a name="33" href="#33">33</a> <strong>import</strong> org.apache.commons.httpclient.HttpClient;<a name="34" href="#34">34</a> <strong>import</strong> org.apache.commons.httpclient.HttpMethod;<a name="35" href="#35">35</a> <strong>import</strong> org.apache.commons.httpclient.HttpMethodBase;<a name="36" href="#36">36</a> <strong>import</strong> org.apache.commons.httpclient.NameValuePair;<a name="37" href="#37">37</a> <strong>import</strong> org.apache.commons.httpclient.URIException;<a name="38" href="#38">38</a> <strong>import</strong> org.apache.commons.httpclient.methods.GetMethod;<a name="39" href="#39">39</a> <strong>import</strong> org.apache.commons.httpclient.methods.PostMethod;<a name="40" href="#40">40</a> <strong>import</strong> org.archive.crawler.datamodel.CrawlURI;<a name="41" href="#41">41</a> <strong>import</strong> org.archive.crawler.settings.MapType;<a name="42" href="#42">42</a> <strong>import</strong> org.archive.crawler.settings.SimpleType;<a name="43" href="#43">43</a> <strong>import</strong> org.archive.crawler.settings.Type;<a name="44" href="#44">44</a> <strong>import</strong> org.archive.net.UURI;<a name="45" href="#45">45</a> <strong>import</strong> org.archive.net.UURIFactory;<a name="46" href="#46">46</a> <a name="47" href="#47">47</a> <a name="48" href="#48">48</a> <a name="49" href="#49">49</a> <em>/**<em>*</em></em><a name="50" href="#50">50</a> <em> * Credential that holds all needed to do a GET/POST to a HTML form.</em><a name="51" href="#51">51</a> <em> *</em><a name="52" href="#52">52</a> <em> * @author stack</em><a name="53" href="#53">53</a> <em> * @version $Revision: 1.14 $, $Date: 2005/07/18 17:29:17 $</em><a name="54" href="#54">54</a> <em> */</em><a name="55" href="#55">55</a> <strong>public</strong> <strong>class</strong> <a href="../../../../../org/archive/crawler/datamodel/credential/HtmlFormCredential.html">HtmlFormCredential</a> <strong>extends</strong> <a href="../../../../../org/archive/crawler/datamodel/credential/Credential.html">Credential</a> {<a name="56" href="#56">56</a> <a name="57" href="#57">57</a> <strong>private</strong> <strong>static</strong> <strong>final</strong> Logger logger =<a name="58" href="#58">58</a> Logger.getLogger(HtmlFormCredential.<strong>class</strong>.getName());<a name="59" href="#59">59</a> <a name="60" href="#60">60</a> <strong>private</strong> <strong>static</strong> <strong>final</strong> String ATTR_LOGIN_URI = <span class="string">"login-uri"</span>;<a name="61" href="#61">61</a> <strong>private</strong> <strong>static</strong> <strong>final</strong> String ATTR_FORM_ITEMS = <span class="string">"form-items"</span>;<a name="62" href="#62">62</a> <strong>private</strong> <strong>static</strong> <strong>final</strong> String ATTR_FORM_METHOD = <span class="string">"http-method"</span>;<a name="63" href="#63">63</a> <strong>private</strong> <strong>static</strong> <strong>final</strong> String [] METHODS = {<span class="string">"POST"</span>, <span class="string">"GET"</span>};<a name="64" href="#64">64</a> <a name="65" href="#65">65</a> <em>/**<em>*</em></em><a name="66" href="#66">66</a> <em> * Constructor.</em><a name="67" href="#67">67</a> <em> *</em><a name="68" href="#68">68</a> <em> * A constructor that takes name of the credential is required by settings</em><a name="69" href="#69">69</a> <em> * framework.</em><a name="70" href="#70">70</a> <em> *</em><a name="71" href="#71">71</a> <em> * @param name Name of this credential.</em><a name="72" href="#72">72</a> <em> */</em><a name="73" href="#73">73</a> <strong>public</strong> <a href="../../../../../org/archive/crawler/datamodel/credential/HtmlFormCredential.html">HtmlFormCredential</a>(<strong>final</strong> String name)<a name="74" href="#74">74</a> {<a name="75" href="#75">75</a> <strong>super</strong>(name, <span class="string">"Credential that has all necessary"</span> +<a name="76" href="#76">76</a> <span class="string">" for running a POST/GET to an HTML login form."</span>);<a name="77" href="#77">77</a> <a name="78" href="#78">78</a> <a href="../../../../../org/archive/crawler/settings/Type.html">Type</a> t = addElementToDefinition(<strong>new</strong> <a href="../../../../../org/archive/crawler/settings/SimpleType.html">SimpleType</a>(<span class="string">"login-uri"</span>,<a name="79" href="#79">79</a> <span class="string">"Full URI of page that contains the HTML login form we're to"</span> +<a name="80" href="#80">80</a> <span class="string">" apply these credentials too: E.g. http://www.archive.org"</span>, <span class="string">""</span>));<a name="81" href="#81">81</a> t.setOverrideable(false);<a name="82" href="#82">82</a> t.setExpertSetting(<strong>true</strong>);<a name="83" href="#83">83</a> <a name="84" href="#84">84</a> <a name="85" href="#85">85</a> t = addElementToDefinition(<strong>new</strong> <a href="../../../../../org/archive/crawler/settings/SimpleType.html">SimpleType</a>(ATTR_FORM_METHOD,<a name="86" href="#86">86</a> <span class="string">"GET or POST"</span>, METHODS[0], METHODS));<a name="87" href="#87">87</a> t.setOverrideable(false);<a name="88" href="#88">88</a> t.setExpertSetting(<strong>true</strong>);<a name="89" href="#89">89</a> <a name="90" href="#90">90</a> t = addElementToDefinition(<strong>new</strong> <a href="../../../../../org/archive/crawler/settings/MapType.html">MapType</a>(ATTR_FORM_ITEMS, <span class="string">"Form items."</span>,<a name="91" href="#91">91</a> String.<strong>class</strong>));<a name="92" href="#92">92</a> t.setOverrideable(false);<a name="93" href="#93">93</a> t.setExpertSetting(<strong>true</strong>);<a name="94" href="#94">94</a> }<a name="95" href="#95">95</a> <a name="96" href="#96">96</a> <em>/**<em>*</em></em><a name="97" href="#97">97</a> <em> * @param context CrawlURI context to use.</em><a name="98" href="#98">98</a> <em> * @return login-uri.</em><a name="99" href="#99">99</a> <em> * @throws AttributeNotFoundException</em><a name="100" href="#100">100</a> <em> */</em><a name="101" href="#101">101</a> <strong>public</strong> String getLoginUri(<strong>final</strong> <a href="../../../../../org/archive/crawler/datamodel/CrawlURI.html">CrawlURI</a> context)<a name="102" href="#102">102</a> throws AttributeNotFoundException {<a name="103" href="#103">103</a> <strong>return</strong> (String)getAttribute(ATTR_LOGIN_URI, context);<a name="104" href="#104">104</a> }<a name="105" href="#105">105</a> <a name="106" href="#106">106</a> <em>/**<em>*</em></em><a name="107" href="#107">107</a> <em> * @param context CrawlURI context to use.</em><a name="108" href="#108">108</a> <em> * @return login-uri.</em><a name="109" href="#109">109</a> <em> * @throws AttributeNotFoundException</em><a name="110" href="#110">110</a> <em> */</em><a name="111" href="#111">111</a> <strong>public</strong> String getHttpMethod(<strong>final</strong> <a href="../../../../../org/archive/crawler/datamodel/CrawlURI.html">CrawlURI</a> context)<a name="112" href="#112">112</a> throws AttributeNotFoundException {<a name="113" href="#113">113</a> <strong>return</strong> (String)getAttribute(ATTR_FORM_METHOD, context);<a name="114" href="#114">114</a> }<a name="115" href="#115">115</a> <a name="116" href="#116">116</a> <em>/**<em>*</em></em><a name="117" href="#117">117</a> <em> * @param context CrawlURI context to use.</em><a name="118" href="#118">118</a> <em> * @return Form inputs as convenient map. Returns null if no form items.</em><a name="119" href="#119">119</a> <em> * @throws AttributeNotFoundException</em><a name="120" href="#120">120</a> <em> */</em><a name="121" href="#121">121</a> <strong>public</strong> Map getFormItems(<strong>final</strong> <a href="../../../../../org/archive/crawler/datamodel/CrawlURI.html">CrawlURI</a> context)<a name="122" href="#122">122</a> throws AttributeNotFoundException {⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -