org.jclouds.digitalocean2.features.RegionApi Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jclouds-shaded Show documentation
Provides a shaded jclouds with relocated guava and guice
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.digitalocean2.features;

import java.beans.ConstructorProperties;
import java.io.Closeable;
import java.net.URI;
import java.util.List;

import javax.inject.Inject;
import javax.inject.Named;
import javax.ws.rs.Consumes;
import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.core.MediaType;

import org.jclouds.Fallbacks.EmptyIterableWithMarkerOnNotFoundOr404;
import org.jclouds.Fallbacks.EmptyPagedIterableOnNotFoundOr404;
import org.jclouds.collect.IterableWithMarker;
import org.jclouds.collect.PagedIterable;
import org.jclouds.digitalocean2.DigitalOcean2Api;
import org.jclouds.digitalocean2.domain.Region;
import org.jclouds.digitalocean2.domain.internal.PaginatedCollection;
import org.jclouds.digitalocean2.domain.options.ListOptions;
import org.jclouds.digitalocean2.functions.BaseToPagedIterable;
import org.jclouds.http.functions.ParseJson;
import org.jclouds.json.Json;
import org.jclouds.oauth.v2.filters.OAuthFilter;
import org.jclouds.rest.annotations.Fallback;
import org.jclouds.rest.annotations.RequestFilters;
import org.jclouds.rest.annotations.ResponseParser;
import org.jclouds.rest.annotations.Transform;

import shaded.com.google.common.base.Function;
import shaded.com.google.common.base.Optional;
import shaded.com.google.inject.TypeLiteral;

/**
 * Provides access to Regions via the REST API.
 */
@Path("/regions")
@RequestFilters(OAuthFilter.class)
@Consumes(MediaType.APPLICATION_JSON)
public interface RegionApi extends Closeable {

   /**
    * Get the list of all regions.
    * 
    * @return The (paginated) list of all regions.
    */
   @Named("region:list")
   @GET
   @ResponseParser(ParseRegions.class)
   @Transform(ParseRegions.ToPagedIterable.class)
   @Fallback(EmptyPagedIterableOnNotFoundOr404.class)
   PagedIterable list();

   /**
    * Get a single page of the region list.
    * 
    * @param options The options to configure the page to get and the size of the page.
    * @return The page with the requested regions.
    */
   @Named("region:list")
   @GET
   @ResponseParser(ParseRegions.class)
   @Fallback(EmptyIterableWithMarkerOnNotFoundOr404.class)
   IterableWithMarker list(ListOptions options);

   static final class ParseRegions extends ParseJson {
      @Inject ParseRegions(Json json) {
         super(json, TypeLiteral.get(Regions.class));
      }

      private static class Regions extends PaginatedCollection {
         @ConstructorProperties({ "regions", "meta", "links" })
         public Regions(List items, Meta meta, Links links) {
            super(items, meta, links);
         }
      }

      static class ToPagedIterable extends BaseToPagedIterable {
         @Inject ToPagedIterable(DigitalOcean2Api api, Function linkToOptions) {
            super(api, linkToOptions);
         }

         @Override
         protected IterableWithMarker fetchPageUsingOptions(ListOptions options, Optional