opendaylight/networkconfiguration/neutron/src/main/java/org/opendaylight/controller/networkconfig/neutron/INeutronSecurityRuleAware.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 required to be aware of Neutron Security Rules
  14  *
  15  * @deprecated Replaced by {@link org.opendaylight.neutron.neutron.spi.INeutronSecurityRuleAware}
  16  */
  17
  18 @Deprecated
  19 public interface INeutronSecurityRuleAware {
  20
  21     /**
  22      * Services provide this interface method to indicate if the specified security rule can be created
  23      *
  24      * @param securityRule instance of proposed new Neutron Security Rule 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 canCreateNeutronSecurityRule(NeutronSecurityRule securityRule);
  31
  32     /**
  33      * Services provide this interface method for taking action after a security rule has been created
  34      *
  35      * @param securityRule instance of new Neutron Security Rule object
  36      * @return void
  37      */
  38     public void neutronSecurityRuleCreated(NeutronSecurityRule securityRule);
  39
  40     /**
  41      * Services provide this interface method to indicate if the specified security rule can be changed using the specified
  42      * delta
  43      *
  44      * @param delta    updates to the security rule object using patch semantics
  45      * @param original instance of the Neutron Security Rule 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 canUpdateNeutronSecurityRule(NeutronSecurityRule delta, NeutronSecurityRule original);
  52
  53     /**
  54      * Services provide this interface method for taking action after a security rule has been updated
  55      *
  56      * @param securityRule instance of modified Neutron Security Rule object
  57      * @return void
  58      */
  59     public void neutronSecurityRuleUpdated(NeutronSecurityRule securityRule);
  60
  61     /**
  62      * Services provide this interface method to indicate if the specified security rule can be deleted
  63      *
  64      * @param securityRule instance of the Neutron Security Rule 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 canDeleteNeutronSecurityRule(NeutronSecurityRule securityRule);
  71
  72     /**
  73      * Services provide this interface method for taking action after a security rule has been deleted
  74      *
  75      * @param securityRule instance of deleted Neutron Security Rule object
  76      * @return void
  77      */
  78     public void neutronSecurityRuleDeleted(NeutronSecurityRule securityRule);
  79 }