Adds a maven archetype for easier service implementation

httpchannel-service/httpchannel-service-archetype/pom.xml

@@ -0,0 +1,31 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+
+  <groupId>com.rogiel.httpchannel.services</groupId>
+  <artifactId>httpchannel-service-archetype</artifactId>
+  <version>1.0.1-SNAPSHOT</version>
+  <packaging>maven-archetype</packaging>
+
+  <name>HttpChannel/Service/Archetype</name>
+  <description>Provides an maven archetype for service creation</description>
+
+  <build>
+    <extensions>
+      <extension>
+        <groupId>org.apache.maven.archetype</groupId>
+        <artifactId>archetype-packaging</artifactId>
+        <version>2.2</version>
+      </extension>
+    </extensions>
+
+    <pluginManagement>
+      <plugins>
+        <plugin>
+          <artifactId>maven-archetype-plugin</artifactId>
+          <version>2.2</version>
+        </plugin>
+      </plugins>
+    </pluginManagement>
+  </build>
+</project>

httpchannel-service/httpchannel-service-archetype/src/main/resources/META-INF/maven/archetype-metadata.xml

@@ -0,0 +1,34 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<archetype-descriptor
+	xsi:schemaLocation="http://maven.apache.org/plugins/maven-archetype-plugin/archetype-descriptor/1.0.0 http://maven.apache.org/xsd/archetype-descriptor-1.0.0.xsd"
+	name="httpchannel-service-archetype"
+	xmlns="http://maven.apache.org/plugins/maven-archetype-plugin/archetype-descriptor/1.0.0"
+	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+	<fileSets>
+		<fileSet filtered="true" packaged="true" encoding="UTF-8">
+			<directory>src/main/java</directory>
+			<includes>
+				<include>**/*.java</include>
+			</includes>
+		</fileSet>
+		<fileSet encoding="UTF-8">
+			<directory>src/main/resources</directory>
+			<includes>
+				<include>**/*.Service</include>
+			</includes>
+		</fileSet>
+		<fileSet encoding="UTF-8">
+			<directory>.settings</directory>
+			<includes>
+				<include>**/*.prefs</include>
+			</includes>
+		</fileSet>
+		<fileSet filtered="true" encoding="UTF-8">
+			<directory></directory>
+			<includes>
+				<include>.classpath</include>
+				<include>.project</include>
+			</includes>
+		</fileSet>
+	</fileSets>
+</archetype-descriptor>

httpchannel-service/httpchannel-service-archetype/src/main/resources/archetype-resources/pom.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+	<modelVersion>4.0.0</modelVersion>
+	<parent>
+		<artifactId>httpchannel-service</artifactId>
+		<groupId>com.rogiel.httpchannel</groupId>
+		<version>1.0.1-SNAPSHOT</version>
+		<relativePath>..</relativePath>
+	</parent>
+	<artifactId>${artifactId}</artifactId>
+	<groupId>${groupId}</groupId>
+	<name>HttpChannel/Service/MyService</name>
+	<description>Provides an maven archetype for service creation</description>
+	<version>${version}</version>
+</project>

httpchannel-service/httpchannel-service-archetype/src/main/resources/archetype-resources/src/main/java/MyServiceService.java

@@ -0,0 +1,154 @@
+#set( $symbol_pound = '#' )
+#set( $symbol_dollar = '$' )
+#set( $symbol_escape = '\' )
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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 ${package};
+
+import java.io.IOException;
+import java.util.concurrent.ExecutionException;
+import java.util.concurrent.Future;
+
+import com.rogiel.httpchannel.service.AbstractHttpService;
+import com.rogiel.httpchannel.service.AbstractUploader;
+import com.rogiel.httpchannel.service.CapabilityMatrix;
+import com.rogiel.httpchannel.service.Service;
+import com.rogiel.httpchannel.service.ServiceID;
+import com.rogiel.httpchannel.service.ServiceMode;
+import com.rogiel.httpchannel.service.UploadChannel;
+import com.rogiel.httpchannel.service.UploadService;
+import com.rogiel.httpchannel.service.Uploader;
+import com.rogiel.httpchannel.service.UploaderCapability;
+import com.rogiel.httpchannel.service.channel.LinkedUploadChannel;
+import com.rogiel.httpchannel.service.channel.LinkedUploadChannel.LinkedUploadChannelCloseCallback;
+import com.rogiel.httpchannel.service.config.NullUploaderConfiguration;
+import com.rogiel.httpchannel.util.htmlparser.HTMLPage;
+
+/**
+ * This service handles uploads to MyService.com.
+ * 
+ * @author <a href="http://www.rogiel.com/">Rogiel</a>
+ * @since 1.0
+ */
+public class MyServiceService extends AbstractHttpService implements
+		Service, UploadService<NullUploaderConfiguration> {
+	/**
+	 * This service ID
+	 */
+	public static final ServiceID SERVICE_ID = ServiceID.create("myservice");
+
+	@Override
+	public ServiceID getServiceID() {
+		return SERVICE_ID;
+	}
+
+	@Override
+	public int getMajorVersion() {
+		return 1;
+	}
+
+	@Override
+	public int getMinorVersion() {
+		return 0;
+	}
+
+	@Override
+	public CapabilityMatrix<ServiceMode> getPossibleServiceModes() {
+		return new CapabilityMatrix<ServiceMode>(ServiceMode.UNAUTHENTICATED);
+	}
+
+	@Override
+	public Uploader<NullUploaderConfiguration> getUploader(String filename,
+			long filesize, NullUploaderConfiguration configuration) {
+		return new UploaderImpl(filename, filesize, configuration);
+	}
+
+	@Override
+	public Uploader<NullUploaderConfiguration> getUploader(String filename,
+			long filesize) {
+		return getUploader(filename, filesize, newUploaderConfiguration());
+	}
+
+	@Override
+	public NullUploaderConfiguration newUploaderConfiguration() {
+		// no configuration
+		return NullUploaderConfiguration.SHARED_INSTANCE;
+	}
+
+	@Override
+	public long getMaximumFilesize() {
+		// no filesize limit
+		return -1;
+	}
+
+	@Override
+	public String[] getSupportedExtensions() {
+		// no extension restriction
+		return null;
+	}
+
+	@Override
+	public CapabilityMatrix<UploaderCapability> getUploadCapabilities() {
+		return new CapabilityMatrix<UploaderCapability>(
+				UploaderCapability.UNAUTHENTICATED_UPLOAD);
+	}
+	
+	protected class UploaderImpl extends
+			AbstractUploader<NullUploaderConfiguration> implements
+			Uploader<NullUploaderConfiguration>,
+			LinkedUploadChannelCloseCallback {
+		private Future<HTMLPage> uploadFuture;
+
+		public UploaderImpl(String filename, long filesize,
+				NullUploaderConfiguration configuration) {
+			super(MyServiceService.this, filename, filesize, configuration);
+		}
+
+		@Override
+		public UploadChannel openChannel() throws IOException {
+			logger.debug("Starting upload to myservice.com");
+			final HTMLPage page = get("http://www.example.com/").asPage();
+			
+			// locate upload uri
+			String uri = null;
+			
+			logger.debug("Upload URI: {}", uri);
+
+			// create a new channel
+			final LinkedUploadChannel channel = createLinkedChannel(this);
+			uploadFuture = multipartPost(uri).parameter("[file-parameter]", channel).asPageAsync();
+			
+			// wait for channel link
+			return waitChannelLink(channel, uploadFuture);
+		}
+
+		@Override
+		public String finish() throws IOException {
+			try {
+				final HTMLPage page = uploadFuture.get();
+				// find link
+				return null;
+			} catch (InterruptedException e) {
+				return null;
+			} catch (ExecutionException e) {
+				throw (IOException) e.getCause();
+			}
+		}
+	}
+}

httpchannel-service/httpchannel-service-archetype/src/main/resources/archetype-resources/src/main/resources/META-INF/services/com.rogiel.httpchannel.service.Service

@@ -0,0 +1 @@
+com.rogiel.httpchannel.service.impl.MyService

httpchannel-service/httpchannel-service-archetype/src/test/resources/projects/basic/archetype.properties

@@ -0,0 +1,5 @@
+#Wed Jan 18 19:02:46 BRST 2012
+package=it.pkg
+version=0.1-SNAPSHOT
+groupId=archetype.it
+artifactId=basic

httpchannel-service/httpchannel-service-depositfiles/pom.xml

@@ -1,4 +1,5 @@
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
 	<modelVersion>4.0.0</modelVersion>
 	<parent>
 		<artifactId>httpchannel-service</artifactId>

httpchannel-service/pom.xml

@@ -13,6 +13,7 @@
 	<description>Parent module that all service implementations should inherit</description>
 
 	<modules>
+		<module>httpchannel-service-archetype</module>
 		<module>httpchannel-service-megaupload</module>
 		<module>httpchannel-service-multiupload</module>
 		<module>httpchannel-service-uploadking</module>

httpchannel-service/src/main/archetype-resources/pom.xml

@@ -0,0 +1,16 @@
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+	<modelVersion>4.0.0</modelVersion>
+	<parent>
+		<artifactId>httpchannel-service</artifactId>
+		<groupId>com.rogiel.httpchannel</groupId>
+		<version>1.0.1-SNAPSHOT</version>
+		<relativePath>..</relativePath>
+	</parent>
+	<groupId>${groupId}</groupId>
+	<artifactId>${artifactId}</artifactId>
+	<version>${version}</version>
+	<packaging>jar</packaging>
+	<name>HttpChannel/Service/MyService</name>
+	<description>Provides upload access to myservice.com</description>
+</project>

httpchannel-service/src/main/archetype-resources/src/main/java/com/rogiel/httpchannel/service/impl/MyService.java

@@ -0,0 +1,153 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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 com.rogiel.httpchannel.service.impl;
+
+import java.io.IOException;
+import java.util.concurrent.ExecutionException;
+import java.util.concurrent.Future;
+import java.util.regex.Pattern;
+
+import com.rogiel.httpchannel.captcha.ImageCaptcha;
+import com.rogiel.httpchannel.captcha.ReCaptchaExtractor;
+import com.rogiel.httpchannel.captcha.exception.UnsolvableCaptchaServiceException;
+import com.rogiel.httpchannel.service.AbstractAuthenticator;
+import com.rogiel.httpchannel.service.AbstractHttpService;
+import com.rogiel.httpchannel.service.AbstractUploader;
+import com.rogiel.httpchannel.service.AuthenticationService;
+import com.rogiel.httpchannel.service.Authenticator;
+import com.rogiel.httpchannel.service.AuthenticatorCapability;
+import com.rogiel.httpchannel.service.CapabilityMatrix;
+import com.rogiel.httpchannel.service.Credential;
+import com.rogiel.httpchannel.service.Service;
+import com.rogiel.httpchannel.service.ServiceID;
+import com.rogiel.httpchannel.service.ServiceMode;
+import com.rogiel.httpchannel.service.UploadChannel;
+import com.rogiel.httpchannel.service.UploadService;
+import com.rogiel.httpchannel.service.Uploader;
+import com.rogiel.httpchannel.service.UploaderCapability;
+import com.rogiel.httpchannel.service.channel.LinkedUploadChannel;
+import com.rogiel.httpchannel.service.channel.LinkedUploadChannel.LinkedUploadChannelCloseCallback;
+import com.rogiel.httpchannel.service.config.NullAuthenticatorConfiguration;
+import com.rogiel.httpchannel.service.config.NullUploaderConfiguration;
+import com.rogiel.httpchannel.service.exception.AuthenticationInvalidCredentialException;
+import com.rogiel.httpchannel.util.htmlparser.HTMLPage;
+
+/**
+ * This service handles uploads to MyService.com.
+ * 
+ * @author <a href="http://www.rogiel.com/">Rogiel</a>
+ * @since 1.0
+ */
+public class DepositFilesService extends AbstractHttpService implements
+		Service, UploadService<NullUploaderConfiguration> {
+	/**
+	 * This service ID
+	 */
+	public static final ServiceID SERVICE_ID = ServiceID.create("myservice");
+
+	@Override
+	public ServiceID getServiceID() {
+		return SERVICE_ID;
+	}
+
+	@Override
+	public int getMajorVersion() {
+		return 1;
+	}
+
+	@Override
+	public int getMinorVersion() {
+		return 0;
+	}
+
+	@Override
+	public CapabilityMatrix<ServiceMode> getPossibleServiceModes() {
+		return new CapabilityMatrix<ServiceMode>(ServiceMode.UNAUTHENTICATED);
+	}
+
+	@Override
+	public Uploader<NullUploaderConfiguration> getUploader(String filename,
+			long filesize, NullUploaderConfiguration configuration) {
+		return new UploaderImpl(filename, filesize, configuration);
+	}
+
+	@Override
+	public Uploader<NullUploaderConfiguration> getUploader(String filename,
+			long filesize) {
+		return getUploader(filename, filesize, newUploaderConfiguration());
+	}
+
+	@Override
+	public NullUploaderConfiguration newUploaderConfiguration() {
+		// no configuration
+		return NullUploaderConfiguration.SHARED_INSTANCE;
+	}
+
+	@Override
+	public long getMaximumFilesize() {
+		// no limit
+		return -1;
+	}
+
+	@Override
+	public String[] getSupportedExtensions() {
+		// all extensions
+		return null;
+	}
+
+	@Override
+	public CapabilityMatrix<UploaderCapability> getUploadCapabilities() {
+		return new CapabilityMatrix<UploaderCapability>(
+				UploaderCapability.UNAUTHENTICATED_UPLOAD,
+				UploaderCapability.NON_PREMIUM_ACCOUNT_UPLOAD,
+				UploaderCapability.PREMIUM_ACCOUNT_UPLOAD);
+	}
+
+	protected class UploaderImpl extends
+			AbstractUploader<NullUploaderConfiguration> implements
+			Uploader<NullUploaderConfiguration>,
+			LinkedUploadChannelCloseCallback {
+		private Future<HTMLPage> uploadFuture;
+
+		public UploaderImpl(String filename, long filesize,
+				NullUploaderConfiguration configuration) {
+			super(DepositFilesService.this, filename, filesize, configuration);
+		}
+
+		@Override
+		public UploadChannel openChannel() throws IOException {
+			// TODO start upload
+			final LinkedUploadChannel channel = createLinkedChannel(this);
+			// TODO execute upload post
+			return waitChannelLink(channel, uploadFuture);
+		}
+
+		@Override
+		public String finish() throws IOException {
+			try {
+				final HTMLPage page = uploadFuture.get();
+				// return download link here
+			} catch (InterruptedException e) {
+				return null;
+			} catch (ExecutionException e) {
+				throw (IOException) e.getCause();
+			}
+		}
+	}
+}

httpchannel-service/src/main/archetype-resources/src/main/resources/META-INF/services/com.rogiel.httpchannel.service.Service

@@ -0,0 +1 @@
+com.rogiel.httpchannel.service.impl.MyService

httpchannel-service/src/main/resources/META-INF/maven/archetype-metadata.xml

@@ -0,0 +1,13 @@
+<archetype-descriptor
+	xmlns="http://maven.apache.org/plugins/maven-archetype-plugin/archetype-descriptor/1.0.0"
+	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+	xsi:schemaLocation="http://maven.apache.org/plugins/maven-archetype-plugin/archetype-descriptor/1.0.0 http://maven.apache.org/xsd/archetype-descriptor-1.0.0.xsd">
+	<id>httpchannel-service</id>
+	<sources>
+		<source>src/main/java/com/rogiel/httpchannel/service/impl/MyService.java
+		</source>
+	</sources>
+	<resources>
+		<resource>src/main/resources/META-INF/services/com.rogiel.httpchannel.service.Service</resource>
+	</resources>
+</archetype-descriptor>