org.openstack4j.api.networking.ext.FirewallAsService Maven / Gradle / Ivy

package org.openstack4j.api.networking.ext;

import org.openstack4j.common.RestService;

/**
 * OpenStack Firewall As a Service (FwaaS) Operations API.
 * 
 * 
	 * The FWaaS extension provides OpenStack users with the ability to deploy firewalls to protect their networks. The FWaaS extension enables you to:
	 * 

	 * 		Apply firewall rules on traffic entering and leaving tenant networks.
	 * 		Support for applying tcp, udp, icmp, or protocol agnostic rules.
	 * 		Creation and sharing of firewall policies which hold an ordered collection of the firewall rules.
	 * 		Audit firewall rules and policies.
	 * 
 * 
 * 
 * 
 	* This extension introduces these resources:
 	* 

 	* 		Firewall: represents a logical firewall resource that a tenant can instantiate and manage.
 	* 			A firewall is associated with one firewall policy.
 	* 		
 	* 		Firewall Policy: is an ordered collection of firewall_rules. 
 	* 			A firewall policy can be shared across tenants. Thus it can also be made part of an audit workflow wherein the 
 	* 			firewall policy can be audited by the relevant entity that is authorized (and can be different from the tenants 
 	* 			which create or use the firewall policy).
 	* 		
 	* 		Firewall Rule: represents a collection of attributes like ports, 
 	* 			ip addresses which define match criteria and action (allow, or deny) that needs to be taken on the matched data traffic.
 	* 		
 	* 
 * 
 * 
 * @author Vishvesh Deshmukh
 */
public interface FirewallAsService extends RestService {

    /**
     * OpenStack Firewall As a Service (FwaaS) : Firewall Operations API
     * 
     * Represents a logical firewall resource that a tenant can instantiate and manage. A firewall is associated with one firewall policy.
     * 
     * @return the Firewall Service API
     */
    FirewallService firewall();

    /**
     * OpenStack Firewall As a Service (FwaaS) : Firewall Rule Operations API
     * 
     * Represents a collection of attributes like ports, ip addresses which define match 
     * 		criteria and action (allow, or deny) that needs to be taken on the matched data traffic
     * 
     * @return the Firewall Rule Service API
     */
	FirewallRuleService firewallrule();

    /**
     * OpenStack Firewall As a Service (FwaaS) : Firewall Policy Operations API
     * 
     * Represents an ordered collection of firewall rules. A firewall policy can be shared across tenants. 
     * 		Thus it can also be made part of an audit workflow wherein the firewall_policy can be audited by the 
     * 		relevant entity that is authorized (and can be different from the tenants which create or use the firewall policy).
     * 
     * @return the Firewall Policy Service API
     */
    FirewallPolicyService firewallpolicy();
}