org.jclouds.rest.config.BinderUtils Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jclouds-core Show documentation
Core components to access jclouds services
The newest version!
/*
 * 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.rest.config;

import com.google.common.reflect.TypeParameter;
import com.google.common.reflect.TypeToken;
import com.google.inject.Binder;
import com.google.inject.TypeLiteral;

import org.jclouds.util.TypeToken2;
import org.jclouds.util.TypeToken2.TypeParameter2;

/**
 * 
 * @author Adrian Cole
 */
public class BinderUtils {

   /**
    * adds an explicit binding for {@code async} by parsing its annotations.
    * 
    * @param 
    *           sync interface that blocks
    * @param 
    *           api type with http annotations
    * @param binder
    *           guice binder
    * @param api
    *           type with http annotations
    */
   public static  void bindHttpApi(Binder binder, Class api) {
      bindClass(binder, api);
      bindAnnotatedHttpApiProvider(binder, api);
   }
   
   @SuppressWarnings({ "unchecked", "serial" })
   private static  void bindAnnotatedHttpApiProvider(Binder binder, Class annotated) {
      TypeToken> token = new TypeToken>() {
      }.where(new TypeParameter() {
      }, annotated);
      binder.bind(annotated).toProvider(TypeLiteral.class.cast(TypeLiteral.get(token.getType())));
   }

   /**
    * adds an explicit binding for {@code async} by parsing its annotations. Then, adds an explicit binding for an
    * interface which synchronously blocks on similar calls to an {@code async} type.
    * 
    * @param 
    *           sync interface that blocks
    * @param 
    *           async type where all methods have same args as {@code sync}, but returns {@link ListenableFuture}
    * @param binder
    *           guice binder
    * @param sync
    *           type interface that blocks
    * @param async
    *           type type that returns {@link ListenableFuture}
    * 
    * @deprecated will be removed in jclouds 1.7, as async interfaces are no
    *             longer supported.
    */
   @Deprecated
   public static  void bindSyncToAsyncHttpApi(Binder binder, Class sync, Class async) {
      bindClass(binder, sync);
      bindClass(binder, async);
      bindAnnotatedSyncToAsyncHttpApiProvider(binder, async);
      bindHttpApiProvider(binder, sync, async);
   }

   /**
    * @deprecated will be removed in jclouds 1.7, as async interfaces are no
    *             longer supported.
    */
   @Deprecated
   @SuppressWarnings({ "unchecked", "serial" })
   private static  void bindAnnotatedSyncToAsyncHttpApiProvider(Binder binder, Class annotated) {
      TypeToken> token = new TypeToken>() {
      }.where(new TypeParameter() {
      }, annotated);
      binder.bind(annotated).toProvider(TypeLiteral.class.cast(TypeLiteral.get(token.getType())));
   }

   /**
    * 
    * @deprecated will be removed in jclouds 1.7, as async interfaces are no
    *             longer supported.
    */
   @Deprecated
   @SuppressWarnings({ "unchecked", "serial" })
   private static  void bindHttpApiProvider(Binder binder, Class sync, Class async) {
      TypeToken> token = new TypeToken2>() {
      }.where(new TypeParameter2() {
      }, sync, new TypeParameter2() {
      }, async);
      binder.bind(sync).toProvider(TypeLiteral.class.cast(TypeLiteral.get(token.getType())));
   }

   /**
    * adds an explicit binding for an interface which synchronously blocks on
    * similar calls to an {@code async} type.
    * 
    * @param 
    *           sync interface that blocks
    * @param 
    *           async type where all methods have same args as {@code sync}, but
    *           returns {@link ListenableFuture}
    * @param binder
    *           guice binder
    * @param sync
    *           type interface that blocks
    * @param async
    *           type type that returns {@link ListenableFuture}
    * 
    * @deprecated will be removed in jclouds 1.7, as async interfaces are no
    *             longer supported.
    */
   @Deprecated
   public static  void bindSyncToAsyncApi(Binder binder, Class sync, Class async) {
      bindClass(binder, sync);
      bindClass(binder, async);
      bindCallGetOnFutures(binder, sync, async);
   }

   /**
    * @deprecated will be removed in jclouds 1.7, as async interfaces are no
    *             longer supported.
    */
   @Deprecated
   @SuppressWarnings({ "unchecked", "serial" })
   private static  void bindCallGetOnFutures(Binder binder, Class sync, Class async) {
      TypeToken> token = new TypeToken2>() {
      }.where(new TypeParameter2() {
      }, sync, new TypeParameter2() {
      }, async);
      binder.bind(sync).toProvider(TypeLiteral.class.cast(TypeLiteral.get(token.getType())));
   }

   @SuppressWarnings({ "unchecked", "serial" })
   private static  void bindClass(Binder binder, Class sync) {
      binder.bind(TypeLiteral.class.cast(TypeLiteral.get(new TypeToken>() {
      }.where(new TypeParameter() {
      }, sync).getType()))).toInstance(sync);
   }
}