(no commit message)
[utils] / crawler / basic / src / org / wamblee / crawler / PageRequest.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.HttpClient;
20 import org.w3c.dom.Document;
21
22 /**
23  * Represents a specific request to obtain and transform a page. 
24  */
25 public interface PageRequest {
26     
27     /**
28      * Gets a page as an XML document.
29      * @param aUrl Url of the page.  
30      * @param aClient Http client to use. 
31      * @return Client. 
32      * @throws PageException In case of problems retrieving the page. 
33      */
34      Document execute(String aUrl, HttpClient aClient) throws PageException;
35      
36      /**
37       * Overrides the Xslt to use. This is used when the transformed page specifies
38       * the page type explicitly for an action.
39       * @param aXslt Xslt to use. 
40       */
41      void overrideXslt(String aXslt); 
42 }