apis/openstack-nova/src/main/java/org/jclouds/openstack/nova/v2_0/extensions/FloatingIPApi.java

/*
 * 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.openstack.nova.v2_0.extensions;

import javax.inject.Named;
import javax.ws.rs.Consumes;
import javax.ws.rs.DELETE;
import javax.ws.rs.GET;
import javax.ws.rs.POST;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;
import javax.ws.rs.core.MediaType;

import org.jclouds.Fallbacks.EmptyFluentIterableOnNotFoundOr404;
import org.jclouds.Fallbacks.NullOnNotFoundOr404;
import org.jclouds.javax.annotation.Nullable;
import org.jclouds.openstack.keystone.auth.filters.AuthenticateRequest;
import org.jclouds.openstack.nova.v2_0.domain.FloatingIP;
import org.jclouds.openstack.v2_0.ServiceType;
import org.jclouds.openstack.v2_0.services.Extension;
import org.jclouds.rest.annotations.Fallback;
import org.jclouds.rest.annotations.Payload;
import org.jclouds.rest.annotations.PayloadParam;
import org.jclouds.rest.annotations.RequestFilters;
import org.jclouds.rest.annotations.SelectJson;

import com.google.common.annotations.Beta;
import com.google.common.collect.FluentIterable;

/**
 * Provides access to the OpenStack Compute (Nova) Floating IP extension API.
 */
@Beta
@Extension(of = ServiceType.COMPUTE, namespace = ExtensionNamespaces.FLOATING_IPS,
      name = ExtensionNames.FLOATING_IPS, alias = ExtensionAliases.FLOATING_IPS)
@RequestFilters(AuthenticateRequest.class)
@Consumes(MediaType.APPLICATION_JSON)
public interface FloatingIPApi {
   /**
    * Lists all Floating IP addresses
    *
    * @return all Floating IPs
    */
   @Named("floatingIP:list")
   @GET
   @Path("/os-floating-ips")
   @SelectJson("floating_ips")
   @Fallback(EmptyFluentIterableOnNotFoundOr404.class)
   FluentIterable<FloatingIP> list();

   /**
    * Gets a specific Floating IP address
    *
    * @return all Floating IPs
    */
   @Named("floatingIP:get")
   @GET
   @Path("/os-floating-ips/{id}")
   @SelectJson("floating_ip")
   @Fallback(NullOnNotFoundOr404.class)
   @Nullable
   FloatingIP get(@PathParam("id") String id);

   /**
    * Allocates a Floating IP address
    *
    * @return a newly created FloatingIP
    */
   @Named("floatingIP:create")
   @POST
   @Path("/os-floating-ips")
   @SelectJson("floating_ip")
   @Produces(MediaType.APPLICATION_JSON)
   @Payload("{}")
   @Nullable
   FloatingIP create();

   /**
    * Allocates a Floating IP address from a pool
    *
    * @param pool
    *         Pool to allocate IP address from
    * @return a newly created FloatingIP
    */
   @Named("floatingIP:allocateFromPool")
   @POST
   @Path("/os-floating-ips")
   @SelectJson("floating_ip")
   @Produces(MediaType.APPLICATION_JSON)
   @Payload("%7B\"pool\":\"{pool}\"%7D")
   @Nullable
   FloatingIP allocateFromPool(@PayloadParam("pool") String pool);

   /**
    * Deletes a Floating IP address
    *
    * @param id
    *           the Floating IP id
    */
   @Named("floatingIP:delete")
   @DELETE
   @Path("/os-floating-ips/{id}")
   void delete(@PathParam("id") String id);

   /**
    * Adds a Floating IP address to a Server
    *
    * @param serverId
    *           the server id
    * @param address
    *           the IP address to add
    *
    *           NOTE: Possibly move this to ServerApi?
    */
   @Named("floatingIP:add")
   @POST
   @Path("/servers/{id}/action")
   @Produces(MediaType.APPLICATION_JSON)
   @Payload("%7B\"addFloatingIp\":%7B\"address\":\"{address}\"%7D%7D")
   void addToServer(@PayloadParam("address") String address, @PathParam("id") String serverId);

   /**
    * Removes a Floating IP address from a Server
    *
    * @param serverId
    *           the server id
    * @param address
    *           the IP address to remove
    *
    *           NOTE: Possibly move this to ServerApi?
    */
   @Named("floatingIP:remove")
   @POST
   @Path("/servers/{id}/action")
   @Produces(MediaType.APPLICATION_JSON)
   @Payload("%7B\"removeFloatingIp\":%7B\"address\":\"{address}\"%7D%7D")
   void removeFromServer(@PayloadParam("address") String address, @PathParam("id") String serverId);
}