Issue 112: separated out terremark from default vcloud implementation

git-svn-id: http://jclouds.googlecode.com/svn/trunk@2243 3d8758e0-26b5-11de-8745-db77d3ebf521

vcloud/core/src/main/java/org/jclouds/vcloud/terremark/TerremarkVCloudClient.java

@@ -0,0 +1,65 @@
+/**
+ *
+ * Copyright (C) 2009 Cloud Conscious, LLC. <info@cloudconscious.com>
+ *
+ * ====================================================================
+ * 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 org.jclouds.vcloud.terremark;
+
+import static org.jclouds.vcloud.VCloudMediaType.VDC_XML;
+
+import javax.ws.rs.Consumes;
+import javax.ws.rs.GET;
+
+import org.jclouds.rest.annotations.Endpoint;
+import org.jclouds.rest.annotations.RequestFilters;
+import org.jclouds.rest.annotations.XMLResponseParser;
+import org.jclouds.vcloud.VCloudClient;
+import org.jclouds.vcloud.domain.VDC;
+import org.jclouds.vcloud.filters.SetVCloudTokenCookie;
+import org.jclouds.vcloud.terremark.xml.TerremarkVDCHandler;
+
+/**
+ * Provides access to VCloud resources via their REST API.
+ * <p/>
+ * 
+ * @see <a href="https://community.vcloudexpress.terremark.com/en-us/discussion_forums/f/60.aspx" />
+ * @author Adrian Cole
+ */
+@RequestFilters(SetVCloudTokenCookie.class)
+public interface TerremarkVCloudClient extends VCloudClient {
+
+
+   @GET
+   @Endpoint(org.jclouds.vcloud.endpoints.VDC.class)
+   @XMLResponseParser(TerremarkVDCHandler.class)
+   @Consumes(VDC_XML)
+   VDC getDefaultVDC();
+
+   //   
+   // @GET
+   // @Endpoint(vDC.class)
+   // public Set<String> getvDCs();
+   //
+   // @GET
+   // @Endpoint(TasksList.class)
+   // public Set<String> getTasksLists();
+
+}

vcloud/core/src/main/java/org/jclouds/vcloud/terremark/TerremarkVCloudContextBuilder.java

@@ -0,0 +1,84 @@
+/**
+ *
+ * Copyright (C) 2009 Cloud Conscious, LLC. <info@cloudconscious.com>
+ *
+ * ====================================================================
+ * 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 org.jclouds.vcloud.terremark;
+
+import java.util.List;
+import java.util.Properties;
+import java.util.concurrent.ExecutorService;
+
+import org.jclouds.http.config.JavaUrlHttpCommandExecutorServiceModule;
+import org.jclouds.logging.jdk.config.JDKLoggingModule;
+import org.jclouds.rest.RestContext;
+import org.jclouds.rest.RestContextBuilder;
+import org.jclouds.vcloud.VCloudClient;
+import org.jclouds.vcloud.config.VCloudDiscoveryRestClientModule;
+import org.jclouds.vcloud.terremark.config.TerremarkVCloudContextModule;
+import org.jclouds.vcloud.terremark.config.TerremarkVCloudRestClientModule;
+
+import com.google.inject.Module;
+import com.google.inject.TypeLiteral;
+
+/**
+ * Creates {@link RestContext} for {@link VCloudClient} instances based on the most commonly
+ * requested arguments.
+ * <p/>
+ * Note that Threadsafe objects will be bound as singletons to the Injector or Context provided.
+ * <p/>
+ * <p/>
+ * If no <code>Module</code>s are specified, the default {@link JDKLoggingModule logging} and
+ * {@link JavaUrlHttpCommandExecutorServiceModule http transports} will be installed.
+ * 
+ * @author Adrian Cole
+ * @see RestContext
+ * @see VCloudClient
+ */
+public class TerremarkVCloudContextBuilder extends RestContextBuilder<TerremarkVCloudClient> {
+
+   public TerremarkVCloudContextBuilder(Properties props) {
+      super(new TypeLiteral<TerremarkVCloudClient>() {
+      }, props);
+   }
+
+   @Override
+   protected void addClientModule(List<Module> modules) {
+      modules.add(new VCloudDiscoveryRestClientModule());
+      modules.add(new TerremarkVCloudRestClientModule());
+   }
+
+   @Override
+   protected void addContextModule(List<Module> modules) {
+      modules.add(new TerremarkVCloudContextModule());
+   }
+
+   @Override
+   public TerremarkVCloudContextBuilder withExecutorService(ExecutorService service) {
+      return (TerremarkVCloudContextBuilder) super.withExecutorService(service);
+   }
+
+   @Override
+   public TerremarkVCloudContextBuilder withModules(Module... modules) {
+      return (TerremarkVCloudContextBuilder) super.withModules(modules);
+   }
+
+}

