yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/repo/api/SchemaSourceFilter.java

   1 /*
   2  * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
   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 package org.opendaylight.yangtools.yang.model.repo.api;
   9
  10 import com.google.common.annotations.Beta;
  11 import com.google.common.collect.ImmutableList;
  12 import com.google.common.util.concurrent.FluentFuture;
  13 import com.google.common.util.concurrent.ListenableFuture;
  14 import org.eclipse.jdt.annotation.NonNull;
  15 import org.opendaylight.yangtools.util.concurrent.FluentFutures;
  16
  17 /**
  18  * A filter of schema sources. This is used to restrict which sources representation instances are allowed
  19  * to participate in construction of a schema context. This allows, for example, to create an non-shared island,
  20  * or require the sources to be certified before use.
  21  */
  22 @Beta
  23 public interface SchemaSourceFilter {
  24     /**
  25      * A {@link SchemaSourceFilter} which accepts any schema source it is presented with.
  26      */
  27     @NonNull SchemaSourceFilter ALWAYS_ACCEPT = new SchemaSourceFilter() {
  28         private final ImmutableList<Class<? extends SchemaSourceRepresentation>> representations =
  29                 ImmutableList.of(SchemaSourceRepresentation.class);
  30
  31         @Override
  32         public ImmutableList<Class<? extends SchemaSourceRepresentation>> supportedRepresentations() {
  33             return representations;
  34         }
  35
  36         @Override
  37         public FluentFuture<Boolean> apply(final SchemaSourceRepresentation schemaSource) {
  38             return FluentFutures.immediateTrueFluentFuture();
  39         }
  40     };
  41
  42     /**
  43      * Get the representations this filter supports. A schema source is translated
  44      * into one of these representations before it is presented for filtering.
  45      *
  46      * @return Set of supported representations.
  47      */
  48     Iterable<Class<? extends SchemaSourceRepresentation>> supportedRepresentations();
  49
  50     /**
  51      * Check if a particular schema source is acceptable to the filter. The process
  52      * of checking may be asynchronous, but at some point it needs to produce an
  53      * affirmative or negative answer before the schema context construction can
  54      * proceed.
  55      *
  56      * @param schemaSource Schema source to be filtered
  57      * @return Promise of a filtering decision. The result should be {@link Boolean#TRUE}
  58      *         if the source is acceptable.
  59      */
  60     ListenableFuture<Boolean> apply(SchemaSourceRepresentation schemaSource);
  61 }