IACLService.java

/**
 *    Copyright 2015, Big Switch Networks, Inc.
 *    Originally created by Pengfei Lu, Network and Cloud Computing Laboratory, Dalian University of Technology, China 
 *    Advisers: Keqiu Li, Heng Qi and Haisheng Yu 
 *    This work is supported by the State Key Program of National Natural Science of China(Grant No. 61432002) 
 *    and Prospective Research Project on Future Networks in Jiangsu Future Networks Innovation Institute.
 *    
 *    Licensed 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 net.floodlightcontroller.accesscontrollist;

import java.util.List;

import net.floodlightcontroller.core.module.IFloodlightService;

/**
 * Service interface exported by ACL module
 */
public interface IACLService extends IFloodlightService {
	
    /**
     * Gets a list containing all ACL rules.
     * @return a list containing all ACL rules
     */
    public List<ACLRule> getRules();
    
    /**
     * Add a new ACL rule.
     * @param rule ACL rule
     * @return true if successfully added, otherwise false
     */
    public boolean addRule(ACLRule rule);

    /**
     * Removes an existing ACL rule by rule id.
     * @param ruleId ACL rule identifier
     */
    public void removeRule(int ruleid);
    
    /**
     * Clears ACL and resets all.
     */
    public void removeAllRules();

}