OpenstackSecurityGroupStore.java

/*
 * Copyright 2017-present Open Networking Laboratory
 *
 * 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.onosproject.openstacknetworking.api;

import org.onosproject.store.Store;
import org.openstack4j.model.network.SecurityGroup;
import org.openstack4j.model.network.SecurityGroupRule;

/**
 * Manages inventory of OpenStack security group states; not intended for direct use.
 */
public interface OpenstackSecurityGroupStore
        extends Store<OpenstackSecurityGroupEvent, OpenstackSecurityGroupStoreDelegate> {

    /**
     * Creates a security group.
     *
     * @param sg security group
     */
    void createSecurityGroup(SecurityGroup sg);

    /**
     * Updates the security group with the security group ID with the security group object.
     *
     * @param sgId security group ID
     * @param sg new SecurityGroup object
     * @return old SecurityGroup object
     */
    SecurityGroup updateSecurityGroup(String sgId, SecurityGroup sg);

    /**
     * Removes the security group with the security group ID.
     *
     * @param sgId security group Id
     * @return SecurityGroup object removed
     */
    SecurityGroup removeSecurityGroup(String sgId);

    /**
     * Creates a security group rule.
     *
     * @param sgRule security group rule
     */
    void createSecurityGroupRule(SecurityGroupRule sgRule);

    /**
     * Removes the security group rule with the security group rule ID.
     *
     * @param sgRuleId security group rule ID to remove
     * @return SecurityGroupRule object removed
     */
    SecurityGroupRule removeSecurityGroupRule(String sgRuleId);

    /**
     * Returns the security group with the security group ID.
     *
     * @param sgId security group ID
     * @return Security Group
     */
    SecurityGroup securityGroup(String sgId);

    /**
     * Returns the security group rule with the security group ID.
     *
     * @param sgRuleId security group rule ID
     * @return Security Group Rule
     */
    SecurityGroupRule securityGroupRule(String sgRuleId);

}