cloudstack registerSSHKeyPair implementation

sandbox-apis/cloudstack/src/main/java/org/jclouds/cloudstack/features/SSHKeyPairAsyncClient.java

@@ -18,13 +18,13 @@
  */
 package org.jclouds.cloudstack.features;
 
-import java.util.Set;
-
 import javax.ws.rs.Consumes;
 import javax.ws.rs.GET;
 import javax.ws.rs.QueryParam;
 import javax.ws.rs.core.MediaType;
+import java.util.Set;
 
+import com.google.common.util.concurrent.ListenableFuture;
 import org.jclouds.cloudstack.domain.SshKeyPair;
 import org.jclouds.cloudstack.filters.QuerySigner;
 import org.jclouds.cloudstack.options.ListSSHKeyPairsOptions;
@@ -37,8 +37,6 @@ import org.jclouds.rest.functions.ReturnEmptySetOnNotFoundOr404;
 import org.jclouds.rest.functions.ReturnNullOnNotFoundOr404;
 import org.jclouds.rest.functions.ReturnVoidOnNotFoundOr404;
 
-import com.google.common.util.concurrent.ListenableFuture;
-
 /**
  * Provides asynchronous access to CloudStack SSHKeyPair features.
  *
@@ -60,6 +58,15 @@ public interface SSHKeyPairAsyncClient {
    @ExceptionParser(ReturnEmptySetOnNotFoundOr404.class)
    ListenableFuture<Set<SshKeyPair>> listSSHKeyPairs(ListSSHKeyPairsOptions... options);
 
+  /**
+    * @see SSHKeyPairClient#registerSSHKeyPair
+    */
+   @GET
+   @QueryParams(keys = "command", values = "registerSSHKeyPair")
+   @SelectJson("keypair")
+   @Consumes(MediaType.APPLICATION_JSON)
+   ListenableFuture<SshKeyPair> registerSSHKeyPair(@QueryParam("name") String name, @QueryParam("publickey") String publicKey);
+
    /**
     * @see SSHKeyPairClient#createSSHKeyPair
     */

sandbox-apis/cloudstack/src/main/java/org/jclouds/cloudstack/features/SSHKeyPairClient.java

