<a name="119" href="#119">119</a> <a name="120" href="#120">120</a>     <em>/**<em>*</em></em><a name="121" href="#121">121</a> <em>     * Regex for acceptable user-agent format.</em><a name="122" href="#122">122</a> <em>     */</em><a name="123" href="#123">123</a>     <strong>private</strong> <strong>static</strong> String ACCEPTABLE_USER_AGENT =<a name="124" href="#124">124</a>         <span class="string">"&#47;&#47;S+.*&#47;&#47;(.*&#47;&#47;+http(s)?://&#47;&#47;S+&#47;&#47;.&#47;&#47;S+.*&#47;&#47;).*"</span>;<a name="125" href="#125">125</a> <a name="126" href="#126">126</a>     <em>/**<em>*</em></em><a name="127" href="#127">127</a> <em>     * Regex for acceptable from address.</em><a name="128" href="#128">128</a> <em>     */</em><a name="129" href="#129">129</a>     <strong>private</strong> <strong>static</strong> String ACCEPTABLE_FROM = <span class="string">"&#47;&#47;S+@&#47;&#47;S+&#47;&#47;.&#47;&#47;S+"</span>;<a name="130" href="#130">130</a>     <a name="131" href="#131">131</a> <a name="132" href="#132">132</a>     <em>/**<em>* Construct a CrawlOrder.</em></em><a name="133" href="#133">133</a> <em>     */</em><a name="134" href="#134">134</a>     <strong>public</strong> <a href="../../../../org/archive/crawler/datamodel/CrawlOrder.html">CrawlOrder</a>() {<a name="135" href="#135">135</a>         <strong>super</strong>(ATTR_NAME, <span class="string">"Heritrix crawl order. This forms the root of "</span> +<a name="136" href="#136">136</a>                 <span class="string">"the settings framework."</span>);<a name="137" href="#137">137</a>         <a href="../../../../org/archive/crawler/settings/Type.html">Type</a> e;<a name="138" href="#138">138</a> <a name="139" href="#139">139</a>         e = addElementToDefinition(<strong>new</strong> <a href="../../../../org/archive/crawler/settings/SimpleType.html">SimpleType</a>(ATTR_SETTINGS_DIRECTORY,<a name="140" href="#140">140</a>                 <span class="string">"Directory where override settings are kept. The settings "</span> +<a name="141" href="#141">141</a>                 <span class="string">"for many modules can be overridden based on the domain or "</span> +<a name="142" href="#142">142</a>                 <span class="string">"subdomain of the URI being processed. This setting specifies"</span> +<a name="143" href="#143">143</a>                 <span class="string">" a file level directory to store those settings. The path"</span> +<a name="144" href="#144">144</a>                 <span class="string">" is relative to 'disk-path' unless"</span> +<a name="145" href="#145">145</a>                 <span class="string">" an absolute path is provided."</span>, <span class="string">"settings"</span>));<a name="146" href="#146">146</a>         e.setOverrideable(false);<a name="147" href="#147">147</a>         e.setExpertSetting(<strong>true</strong>);<a name="148" href="#148">148</a> <a name="149" href="#149">149</a>         e = addElementToDefinition(<strong>new</strong> <a href="../../../../org/archive/crawler/settings/SimpleType.html">SimpleType</a>(ATTR_DISK_PATH,<a name="150" href="#150">150</a>                 <span class="string">"Directory where logs, arcs and other run time files will "</span> +<a name="151" href="#151">151</a>                 <span class="string">"be kept. If this path is a relative path, it will be "</span> +<a name="152" href="#152">152</a>                 <span class="string">"relative to the crawl order."</span>, <span class="string">""</span>));<a name="153" href="#153">153</a>         e.setOverrideable(false);<a name="154" href="#154">154</a>         e.setExpertSetting(<strong>true</strong>);<a name="155" href="#155">155</a> <a name="156" href="#156">156</a>         e = addElementToDefinition(<strong>new</strong> <a href="../../../../org/archive/crawler/settings/SimpleType.html">SimpleType</a>(ATTR_LOGS_PATH,<a name="157" href="#157">157</a>                 <span class="string">"Directory where crawler log files will be kept. If this path "</span> +<a name="158" href="#158">158</a>                 <span class="string">"is a relative path, it will be relative to the 'disk-path'."</span>,<a name="159" href="#159">159</a>                 <span class="string">"logs"</span>));<a name="160" href="#160">160</a>         e.setOverrideable(false);<a name="161" href="#161">161</a>         e.setExpertSetting(<strong>true</strong>);<a name="162" href="#162">162</a> <a name="163" href="#163">163</a>         e = addElementToDefinition(<strong>new</strong> <a href="../../../../org/archive/crawler/settings/SimpleType.html">SimpleType</a>(ATTR_CHECKPOINTS_PATH,<a name="164" href="#164">164</a>                 <span class="string">"Directory where crawler checkpoint files will be kept. "</span> +<a name="165" href="#165">165</a>                 <span class="string">"If this path "</span> +<a name="166" href="#166">166</a>                 <span class="string">"is a relative path, it will be relative to the 'disk-path'."</span>,<a name="167" href="#167">167</a>                 <span class="string">"checkpoints"</span>));<a name="168" href="#168">168</a>         e.setOverrideable(false);<a name="169" href="#169">169</a>         e.setExpertSetting(<strong>true</strong>);<a name="170" href="#170">170</a> <a name="171" href="#171">171</a>         e = addElementToDefinition(<strong>new</strong> <a href="../../../../org/archive/crawler/settings/SimpleType.html">SimpleType</a>(ATTR_STATE_PATH,<a name="172" href="#172">172</a>                 <span class="string">"Directory where crawler-state files will be kept. If this path "</span> +<a name="173" href="#173">173</a>                 <span class="string">"is a relative path, it will be relative to the 'disk-path'."</span>,<a name="174" href="#174">174</a>                 <span class="string">"state"</span>));<a name="175" href="#175">175</a>         e.setOverrideable(false);<a name="176" href="#176">176</a>         e.setExpertSetting(<strong>true</strong>);<a name="177" href="#177">177</a> <a name="178" href="#178">178</a>         e = addElementToDefinition(<strong>new</strong> <a href="../../../../org/archive/crawler/settings/SimpleType.html">SimpleType</a>(ATTR_SCRATCH_PATH,<a name="179" href="#179">179</a>                 <span class="string">"Directory where discardable temporary files will be kept. "</span> +<a name="180" href="#180">180</a>                 <span class="string">"If this path "</span> +<a name="181" href="#181">181</a>                 <span class="string">"is a relative path, it will be relative to the 'disk-path'."</span>,<a name="182" href="#182">182</a>                 <span class="string">"scratch"</span>));<a name="183" href="#183">183</a>         e.setOverrideable(false);<a name="184" href="#184">184</a>         e.setExpertSetting(<strong>true</strong>);<a name="185" href="#185">185</a> <a name="186" href="#186">186</a>         e = addElementToDefinition(<strong>new</strong> <a href="../../../../org/archive/crawler/settings/SimpleType.html">SimpleType</a>(ATTR_MAX_BYTES_DOWNLOAD,<a name="187" href="#187">187</a>                 <span class="string">"Maximum number of bytes to download. Once this number is"</span> +<a name="188" href="#188">188</a>                 <span class="string">" exceeded the crawler will stop. "</span> +<a name="189" href="#189">189</a>                 <span class="string">"A value of zero means no upper limit."</span>, <strong>new</strong> Long(0)));<a name="190" href="#190">190</a>         e.setOverrideable(false);<a name="191" href="#191">191</a> <a name="192" href="#192">192</a>         e = addElementToDefinition(<strong>new</strong> <a href="../../../../org/archive/crawler/settings/SimpleType.html">SimpleType</a>(ATTR_MAX_DOCUMENT_DOWNLOAD,<a name="193" href="#193">193</a>                 <span class="string">"Maximum number of documents to download. Once this number"</span> +<a name="194" href="#194">194</a>                 <span class="string">" is exceeded the crawler will stop. "</span> +<a name="195" href="#195">195</a>                 <span class="string">"A value of zero means no upper limit."</span>, <strong>new</strong> Long(0)));<a name="196" href="#196">196</a>         e.setOverrideable(false);<a name="197" href="#197">197</a> <a name="198" href="#198">198</a>         e = addElementToDefinition(<strong>new</strong> <a href="../../../../org/archive/crawler/settings/SimpleType.html">SimpleType</a>(ATTR_MAX_TIME_SEC,<a name="199" href="#199">199</a>                 <span class="string">"Maximum amount of time to crawl (in seconds). Once this"</span> +<a name="200" href="#200">200</a>                 <span class="string">" much time has elapsed the crawler will stop. A value of"</span> +<a name="201" href="#201">201</a>                 <span class="string">" zero means no upper limit."</span>,<a name="202" href="#202">202</a>                 <strong>new</strong> Long(0)));<a name="203" href="#203">203</a>         e.setOverrideable(false);<a name="204" href="#204">204</a>         <a name="205" href="#205">205</a>         e = addElementToDefinition(<strong>new</strong> <a href="../../../../org/archive/crawler/settings/SimpleType.html">SimpleType</a>(ATTR_MAX_TOE_THREADS,<a name="206" href="#206">206</a>                 <span class="string">"Maximum number of threads processing URIs at the same time."</span>,<a name="207" href="#207">207</a>                 <strong>new</strong> Integer(100)));<a name="208" href="#208">208</a>         e.setOverrideable(false);<a name="209" href="#209">209</a> <a name="210" href="#210">210</a>         e = addElementToDefinition(<strong>new</strong> <a href="../../../../org/archive/crawler/settings/SimpleType.html">SimpleType</a>(ATTR_RECORDER_OUT_BUFFER,<a name="211" href="#211">211</a>                 <span class="string">"Size in bytes of in-memory buffer to record outbound "</span> +<a name="212" href="#212">212</a>                 <span class="string">"traffic. One such buffer is reserved for every ToeThread."</span>,<a name="213" href="#213">213</a>                 <strong>new</strong> Integer(4096)));<a name="214" href="#214">214</a>         e.setOverrideable(false);<a name="215" href="#215">215</a>         e.setExpertSetting(<strong>true</strong>);<a name="216" href="#216">216</a>         <a name="217" href="#217">217</a>         e = addElementToDefinition(<strong>new</strong> <a href="../../../../org/archive/crawler/settings/SimpleType.html">SimpleType</a>(ATTR_RECORDER_IN_BUFFER,<a name="218" href="#218">218</a>                 <span class="string">"Size in bytes of in-memory buffer to record inbound "</span> +<a name="219" href="#219">219</a>                 <span class="string">"traffic. One such buffer is reserved for every ToeThread."</span>,<a name="220" href="#220">220</a>                 <strong>new</strong> Integer(65536)));<a name="221" href="#221">221</a>         e.setOverrideable(false);<a name="222" href="#222">222</a>         e.setExpertSetting(<strong>true</strong>);<a name="223" href="#223">223</a>         <a name="224" href="#224">224</a>         e = addElementToDefinition(<strong>new</strong> <a href="../../../../org/archive/crawler/settings/SimpleType.html">SimpleType</a>(ATTR_BDB_CACHE_PERCENT,<a name="225" href="#225">225</a>                 <span class="string">"Percentage of heap to allocate to BerkeleyDB JE cache. "</span> +<a name="226" href="#226">226</a>                 <span class="string">"Default of zero means no preference (accept BDB's default, "</span> +<a name="227" href="#227">227</a>                 <span class="string">"usually 60%, or the je.maxMemoryPercent property value)."</span>,<a name="228" href="#228">228</a>                 DEFAULT_BDB_CACHE_PERCENT));<a name="229" href="#229">229</a>         e.setExpertSetting(<strong>true</strong>);<a name="230" href="#230">230</a>         e.setOverrideable(false);<a name="231" href="#231">231</a>         <a name="232" href="#232">232</a>         addElementToDefinition(<strong>new</strong> <a href="../../../../org/archive/crawler/framework/CrawlScope.html">CrawlScope</a>());<a name="233" href="#233">233</a> <a name="234" href="#234">234</a>         httpHeaders = (MapType) addElementToDefinition(<strong>new</strong> MapType(<a name="235" href="#235">235</a>                 ATTR_HTTP_HEADERS, <span class="string">"HTTP headers. Information that will "</span> +<a name="236" href="#236">236</a>                         <span class="string">"be used when constructing the HTTP headers of "</span> +<a name="237" href="#237">237</a>                         <span class="string">"the crawler's HTTP requests."</span>));<a name="238" href="#238">238</a> <a name="239" href="#239">239</a>         e = httpHeaders.addElementToDefinition(<strong>new</strong> <a href="../../../../org/archive/crawler/settings/SimpleType.html">SimpleType</a>(ATTR_USER_AGENT,<a name="240" href="#240">240</a>                 <span class="string">"User agent to act as. Field must contain valid URL "</span> +<a name="241" href="#241">241</a>                 <span class="string">"that links to website of person or organization "</span> +<a name="242" href="#242">242</a>                 <span class="string">"running the crawl. Replace 'PROJECT_URL_HERE' in "</span> +<a name="243" href="#243">243</a>                 <span class="string">"initial template. E.g. If organization "</span> +<a name="244" href="#244">244</a>                 <span class="string">"is Library of Congress, a valid user agent would be:"</span> +<a name="245" href="#245">245</a>                 <span class="string">"'Mozilla/5.0 (compatible; loc-crawler/0.11.0 "</span> +