| /** |
| * 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 java.util.concurrent.TimeUnit; |
| |
| import org.jclouds.cloudstack.domain.AsyncCreateResponse; |
| import org.jclouds.cloudstack.domain.FirewallRule; |
| import org.jclouds.cloudstack.domain.PortForwardingRule; |
| import org.jclouds.cloudstack.options.CreateFirewallRuleOptions; |
| import org.jclouds.cloudstack.options.ListFirewallRulesOptions; |
| import org.jclouds.cloudstack.options.ListPortForwardingRulesOptions; |
| import org.jclouds.concurrent.Timeout; |
| |
| /** |
| * Provides synchronous access to CloudStack PortForwardingRule features. |
| * <p/> |
| * |
| * @see PortForwardingRuleAsyncClient |
| * @see <a href="http://download.cloud.com/releases/2.2.0/api_2.2.12/TOC_User.html" /> |
| * @author Adrian Cole |
| */ |
| @Timeout(duration = 60, timeUnit = TimeUnit.SECONDS) |
| public interface FirewallClient { |
| |
| /** |
| * List the firewall rules |
| * |
| * @param options |
| * if present, how to constrain the list. |
| * @return |
| * set of firewall rules or empty set if no rules are found |
| */ |
| Set<FirewallRule> listFirewallRules(ListFirewallRulesOptions... options); |
| |
| /** |
| * Get a firewall rule by ID |
| * |
| * @param id |
| * the ID of the firewall rule |
| * @return |
| * firewall rule instance or null |
| */ |
| FirewallRule getFirewallRule(long id); |
| |
| /** |
| * Create new firewall rule for a specific IP address |
| * |
| * @param ipAddressId |
| * the IP address id of the port forwarding rule |
| * @param protocol |
| * the protocol for the firewall rule. Valid values are TCP/UDP/ICMP |
| * @param options |
| * optional arguments for firewall rule creation |
| * @return |
| */ |
| AsyncCreateResponse createFirewallRuleForIpAndProtocol(long ipAddressId, |
| FirewallRule.Protocol protocol, CreateFirewallRuleOptions... options); |
| |
| /** |
| * Deletes a firewall rule |
| * |
| * @param id |
| * the ID of the firewall rule |
| */ |
| Void deleteFirewallRule(long id); |
| |
| /** |
| * List the port forwarding rules |
| * |
| * @param options |
| * if present, how to constrain the list. |
| * @return PortForwardingRules matching query, or empty set, if no |
| * PortForwardingRulees are found |
| */ |
| Set<PortForwardingRule> listPortForwardingRules(ListPortForwardingRulesOptions... options); |
| |
| /** |
| * Get a port forwarding rule by ID |
| * |
| * @param id |
| * port forwarding rule ID |
| * @return |
| * rule instance or null |
| */ |
| PortForwardingRule getPortForwardingRule(long id); |
| |
| /** |
| * Creates an port forwarding rule |
| * |
| * |
| * @param ipAddressId |
| * @param protocol |
| * the protocol for the rule. Valid values are TCP or UDP. |
| * @param publicPort |
| * the public port of the port forwarding rule |
| * @param virtualMachineId |
| * the ID of the virtual machine for the port forwarding rule |
| * @param privatePort |
| * the private port of the port forwarding rule |
| * @return response used to track creation |
| */ |
| AsyncCreateResponse createPortForwardingRuleForVirtualMachine(long ipAddressId, |
| PortForwardingRule.Protocol protocol, int publicPort, long virtualMachineId, int privatePort); |
| |
| /** |
| * Deletes an port forwarding rule |
| * |
| * @param id |
| * the id of the forwarding rule |
| */ |
| Void deletePortForwardingRule(long id); |
| } |