@@ -29,28 +29,36 @@ import org.jclouds.concurrent.Timeout;
 /**
  * Provides synchronous access to CloudStack SSHKeyPair features.
  *
+ * @author Vijay Kiran
  * @see <a
  *      href="http://download.cloud.com/releases/2.2.0/api_2.2.8/TOC_User.html"
  *      />
- * @author Vijay Kiran
  */
 @Timeout(duration = 60, timeUnit = TimeUnit.SECONDS)
 public interface SSHKeyPairClient {
    /**
     * Returns a list of {@link SshKeyPair}s registered by current user.
     *
-    * @param options
+    * @param options if present, how to constrain the list
-    *           if present, how to constrain the list
     * @return Set of {@link SshKeyPair}s matching the current constrains or
     *         empty set if no SshKeyPairs found.
     */
    Set<SshKeyPair> listSSHKeyPairs(ListSSHKeyPairsOptions... options);
 
+
+   /**
+    * Registers a {@link SshKeyPair} with the given name and  public kay material.
+    *
+    * @param name      of the keypair
+    * @param publicKey Public key material of the keypair
+    * @return Created SshKeyPair.
+    */
+   SshKeyPair registerSSHKeyPair(String name, String publicKey);
+
    /**
     * Creates a {@link SshKeyPair} with specified name.
     *
-    * @param name
+    * @param name of the SshKeyPair.
-    *           of the SshKeyPair.
     * @return Created SshKeyPair.
     */
    SshKeyPair createSSHKeyPair(String name);
@@ -58,8 +66,7 @@ public interface SSHKeyPairClient {
    /**
     * Retrieves the {@link SSHKeyPairClient} with given name.
     *
-    * @param name
+    * @param name name of the key pair
-    *           name of the key pair
     * @return SSH Key pair or null if not found.
     */
    SshKeyPair getSSHKeyPair(String name);
@@ -67,8 +74,7 @@ public interface SSHKeyPairClient {
    /**
     * Deletes the {@link SSHKeyPairClient} with given name.
     *
-    * @param name
+    * @param name name of the key pair
-    *           name of the key pair
     * @return
     */
    void deleteSSHKeyPair(String name);

sandbox-apis/cloudstack/src/test/java/org/jclouds/cloudstack/features/SSHKeyPairAsyncClientTest.java

@@ -20,21 +20,23 @@ package org.jclouds.cloudstack.features;
 
 import java.io.IOException;
 import java.lang.reflect.Method;
+import java.net.URLEncoder;
 
+import com.google.common.base.Functions;
+import com.google.inject.TypeLiteral;
 import org.jclouds.cloudstack.options.ListSSHKeyPairsOptions;
+import org.jclouds.crypto.SshKeys;
 import org.jclouds.functions.IdentityFunction;
 import org.jclouds.http.HttpRequest;
 import org.jclouds.http.functions.ParseFirstJsonValueNamed;
 import org.jclouds.http.functions.ReleasePayloadAndReturn;
+import org.jclouds.rest.functions.MapHttp4xxCodesToExceptions;
 import org.jclouds.rest.functions.ReturnEmptySetOnNotFoundOr404;
 import org.jclouds.rest.functions.ReturnNullOnNotFoundOr404;
 import org.jclouds.rest.functions.ReturnVoidOnNotFoundOr404;
 import org.jclouds.rest.internal.RestAnnotationProcessor;
 import org.testng.annotations.Test;
 
-import com.google.common.base.Functions;
-import com.google.inject.TypeLiteral;
-
 /**
  * Tests behavior of {@code SSHKeyPairAsyncClient}
  *
@@ -95,6 +97,25 @@ public class SSHKeyPairAsyncClientTest extends BaseCloudStackAsyncClientTest<SSH
 
    }
 
+   public void testRegisterSSHKeyPair() throws SecurityException, NoSuchMethodException, IOException {
+      Method method = SSHKeyPairAsyncClient.class.getMethod("registerSSHKeyPair", String.class, String.class);
+      String publicKey = URLEncoder.encode(SshKeys.generate().get("public"), "UTF-8");
+      HttpRequest httpRequest = processor.createRequest(method, "jclouds-keypair", publicKey);
+      assertRequestLineEquals(httpRequest,
+            "GET http://localhost:8080/client/api?response=json&command=registerSSHKeyPair&name=jclouds-keypair&publickey="
+                  + publicKey
+                  + " HTTP/1.1");
+      assertNonPayloadHeadersEqual(httpRequest, "Accept: application/json\n");
+      assertPayloadEquals(httpRequest, null, null, false);
+
+      assertResponseParserClassEquals(method, httpRequest, ParseFirstJsonValueNamed.class);
+      assertSaxResponseParserClassEquals(method, null);
+      assertExceptionParserClassEquals(method, MapHttp4xxCodesToExceptions.class);
+
+      checkFilters(httpRequest);
+   }
+
+
    public void testDeleteSSHKeyPair() throws SecurityException, NoSuchMethodException, IOException {
       Method method = SSHKeyPairAsyncClient.class.getMethod("deleteSSHKeyPair", String.class);
       HttpRequest httpRequest = processor.createRequest(method, "jclouds-keypair");
@@ -112,6 +133,7 @@ public class SSHKeyPairAsyncClientTest extends BaseCloudStackAsyncClientTest<SSH
 
    }
 
+
    @Override
    protected TypeLiteral<RestAnnotationProcessor<SSHKeyPairAsyncClient>> createTypeLiteral() {
       return new TypeLiteral<RestAnnotationProcessor<SSHKeyPairAsyncClient>>() {

sandbox-apis/cloudstack/src/test/java/org/jclouds/cloudstack/features/SSHKeyPairClientLiveTest.java

@@ -23,6 +23,7 @@ import static org.testng.Assert.assertEquals;
 import java.util.Set;
 
 import org.jclouds.cloudstack.domain.SshKeyPair;
+import org.jclouds.crypto.SshKeys;
 import org.testng.annotations.Test;
 
 /**
@@ -52,6 +53,18 @@ public class SSHKeyPairClientLiveTest extends BaseCloudStackClientLiveTest {
       sshKeyPair = null;
    }
 
+   public void testRegisterDeleteSSHKeyPair() {
+      final String publickey = SshKeys.generate().get("public");
+      sshKeyPair = client.getSSHKeyPairClient().registerSSHKeyPair(prefix + "jclouds-keypair", publickey);
+      checkSSHKeyPair(sshKeyPair);
+      client.getSSHKeyPairClient().deleteSSHKeyPair(sshKeyPair.getName());
+      assertEquals(client.getSSHKeyPairClient().getSSHKeyPair(sshKeyPair.getName()), null);
+      // Set the keypair to null , if the delete test is passed.
+      sshKeyPair = null;
+
+   }
+
+
    protected void checkSSHKeyPair(SshKeyPair pair) {
       assert pair.getName() != null : pair;
       assertEquals(pair.toString(), client.getSSHKeyPairClient().getSSHKeyPair(pair.getName()).toString());