2 * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.yangtools.yang.model.repo.api;
10 import com.google.common.annotations.Beta;
11 import com.google.common.util.concurrent.Futures;
12 import com.google.common.util.concurrent.ListenableFuture;
13 import java.util.Collections;
16 * A filter of schema sources. This is used to restrict which sources representation
17 * instances are allowed to participate in construction of a schema context. This
18 * allows, for example, to create an non-shared island, or require the sources to
19 * be certified before use.
22 public interface SchemaSourceFilter {
24 * A {@link SchemaSourceFilter} which accepts any schema source it is presented with.
26 SchemaSourceFilter ALWAYS_ACCEPT = new SchemaSourceFilter() {
27 private final Iterable<Class<? extends SchemaSourceRepresentation>> representations =
28 Collections.<Class<? extends SchemaSourceRepresentation>>singletonList(SchemaSourceRepresentation.class);
29 private final ListenableFuture<Boolean> applyFuture = Futures.immediateFuture(Boolean.TRUE);
32 public Iterable<Class<? extends SchemaSourceRepresentation>> supportedRepresentations() {
33 return representations;
37 public ListenableFuture<Boolean> apply(final SchemaSourceRepresentation schemaSource) {
43 * Get the representations this filter supports. A schema source is translated
44 * into one of these representations before it is presented for filtering.
46 * @return Set of supported representations.
48 Iterable<Class<? extends SchemaSourceRepresentation>> supportedRepresentations();
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
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.
60 ListenableFuture<Boolean> apply(SchemaSourceRepresentation schemaSource);