apps/acl/src/main/java/org/onos/acl/AclService.java

/*
 * Copyright 2015 Open Networking Laboratory
 * 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 org.onos.acl;

import java.util.List;

/**
 * Service interface exported by ACL application.
 */
public interface AclService {

    /**
     * Gets a list containing all ACL rules.
     * @return a list containing all ACL rules
     */
    List<AclRule> getAclRules();

    /**
     * Adds a new ACL rule.
     * @param rule ACL rule
     * @return true if successfully added, otherwise false
     */
    boolean addAclRule(AclRule rule);

    /**
     * Removes an exsiting ACL rule by rule id.
     * @param ruleId ACL rule identifier
     */
    void removeAclRule(RuleId ruleId);

    /**
     * Clears ACL and resets all.
     */
    void clearAcl();

}