vcloud/core/src/main/java/org/jclouds/vcloud/terremark/TerremarkVCloudPropertiesBuilder.java

@@ -0,0 +1,54 @@
+/**
+ *
+ * Copyright (C) 2009 Cloud Conscious, LLC. <info@cloudconscious.com>
+ *
+ * ====================================================================
+ * 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 org.jclouds.vcloud.terremark;
+
+import static org.jclouds.vcloud.reference.VCloudConstants.PROPERTY_VCLOUD_ENDPOINT;
+
+import java.net.URI;
+import java.util.Properties;
+
+import org.jclouds.vcloud.VCloudPropertiesBuilder;
+
+/**
+ * Builds properties used in Terremark VCloud Clients
+ * 
+ * @author Adrian Cole
+ */
+public class TerremarkVCloudPropertiesBuilder extends VCloudPropertiesBuilder {
+   @Override
+   protected Properties defaultProperties() {
+      Properties properties = super.defaultProperties();
+      properties.setProperty(PROPERTY_VCLOUD_ENDPOINT,
+               "https://services.vcloudexpress.terremark.com/api/v0.8");
+      return properties;
+   }
+
+   public TerremarkVCloudPropertiesBuilder(Properties properties) {
+      super(properties);
+   }
+
+   public TerremarkVCloudPropertiesBuilder(String id, String secret) {
+      super(URI.create("https://services.vcloudexpress.terremark.com/api/v0.8"), id, secret);
+   }
+}

vcloud/core/src/main/java/org/jclouds/vcloud/terremark/config/TerremarkVCloudContextModule.java

@@ -0,0 +1,57 @@
+/**
+ *
+ * Copyright (C) 2009 Cloud Conscious, LLC. <info@cloudconscious.com>
+ *
+ * ====================================================================
+ * 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 org.jclouds.vcloud.terremark.config;
+
+import java.net.URI;
+
+import javax.inject.Named;
+import javax.inject.Singleton;
+
+import org.jclouds.lifecycle.Closer;
+import org.jclouds.rest.RestContext;
+import org.jclouds.rest.internal.RestContextImpl;
+import org.jclouds.vcloud.endpoints.Org;
+import org.jclouds.vcloud.reference.VCloudConstants;
+import org.jclouds.vcloud.terremark.TerremarkVCloudClient;
+
+import com.google.inject.AbstractModule;
+import com.google.inject.Provides;
+
+/**
+ * @author Adrian Cole
+ */
+public class TerremarkVCloudContextModule extends AbstractModule {
+   @Override
+   protected void configure() {
+   }
+
+   @Provides
+   @Singleton
+   RestContext<TerremarkVCloudClient> provideContext(Closer closer,
+            TerremarkVCloudClient defaultApi, @Org URI endPoint,
+            @Named(VCloudConstants.PROPERTY_VCLOUD_USER) String account) {
+      return new RestContextImpl<TerremarkVCloudClient>(closer, defaultApi, endPoint, account);
+   }
+
+}

