opendaylight/networkconfiguration/neutron/src/main/java/org/opendaylight/controller/networkconfig/neutron/INeutronSecurityGroupCRUD.java

   1 /*
   2  * Copyright (C) 2014 Red Hat, Inc.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  *
   8  */
   9
  10 package org.opendaylight.controller.networkconfig.neutron;
  11
  12 import java.util.List;
  13
  14 /**
  15  * This interface defines the methods for CRUD of NB OpenStack Security Group objects
  16  *
  17  * @deprecated Replaced by {@link org.opendaylight.neutron.neutron.spi.INeutronSecurityGroupCRUD}
  18  */
  19
  20 @Deprecated
  21 public interface INeutronSecurityGroupCRUD {
  22     /**
  23      * Applications call this interface method to determine if a particular
  24      * Security Group object exists
  25      *
  26      * @param uuid UUID of the Security Group object
  27      * @return boolean
  28      */
  29
  30     public boolean neutronSecurityGroupExists(String uuid);
  31
  32     /**
  33      * Applications call this interface method to return if a particular
  34      * Security Group object exists
  35      *
  36      * @param uuid UUID of the Security Group object
  37      * @return {@link org.opendaylight.controller.networkconfig.neutron.NeutronSecurityGroup.OpenStackSecurity Groups}
  38      * OpenStack Security Group class
  39      */
  40
  41     public NeutronSecurityGroup getNeutronSecurityGroup(String uuid);
  42
  43     /**
  44      * Applications call this interface method to return all Security Group objects
  45      *
  46      * @return List of OpenStackSecurity Groups objects
  47      */
  48
  49     public List<NeutronSecurityGroup> getAllNeutronSecurityGroups();
  50
  51     /**
  52      * Applications call this interface method to add a Security Group object to the
  53      * concurrent map
  54      *
  55      * @param input OpenStackSecurity Group object
  56      * @return boolean on whether the object was added or not
  57      */
  58
  59     public boolean addNeutronSecurityGroup(NeutronSecurityGroup input);
  60
  61     /**
  62      * Applications call this interface method to remove a Neutron Security Group object to the
  63      * concurrent map
  64      *
  65      * @param uuid identifier for the security group object
  66      * @return boolean on whether the object was removed or not
  67      */
  68
  69     public boolean removeNeutronSecurityGroup(String uuid);
  70
  71     /**
  72      * Applications call this interface method to edit a Security Group object
  73      *
  74      * @param uuid  identifier of the security group object
  75      * @param delta OpenStackSecurity Group object containing changes to apply
  76      * @return boolean on whether the object was updated or not
  77      */
  78
  79     public boolean updateNeutronSecurityGroup(String uuid, NeutronSecurityGroup delta);
  80
  81     /**
  82      * Applications call this interface method to see if a MAC address is in use
  83      *
  84      * @param uuid identifier of the security group object
  85      * @return boolean on whether the Security Groups is already in use
  86      */
  87
  88     public boolean neutronSecurityGroupInUse(String uuid);
  89
  90 }