Migration to maven almost complete. At least everything builds and works

[utils] / crawler / basic / src / main / java / org / wamblee / crawler / PageRequest.java

diff --git a/crawler/basic/src/main/java/org/wamblee/crawler/PageRequest.java b/crawler/basic/src/main/java/org/wamblee/crawler/PageRequest.java
new file mode 100644 (file)
index 0000000..be72906
--- /dev/null
+++ b/crawler/basic/src/main/java/org/wamblee/crawler/PageRequest.java
@@ -0,0 +1,44 @@
+/*
+ * Copyright 2005 the original author or authors.
+ * 
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * 
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */ 
+
+package org.wamblee.crawler;
+
+import org.apache.commons.httpclient.HttpClient;
+import org.apache.commons.httpclient.NameValuePair;
+import org.w3c.dom.Document;
+
+/**
+ * Represents a specific request to obtain and transform a page. 
+ */
+public interface PageRequest {
+    
+    /**
+     * Gets a page as an XML document.
+     * @param aUrl Url of the page.  
+     * @param aParams Additional parameters to supply. 
+     * @param aClient Http client to use. 
+     * @return Client. 
+     * @throws PageException In case of problems retrieving the page. 
+     */
+     Document execute(String aUrl, NameValuePair[] aParams, HttpClient aClient) throws PageException;
+     
+     /**
+      * Overrides the Xslt to use. This is used when the transformed page specifies
+      * the page type explicitly for an action.
+      * @param aXslt Xslt to use. 
+      */
+     void overrideXslt(String aXslt); 
+}