vcloud/core/src/main/java/org/jclouds/vcloud/terremark/config/TerremarkVCloudRestClientModule.java

@@ -0,0 +1,57 @@
+/**
+ *
+ * Copyright (C) 2009 Cloud Conscious, LLC. <info@cloudconscious.com>
+ *
+ * ====================================================================
+ * 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 org.jclouds.vcloud.terremark.config;
+
+import javax.inject.Singleton;
+
+import org.jclouds.http.RequiresHttp;
+import org.jclouds.rest.ConfiguresRestClient;
+import org.jclouds.rest.RestClientFactory;
+import org.jclouds.vcloud.VCloudClient;
+import org.jclouds.vcloud.config.VCloudRestClientModule;
+import org.jclouds.vcloud.terremark.TerremarkVCloudClient;
+
+import com.google.inject.Provides;
+
+/**
+ * Configures the VCloud authentication service connection, including logging and http transport.
+ * 
+ * @author Adrian Cole
+ */
+@RequiresHttp
+@ConfiguresRestClient
+public class TerremarkVCloudRestClientModule extends VCloudRestClientModule {
+
+   @Provides
+   @Singleton
+   protected TerremarkVCloudClient provideTerremarkVCloudClient(VCloudClient in) {
+      return (TerremarkVCloudClient) in;
+   }
+
+   @Override
+   protected VCloudClient provideVCloudClient(RestClientFactory factory) {
+      return factory.create(TerremarkVCloudClient.class);
+   }
+
+}

vcloud/core/src/test/java/org/jclouds/vcloud/VCloudClientLiveTest.java

