a5f2c1d3a7f1fb57f3bbf30c083cd8af8810313f
[utils] / crawler / basic / src / main / java / org / wamblee / crawler / Crawler.java
1 /*
2  * Copyright 2005 the original author or authors.
3  * 
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  * 
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  * 
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */ 
16
17 package org.wamblee.crawler;
18
19 import org.apache.commons.httpclient.NameValuePair;
20
21
22 /**
23  * The object that actually obtains pages based on URL. 
24  *
25  * @author Erik Brakkee
26  */
27 public interface Crawler {
28
29     /**
30      * Gets the content for a specific page. 
31      * @param aUrl Url of page. 
32      * @param aParameters Paremeters to supply. 
33      * @return Page to retrieve.
34      * @throws PageException In case of problems retrieving the page.
35      */
36     Page getPage(String aUrl, NameValuePair[] aParameters) throws PageException;
37     
38     /**
39      * Gets the content for a specific page. 
40      * @param aUrl Url of page.
41      * @param aParameters Parameters to supply. 
42      * @param aType Type of page.  
43      * @return Page.
44      * @throws PageException In case of problems retrieving the page. 
45      */
46     Page getPage(String aUrl, NameValuePair[] aParameters, PageType aType) throws PageException; 
47 }