Extracted utility functions from IsoToIMachine.

sandbox-apis/virtualbox/src/main/java/org/jclouds/virtualbox/MachineUtils.java

@@ -0,0 +1,104 @@
+/*
+ * Licensed to jclouds, Inc. (jclouds) under one or more
+ * contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  jclouds 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 org.jclouds.virtualbox;
+
+import com.google.common.base.Function;
+import org.virtualbox_4_1.*;
+
+/**
+ * Utilities for executing functions on a VirtualBox machine.
+ *
+ * @author Adrian Cole, Mattias Holmqvist
+ */
+public class MachineUtils {
+
+   public static <T> T applyForMachine(VirtualBoxManager manager, final String machineId, final Function<IMachine, T> function) {
+      final IMachine immutableMachine = manager.getVBox().findMachine(machineId);
+      return new Function<IMachine, T>() {
+         @Override
+         public T apply(IMachine machine) {
+            return function.apply(machine);
+         }
+
+         @Override
+         public String toString() {
+            return function.toString();
+         }
+      }.apply(immutableMachine);
+   }
+
+   /**
+    * Locks the machine and executes the given function using the machine matching the given id.
+    * Since the machine is locked it is possible to perform some modifications to the IMachine.
+    * <p/>
+    * Unlocks the machine before returning.
+    *
+    * @param manager   the VirtualBoxManager
+    * @param type      the kind of lock to use when initially locking the machine.
+    * @param machineId the id of the machine
+    * @param function  the function to execute
+    * @return the result from applying the function to the machine.
+    */
+   public static <T> T lockMachineAndApply(VirtualBoxManager manager, final LockType type, final String machineId,
+                                           final Function<IMachine, T> function) {
+      return lockSessionOnMachineAndApply(manager, type, machineId, new Function<ISession, T>() {
+
+         @Override
+         public T apply(ISession session) {
+            return function.apply(session.getMachine());
+         }
+
+         @Override
+         public String toString() {
+            return function.toString();
+         }
+
+      });
+   }
+
+   /**
+    * Locks the machine and executes the given function using the current session.
+    * Since the machine is locked it is possible to perform some modifications to the IMachine.
+    * <p/>
+    * Unlocks the machine before returning.
+    *
+    * @param manager   the VirtualBoxManager
+    * @param type      the kind of lock to use when initially locking the machine.
+    * @param machineId the id of the machine
+    * @param function  the function to execute
+    * @return the result from applying the function to the session.
+    */
+   public static <T> T lockSessionOnMachineAndApply(VirtualBoxManager manager, LockType type, String machineId,
+                                                    Function<ISession, T> function) {
+      try {
+         ISession session = manager.getSessionObject();
+         IMachine immutableMachine = manager.getVBox().findMachine(machineId);
+         immutableMachine.lockMachine(session, type);
+         try {
+            return function.apply(session);
+         } finally {
+            session.unlockMachine();
+         }
+      } catch (VBoxException e) {
+         throw new RuntimeException(String.format("error applying %s to %s with %s lock: %s", function, machineId,
+                 type, e.getMessage()), e);
+      }
+   }
+}

sandbox-apis/virtualbox/src/main/java/org/jclouds/virtualbox/functions/IsoToIMachine.java

@@ -41,6 +41,7 @@ import java.io.File;
 import static com.google.common.base.Preconditions.checkNotNull;
 import static org.jclouds.compute.options.RunScriptOptions.Builder.runAsRoot;
 import static org.jclouds.compute.options.RunScriptOptions.Builder.wrapInInitScript;
+import static org.jclouds.virtualbox.MachineUtils.*;
 import static org.jclouds.virtualbox.config.VirtualBoxConstants.VIRTUALBOX_INSTALLATION_KEY_SEQUENCE;
 import static org.jclouds.virtualbox.config.VirtualBoxConstants.VIRTUALBOX_WORKINGDIR;
 import static org.virtualbox_4_1.AccessMode.ReadOnly;
@@ -222,55 +223,6 @@ public class IsoToIMachine implements Function<String, IMachine> {
               new AddIDEControllerIfNotExists(checkNotNull(controllerIDE, "controllerIDE")));
    }
 
-   private <T> T applyForMachine(VirtualBoxManager manager, final String machineId, final Function<IMachine, T> function) {
-      final IMachine immutableMachine = manager.getVBox().findMachine(machineId);
-      return new Function<IMachine, T>() {
-         @Override
-         public T apply(IMachine machine) {
-            return function.apply(machine);
-         }
-
-         @Override
-         public String toString() {
-            return function.toString();
-         }
-      }.apply(immutableMachine);
-   }
-
-   public static <T> T lockMachineAndApply(VirtualBoxManager manager, final LockType type, final String machineId,
-                                           final Function<IMachine, T> function) {
-      return lockSessionOnMachineAndApply(manager, type, machineId, new Function<ISession, T>() {
-
-         @Override
-         public T apply(ISession session) {
-            return function.apply(session.getMachine());
-         }
-
-         @Override
-         public String toString() {
-            return function.toString();
-         }
-
-      });
-
-   }
-
-   public static <T> T lockSessionOnMachineAndApply(VirtualBoxManager manager, LockType type, String machineId,
-                                                    Function<ISession, T> function) {
-      try {
-         ISession session = manager.getSessionObject();
-         IMachine immutableMachine = manager.getVBox().findMachine(machineId);
-         immutableMachine.lockMachine(session, type);
-         try {
-            return function.apply(session);
-         } finally {
-            session.unlockMachine();
-         }
-      } catch (VBoxException e) {
-         throw new RuntimeException(String.format("error applying %s to %s with %s lock: %s", function, machineId,
-                 type, e.getMessage()), e);
-      }
-   }
 
    private String defaultInstallSequence() {
       return "<Esc><Esc><Enter> "