@@ -44,8 +44,8 @@ import org.testng.annotations.Test;
 @Test(groups = "live", sequential = true, testName = "vcloud.VCloudClientLiveTest")
 public class VCloudClientLiveTest {
 
-   private VCloudClient connection;
-   private String account;
+   protected VCloudClient connection;
+   protected String account;
 
    @Test
    public void testOrganization() throws Exception {

vcloud/core/src/test/java/org/jclouds/vcloud/terremark/TerremarkVCloudClientLiveTest.java

@@ -0,0 +1,62 @@
+/**
+ *
+ * Copyright (C) 2009 Cloud Conscious, LLC. <info@cloudconscious.com>
+ *
+ * ====================================================================
+ * 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 org.jclouds.vcloud.terremark;
+
+import static com.google.common.base.Preconditions.checkNotNull;
+import static org.testng.Assert.assertNotNull;
+
+import org.jclouds.logging.log4j.config.Log4JLoggingModule;
+import org.jclouds.vcloud.VCloudClientLiveTest;
+import org.jclouds.vcloud.terremark.domain.TerremarkVDC;
+import org.testng.annotations.BeforeGroups;
+import org.testng.annotations.Test;
+
+/**
+ * Tests behavior of {@code TerremarkVCloudClient}
+ * 
+ * @author Adrian Cole
+ */
+@Test(groups = "live", sequential = true, testName = "vcloud.TerremarkVCloudClientLiveTest")
+public class TerremarkVCloudClientLiveTest extends VCloudClientLiveTest {
+
+   @Test
+   public void testDefaultVDC() throws Exception {
+      super.testDefaultVDC();
+      TerremarkVDC response = (TerremarkVDC) connection.getDefaultVDC();
+      assertNotNull(response);
+      assertNotNull(response.getCatalog());
+      assertNotNull(response.getInternetServices());
+      assertNotNull(response.getPublicIps());
+   }
+
+   @BeforeGroups(groups = { "live" })
+   @Override
+   public void setupClient() {
+      account = checkNotNull(System.getProperty("jclouds.test.user"), "jclouds.test.user");
+      String key = checkNotNull(System.getProperty("jclouds.test.key"), "jclouds.test.key");
+      connection = new TerremarkVCloudContextBuilder(new TerremarkVCloudPropertiesBuilder(account,
+               key).build()).withModules(new Log4JLoggingModule()).buildContext().getApi();
+   }
+
+}

vcloud/core/src/test/java/org/jclouds/vcloud/terremark/TerremarkVCloudClientTest.java

@@ -0,0 +1,111 @@
+/**
+ *
+ * Copyright (C) 2009 Cloud Conscious, LLC. <info@cloudconscious.com>
+ *
+ * ====================================================================
+ * 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 org.jclouds.vcloud.terremark;
+
+import static org.testng.Assert.assertEquals;
+
+import java.io.IOException;
+import java.lang.reflect.Method;
+import java.net.URI;
+
+import javax.inject.Provider;
+
+import org.jclouds.http.functions.ParseSax;
+import org.jclouds.logging.Logger;
+import org.jclouds.logging.Logger.LoggerFactory;
+import org.jclouds.rest.RestClientTest;
+import org.jclouds.rest.internal.GeneratedHttpRequest;
+import org.jclouds.rest.internal.RestAnnotationProcessor;
+import org.jclouds.vcloud.endpoints.Catalog;
+import org.jclouds.vcloud.endpoints.VDC;
+import org.jclouds.vcloud.filters.SetVCloudTokenCookie;
+import org.jclouds.vcloud.terremark.xml.TerremarkVDCHandler;
+import org.testng.annotations.Test;
+
+import com.google.inject.AbstractModule;
+import com.google.inject.Module;
+import com.google.inject.TypeLiteral;
+
+/**
+ * Tests behavior of {@code TerremarkVCloudClient}
+ * 
+ * @author Adrian Cole
+ */
+@Test(groups = "unit", testName = "vcloud.TerremarkVCloudClientTest")
+public class TerremarkVCloudClientTest extends RestClientTest<TerremarkVCloudClient> {
+
+   public void testGetDefaultVDC() throws SecurityException, NoSuchMethodException, IOException {
+      Method method = TerremarkVCloudClient.class.getMethod("getDefaultVDC");
+      GeneratedHttpRequest<TerremarkVCloudClient> httpMethod = processor.createRequest(method);
+
+      assertRequestLineEquals(httpMethod, "GET http://vdc HTTP/1.1");
+      assertHeadersEqual(httpMethod, "Accept: application/vnd.vmware.vcloud.vdc+xml\n");
+      assertEntityEquals(httpMethod, null);
+
+      assertResponseParserClassEquals(method, httpMethod, ParseSax.class);
+      assertSaxResponseParserClassEquals(method, TerremarkVDCHandler.class);
+      assertExceptionParserClassEquals(method, null);
+
+      checkFilters(httpMethod);
+   }
+
+   @Override
+   protected void checkFilters(GeneratedHttpRequest<TerremarkVCloudClient> httpMethod) {
+      assertEquals(httpMethod.getFilters().size(), 1);
+      assertEquals(httpMethod.getFilters().get(0).getClass(), SetVCloudTokenCookie.class);
+   }
+
+   @Override
+   protected TypeLiteral<RestAnnotationProcessor<TerremarkVCloudClient>> createTypeLiteral() {
+      return new TypeLiteral<RestAnnotationProcessor<TerremarkVCloudClient>>() {
+      };
+   }
+
+   @Override
+   protected Module createModule() {
+      return new AbstractModule() {
+         @Override
+         protected void configure() {
+            bind(URI.class).annotatedWith(Catalog.class).toInstance(URI.create("http://catalog"));
+            bind(URI.class).annotatedWith(VDC.class).toInstance(URI.create("http://vdc"));
+            bind(SetVCloudTokenCookie.class).toInstance(
+                     new SetVCloudTokenCookie(new Provider<String>() {
+
+                        public String get() {
+                           return "token";
+                        }
+
+                     }));
+
+            bind(Logger.LoggerFactory.class).toInstance(new LoggerFactory() {
+               public Logger getLogger(String category) {
+                  return Logger.NULL;
+               }
+            });
+         }
+
+      };
+   }
+
+}