org.jclouds.elb.features.InstanceApi Maven / Gradle / Ivy

Go to download
/*
 * 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.elb.features;

import static org.jclouds.aws.reference.FormParameters.ACTION;

import java.util.Set;

import javax.inject.Named;
import javax.ws.rs.FormParam;
import javax.ws.rs.POST;
import javax.ws.rs.Path;

import org.jclouds.Fallbacks.EmptySetOnNotFoundOr404;
import org.jclouds.aws.filters.FormSigner;
import org.jclouds.elb.binders.BindInstanceIdsToIndexedFormParams;
import org.jclouds.elb.domain.InstanceHealth;
import org.jclouds.elb.xml.DescribeInstanceHealthResultHandler;
import org.jclouds.elb.xml.InstancesResultHandler;
import org.jclouds.rest.annotations.BinderParam;
import org.jclouds.rest.annotations.Fallback;
import org.jclouds.rest.annotations.FormParams;
import org.jclouds.rest.annotations.RequestFilters;
import org.jclouds.rest.annotations.VirtualHost;
import org.jclouds.rest.annotations.XMLResponseParser;

/**
 * Provides access to Amazon ELB via the Query API
 * 
 * 
 * @see doc
 */
@RequestFilters(FormSigner.class)
@VirtualHost
public interface InstanceApi {

   /**
    * Returns the current state of the instances of the specified LoadBalancer.
    * 
    * 
Note
    * 
    * The api must have created the specified input LoadBalancer in order to retrieve this
    * information; the api must provide the same account credentials as those that were used to
    * create the LoadBalancer.
    * 
    * @param loadBalancerName
    *           The name associated with the LoadBalancer. The name must be unique within the api
    *           AWS account.
    * 
    * @return state of all instances of the load balancer
    */
   @Named("DescribeInstanceHealth")
   @POST
   @Path("/")
   @XMLResponseParser(DescribeInstanceHealthResultHandler.class)
   @Fallback(EmptySetOnNotFoundOr404.class)
   @FormParams(keys = "Action", values = "DescribeInstanceHealth")
   Set getHealthOfInstancesOfLoadBalancer(
            @FormParam("LoadBalancerName") String loadBalancerName);

   /**
    * Returns the current state of the instances of the specified LoadBalancer.
    * 
    * Note
    * 
    * The api must have created the specified input LoadBalancer in order to retrieve this
    * information; the api must provide the same account credentials as those that were used to
    * create the LoadBalancer.
    * 
    * @param instanceIds
    *           A list of instance IDs whose states are being queried.
    * @param loadBalancerName
    *           The name associated with the LoadBalancer. The name must be unique within the api
    *           AWS account.
    * 
    * @return state of all instances of the load balancer
    */
   @Named("DescribeInstanceHealth")
   @POST
   @Path("/")
   @XMLResponseParser(DescribeInstanceHealthResultHandler.class)
   @Fallback(EmptySetOnNotFoundOr404.class)
   @FormParams(keys = "Action", values = "DescribeInstanceHealth")
   Set getHealthOfInstancesOfLoadBalancer(
            @BinderParam(BindInstanceIdsToIndexedFormParams.class) Iterable instanceIds,
            @FormParam("LoadBalancerName") String loadBalancerName);


   /**
    * Adds new instances to the LoadBalancer.
    * 
    * Once the instance is registered, it starts receiving traffic and requests from the
    * LoadBalancer. Any instance that is not in any of the Availability Zones registered for the
    * LoadBalancer will be moved to the OutOfService state. It will move to the InService state when
    * the Availability Zone is added to the LoadBalancer.
    * 
    * Note
    * 
    * In order for this call to be successful, the api must have created the LoadBalancer. The
    * api must provide the same account credentials as those that were used to create the
    * LoadBalancer.
    * 
    * Note
    * 
    * Completion of this API does not guarantee that operation has completed. Rather, it means that
    * the request has been registered and the changes will happen shortly.
    * 
    * @param instanceIds
    *           A list of instance IDs that should be registered with the LoadBalancer.
    * 
    *           Note
    * 
    *           When the instance is stopped and then restarted, the IP addresses associated with
    *           your instance changes. Elastic Load Balancing cannot recognize the new IP address,
    *           which prevents it from routing traffic to your instances. We recommend that you
    *           de-register your Amazon EC2 instances from your load balancer after you stop your
    *           instance, and then register the load balancer with your instance after you've
    *           restarted. To de-register your instances from load balancer, use
    *           DeregisterInstancesFromLoadBalancer action.
    * 
    * 
    * @param loadBalancerName
    *           The name associated with the LoadBalancer. The name must be unique within the api
    *           AWS account.
    * 
    * @return instanceIds registered with load balancer
    */
   @Named("RegisterInstancesWithLoadBalancer")
   @POST
   @Path("/")
   @XMLResponseParser(InstancesResultHandler.class)
   @FormParams(keys = ACTION, values = "RegisterInstancesWithLoadBalancer")
   Set registerInstancesWithLoadBalancer(
            @BinderParam(BindInstanceIdsToIndexedFormParams.class) Iterable instanceIds,
            @FormParam("LoadBalancerName") String loadBalancerName);
   

   /**
    * @see InstanceApi#registerInstanceWithLoadBalancer
    */
   @Named("RegisterInstancesWithLoadBalancer")
   @POST
   @Path("/")
   @XMLResponseParser(InstancesResultHandler.class)
   @FormParams(keys = ACTION, values = "RegisterInstancesWithLoadBalancer")
   Set registerInstanceWithLoadBalancer(
            @FormParam("Instances.member.1.InstanceId") String instanceId,
            @FormParam("LoadBalancerName") String loadBalancerName);

   /**
    * Deregisters instances from the LoadBalancer. Once the instance is deregistered, it will stop
    * receiving traffic from the LoadBalancer.
    * 
    * In order to successfully call this API, the same account credentials as those used to create
    * the LoadBalancer must be provided.
    * 
    * @param instanceIds
    *           A list of EC2 instance IDs consisting of all instances to be deregistered.
    * 
    * @param loadBalancerName
    *           The name associated with the LoadBalancer. The name must be unique within the api
    *           AWS account.
    * 
    * @return instanceIds still registered with load balancer
    */
   @Named("DeregisterInstancesFromLoadBalancer")
   @POST
   @Path("/")
   @XMLResponseParser(InstancesResultHandler.class)
   @FormParams(keys = ACTION, values = "DeregisterInstancesFromLoadBalancer")
   Set deregisterInstancesFromLoadBalancer(
            @BinderParam(BindInstanceIdsToIndexedFormParams.class) Iterable instanceIds,
            @FormParam("LoadBalancerName") String loadBalancerName);

   /**
    * @see InstanceApi#deregisterInstancesFromLoadBalancer
    */
   @Named("DeregisterInstancesFromLoadBalancer")
   @POST
   @Path("/")
   @XMLResponseParser(InstancesResultHandler.class)
   @FormParams(keys = ACTION, values = "DeregisterInstancesFromLoadBalancer")
   Set deregisterInstanceFromLoadBalancer(
            @FormParam("Instances.member.1.InstanceId") String instanceId,
            @FormParam("LoadBalancerName") String loadBalancerName);
}