opendaylight/networkconfiguration/neutron/src/main/java/org/opendaylight/controller/networkconfig/neutron/INeutronSecurityGroupAware.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 /**
  13  * This interface defines the methods a service that wishes to be aware of Neutron Security Groups needs to implement
  14  *
  15  * @deprecated Replaced by {@link org.opendaylight.neutron.neutron.spi.INeutronSecurityGroupAware}
  16  */
  17
  18 @Deprecated
  19 public interface INeutronSecurityGroupAware {
  20
  21     /**
  22      * Services provide this interface method to indicate if the specified security group can be created
  23      *
  24      * @param securityGroup instance of proposed new Neutron Security Group object
  25      * @return integer
  26      * the return value is understood to be a HTTP status code.  A return value outside of 200 through 299
  27      * results in the create operation being interrupted and the returned status value reflected in the
  28      * HTTP response.
  29      */
  30     public int canCreateNeutronSecurityGroup(NeutronSecurityGroup securityGroup);
  31
  32     /**
  33      * Services provide this interface method for taking action after a security group has been created
  34      *
  35      * @param securityGroup instance of new Neutron Security Group object
  36      * @return void
  37      */
  38     public void neutronSecurityGroupCreated(NeutronSecurityGroup securityGroup);
  39
  40     /**
  41      * Services provide this interface method to indicate if the specified security group can be changed using the specified
  42      * delta
  43      *
  44      * @param delta    updates to the security group object using patch semantics
  45      * @param original instance of the Neutron Security Group object to be updated
  46      * @return integer
  47      * the return value is understood to be a HTTP status code.  A return value outside of 200 through 299
  48      * results in the update operation being interrupted and the returned status value reflected in the
  49      * HTTP response.
  50      */
  51     public int canUpdateNeutronSecurityGroup(NeutronSecurityGroup delta, NeutronSecurityGroup original);
  52
  53     /**
  54      * Services provide this interface method for taking action after a security group has been updated
  55      *
  56      * @param securityGroup instance of modified Neutron Security Group object
  57      * @return void
  58      */
  59     public void neutronSecurityGroupUpdated(NeutronSecurityGroup securityGroup);
  60
  61     /**
  62      * Services provide this interface method to indicate if the specified security group can be deleted
  63      *
  64      * @param securityGroup instance of the Neutron Security Group object to be deleted
  65      * @return integer
  66      * the return value is understood to be a HTTP status code.  A return value outside of 200 through 299
  67      * results in the delete operation being interrupted and the returned status value reflected in the
  68      * HTTP response.
  69      */
  70     public int canDeleteNeutronSecurityGroup(NeutronSecurityGroup securityGroup);
  71
  72     /**
  73      * Services provide this interface method for taking action after a security group has been deleted
  74      *
  75      * @param securityGroup instance of deleted Neutron Security Group object
  76      * @return void
  77      */
  78     public void neutronSecurityGroupDeleted(NeutronSecurityGroup securityGroup);
  79 }