Issue 125:payload binder

core/src/main/java/org/jclouds/rest/annotations/Payload.java

@@ -0,0 +1,44 @@
+/**
+ *
+ * Copyright (C) 2010 Cloud Conscious, LLC. <info@cloudconscious.com>
+ *
+ * ====================================================================
+ * 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.jclouds.rest.annotations;
+
+import static java.lang.annotation.ElementType.METHOD;
+import static java.lang.annotation.RetentionPolicy.RUNTIME;
+
+import java.lang.annotation.Retention;
+import java.lang.annotation.Target;
+
+import javax.ws.rs.Path;
+
+/**
+ * Designates that this parameter will hold the payload for a PUT or POST command.
+ * 
+ * @author Adrian Cole
+ */
+@Target(METHOD)
+@Retention(RUNTIME)
+public @interface Payload {
+
+   /**
+    * @see Path#value()
+    * @see PayloadParam
+    */
+   String value();
+}

core/src/main/java/org/jclouds/rest/annotations/PayloadParam.java

@@ -0,0 +1,42 @@
+/**
+ *
+ * Copyright (C) 2010 Cloud Conscious, LLC. <info@cloudconscious.com>
+ *
+ * ====================================================================
+ * 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.jclouds.rest.annotations;
+
+import static java.lang.annotation.ElementType.PARAMETER;
+import static java.lang.annotation.RetentionPolicy.RUNTIME;
+
+import java.lang.annotation.Retention;
+import java.lang.annotation.Target;
+
+/**
+ * Designates that this parameter will hold the payload for a PUT or POST command.
+ * 
+ * @author Adrian Cole
+ */
+@Target(PARAMETER)
+@Retention(RUNTIME)
+public @interface PayloadParam {
+
+   /**
+    * The key used in a map passed to the {@link MapBinder} or {@link Payload} associated with the
+    * request.
+    */
+   String value();
+}

core/src/main/java/org/jclouds/rest/annotations/PayloadParams.java

@@ -0,0 +1,48 @@
+/**
+ *
+ * Copyright (C) 2010 Cloud Conscious, LLC. <info@cloudconscious.com>
+ *
+ * ====================================================================
+ * 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.jclouds.rest.annotations;
+
+import static java.lang.annotation.ElementType.METHOD;
+import static java.lang.annotation.ElementType.TYPE;
+import static java.lang.annotation.RetentionPolicy.RUNTIME;
+
+import java.lang.annotation.Retention;
+import java.lang.annotation.Target;
+
+import javax.ws.rs.QueryParam;
+
+/**
+ * Designates that default parameters will be added a map that builds the request entity.
+ * 
+ * @see QueryParam
+ * @see Payload
+ * @see MapBinder
+ * @author Adrian Cole
+ */
+@Target( { TYPE, METHOD })
+@Retention(RUNTIME)
+public @interface PayloadParams {
+
+   public static final String NULL = "MAP_PAYLOAD_NULL";
+
+   String[] keys();
+
+   String[] values() default NULL;
+}

core/src/main/java/org/jclouds/rest/binders/BindMapToStringPayload.java

@@ -0,0 +1,64 @@
+/**
+ *
+ * Copyright (C) 2010 Cloud Conscious, LLC. <info@cloudconscious.com>
+ *
+ * ====================================================================
+ * 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.jclouds.rest.binders;
+
+import java.net.URI;
+import java.util.Map;
+
+import javax.inject.Inject;
+import javax.inject.Provider;
+import javax.inject.Singleton;
+import javax.ws.rs.core.UriBuilder;
+
+import org.jclouds.http.HttpRequest;
+import org.jclouds.io.Payloads;
+import org.jclouds.rest.MapBinder;
+import org.jclouds.rest.annotations.Payload;
+import org.jclouds.rest.internal.GeneratedHttpRequest;
+
+/**
+ * 
+ * @author Adrian Cole
+ */
+@Singleton
+public class BindMapToStringPayload implements MapBinder {
+   protected final Provider<UriBuilder> uriBuilders;
+
+   @Inject
+   public BindMapToStringPayload(Provider<UriBuilder> uriBuilders) {
+      this.uriBuilders = uriBuilders;
+   }
+
+   @SuppressWarnings("unchecked")
+   @Override
+   public <R extends HttpRequest> R bindToRequest(R request, Map<String, String> postParams) {
+      GeneratedHttpRequest<?> r = GeneratedHttpRequest.class.cast( request);
+      UriBuilder builder = uriBuilders.get();
+      builder.path(r.getJavaMethod().getAnnotation(Payload.class).value());
+      URI fake = builder.buildFromMap(postParams);
+      return (R) request.toBuilder().payload(Payloads.newStringPayload(fake.getPath())).build();
+   }
+
+   @Override
+   public <R extends HttpRequest> R bindToRequest(R request, Object payload) {
+      throw new IllegalArgumentException("this is a map binder");
+   }
+
+}