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