gerrit.opnfv Code Review - onosfw.git/blob

   1 /*
   2  * Copyright 2015 Open Networking Laboratory
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16 package org.onosproject.vtnrsc.flowClassifier;
  17
  18 import org.onosproject.vtnrsc.FlowClassifier;
  19 import org.onosproject.vtnrsc.FlowClassifierId;
  20
  21 /**
  22  * Provides Services for Flow Classifier.
  23  */
  24 public interface FlowClassifierService {
  25
  26     /**
  27      * Store Flow Classifier.
  28      *
  29      * @param flowClassifier Flow Classifier
  30      * @return true if adding Flow Classifier into store is success otherwise return false.
  31      */
  32     boolean createFlowClassifier(FlowClassifier flowClassifier);
  33
  34     /**
  35      * Return the existing collection of Flow Classifier.
  36      *
  37      * @return Flow Classifier collections.
  38      */
  39     Iterable<FlowClassifier> getFlowClassifiers();
  40
  41     /**
  42      * Check whether Flow Classifier is present based on given Flow Classifier Id.
  43      *
  44      * @param id Flow Classifier.
  45      * @return true if Flow Classifier is present otherwise return false.
  46      */
  47     boolean hasFlowClassifier(FlowClassifierId id);
  48
  49     /**
  50      * Retrieve the Flow Classifier based on given Flow Classifier id.
  51      *
  52      * @param id Flow Classifier Id.
  53      * @return Flow Classifier if present otherwise returns null.
  54      */
  55     FlowClassifier getFlowClassifier(FlowClassifierId id);
  56
  57     /**
  58      * Update Flow Classifier based on given Flow Classifier Id.
  59      *
  60      * @param flowClassifier Flow Classifier.
  61      * @return true if update is success otherwise return false.
  62      */
  63     boolean updateFlowClassifier(FlowClassifier flowClassifier);
  64
  65     /**
  66      * Remove Flow Classifier from store based on given Flow Classifier Id.
  67      *
  68      * @param id Flow Classifier Id.
  69      * @return true if Flow Classifier removal is success otherwise return false.
  70      */
  71     boolean removeFlowClassifier(FlowClassifierId id);
  72 }