
org.jclouds.cloudstack.features.FirewallAsyncClient Maven / Gradle / Ivy
/**
* Licensed to jclouds, Inc. (jclouds) under one or more
* contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. jclouds 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.cloudstack.features;
import java.util.Set;
import javax.ws.rs.Consumes;
import javax.ws.rs.GET;
import javax.ws.rs.QueryParam;
import javax.ws.rs.core.MediaType;
import org.jclouds.cloudstack.domain.AsyncCreateResponse;
import org.jclouds.cloudstack.domain.FirewallRule;
import org.jclouds.cloudstack.domain.PortForwardingRule;
import org.jclouds.cloudstack.filters.AuthenticationFilter;
import org.jclouds.cloudstack.options.CreateFirewallRuleOptions;
import org.jclouds.cloudstack.options.ListFirewallRulesOptions;
import org.jclouds.cloudstack.options.ListPortForwardingRulesOptions;
import org.jclouds.rest.annotations.ExceptionParser;
import org.jclouds.rest.annotations.OnlyElement;
import org.jclouds.rest.annotations.QueryParams;
import org.jclouds.rest.annotations.RequestFilters;
import org.jclouds.rest.annotations.SelectJson;
import org.jclouds.rest.annotations.Unwrap;
import org.jclouds.rest.functions.ReturnEmptySetOnNotFoundOr404;
import org.jclouds.rest.functions.ReturnNullOnNotFoundOr404;
import org.jclouds.rest.functions.ReturnVoidOnNotFoundOr404;
import com.google.common.util.concurrent.ListenableFuture;
/**
* Provides asynchronous access to cloudstack via their REST API.
*
*
* @author Adrian Cole
* @see FirewallClient
* @see
*/
@RequestFilters(AuthenticationFilter.class)
@QueryParams(keys = "response", values = "json")
public interface FirewallAsyncClient {
/**
* @see FirewallClient#listFirewallRules
*/
@GET
@QueryParams(keys = { "command", "listAll" }, values = { "listFirewallRules", "true" })
@SelectJson("firewallrule")
@Consumes(MediaType.APPLICATION_JSON)
@ExceptionParser(ReturnEmptySetOnNotFoundOr404.class)
ListenableFuture> listFirewallRules(ListFirewallRulesOptions... options);
/**
* @see FirewallClient#getFirewallRule
*/
@GET
@QueryParams(keys = { "command", "listAll" }, values = { "listFirewallRules", "true" })
@SelectJson("firewallrule")
@OnlyElement
@Consumes(MediaType.APPLICATION_JSON)
@ExceptionParser(ReturnNullOnNotFoundOr404.class)
ListenableFuture getFirewallRule(@QueryParam("id") String id);
/**
* @see FirewallClient#createFirewallRuleForIpAndProtocol
*/
@GET
@QueryParams(keys = "command", values = "createFirewallRule")
@Unwrap
@Consumes(MediaType.APPLICATION_JSON)
ListenableFuture createFirewallRuleForIpAndProtocol(@QueryParam("ipaddressid") String ipAddressId,
@QueryParam("protocol") FirewallRule.Protocol protocol, CreateFirewallRuleOptions... options);
/**
* @see FirewallClient#createFirewallRuleForIpProtocolAndPort
*/
@GET
@QueryParams(keys = "command", values = "createFirewallRule")
@Unwrap
@Consumes(MediaType.APPLICATION_JSON)
ListenableFuture createFirewallRuleForIpProtocolAndPort(@QueryParam("ipaddressid") String ipAddressId,
@QueryParam("protocol") FirewallRule.Protocol protocol,
@QueryParam("startPort") int startPort,
@QueryParam("endPort") int endPort);
/**
* @see FirewallClient#deleteFirewallRule
*/
@GET
@QueryParams(keys = "command", values = "deleteFirewallRule")
@ExceptionParser(ReturnVoidOnNotFoundOr404.class)
ListenableFuture deleteFirewallRule(@QueryParam("id") String id);
/**
* @see FirewallClient#listPortForwardingRules
*/
@GET
@QueryParams(keys = { "command", "listAll" }, values = { "listPortForwardingRules", "true" })
@SelectJson("portforwardingrule")
@Consumes(MediaType.APPLICATION_JSON)
@ExceptionParser(ReturnEmptySetOnNotFoundOr404.class)
ListenableFuture> listPortForwardingRules(ListPortForwardingRulesOptions... options);
/**
* @see FirewallClient#getPortForwardingRule
*/
@GET
@QueryParams(keys = { "command", "listAll" }, values = { "listPortForwardingRules", "true" })
@SelectJson("portforwardingrule")
@OnlyElement
@Consumes(MediaType.APPLICATION_JSON)
@ExceptionParser(ReturnNullOnNotFoundOr404.class)
ListenableFuture getPortForwardingRule(@QueryParam("id") String id);
/**
* @see FirewallClient#createPortForwardingRuleForVirtualMachine
*/
@GET
@QueryParams(keys = "command", values = "createPortForwardingRule")
@Unwrap
@Consumes(MediaType.APPLICATION_JSON)
ListenableFuture createPortForwardingRuleForVirtualMachine(
@QueryParam("ipaddressid") String ipAddressId, @QueryParam("protocol") PortForwardingRule.Protocol protocol,
@QueryParam("publicport") int publicPort, @QueryParam("virtualmachineid") String virtualMachineId,
@QueryParam("privateport") int privatePort);
/**
* @see FirewallClient#deletePortForwardingRule
*/
@GET
@QueryParams(keys = "command", values = "deletePortForwardingRule")
@ExceptionParser(ReturnVoidOnNotFoundOr404.class)
ListenableFuture deletePortForwardingRule(@QueryParam("id") String id);
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy