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.incubator.net.domain;
  17
  18 import com.google.common.annotations.Beta;
  19
  20 import java.util.List;
  21 import java.util.Set;
  22
  23 /**
  24  * FIXME.
  25  */
  26 @Beta
  27 public interface IntentDomainProvider {
  28
  29     /**
  30      * Requests that the provider attempt to satisfy the intent primitive.
  31      * The application must apply the context before the intent resource
  32      * can be used. Request contexts can be explictly cancelled, or they will
  33      * eventually time out so that resources can be reused.
  34      *
  35      * @param domain intent domain for the request
  36      * @param primitive intent primitive
  37      * @return request contexts that contain resources to satisfy the intent
  38      */
  39     //TODO Consider an iterable and/or holds (only hold one or two reservation(s) at a time)
  40     List<RequestContext> request(IntentDomain domain, IntentPrimitive primitive);
  41
  42     /**
  43      * Request that the provider attempt to modify an existing resource to satisfy
  44      * a new intent primitive. The application must apply the context before
  45      * the intent resource can be used.
  46      *
  47      * @param resource existing resource
  48      * @param newPrimitive intent primitive
  49      * @return request contexts that contain resources to satisfy the intent
  50      */
  51     List<RequestContext> modify(IntentResource resource, IntentPrimitive newPrimitive);
  52
  53     /**
  54      * Requests that the provider release an intent resource.
  55      *
  56      * @param resource intent resource
  57      */
  58     void release(IntentResource resource);
  59
  60     /**
  61      * Requests that the provider apply the intent resource in the request context.
  62      *
  63      * @param context request context
  64      * @return intent resource that satisfies the intent
  65      */
  66     IntentResource apply(RequestContext context);
  67
  68     /**
  69      * Requests that the provider cancel the request. Requests that are not applied
  70      * will be eventually timed out by the provider.
  71      *
  72      * @param context request context
  73      */
  74     void cancel(RequestContext context);
  75
  76     /**
  77      * Returns all intent resources held by the provider.
  78      *
  79      * @return set of intent resources
  80      */
  81     Set<IntentResource> getResources();
  82 }
  83
  84