plugins/netconf-client-mdsal/src/main/java/org/opendaylight/netconf/client/mdsal/api/BaseNetconfSchemaProvider.java

   1 /*
   2  * Copyright (c) 2020 PANTHEON.tech, s.r.o. 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.netconf.client.mdsal.api;
   9
  10 import com.google.common.annotations.Beta;
  11 import org.eclipse.jdt.annotation.NonNullByDefault;
  12
  13 /**
  14  * A provider of {@link BaseNetconfSchema} instances.
  15  */
  16 @Beta
  17 @NonNullByDefault
  18 public interface BaseNetconfSchemaProvider {
  19     /**
  20      * Return a {@link BaseNetconfSchema} corresponding to a set of capabilities advertized by a NETCONF device.
  21      *
  22      * @param sessionPreferences the set of advertized capabilities
  23      * @return A {@link BaseNetconfSchema}
  24      * @throws NullPointerException if {@code capabilityURNs} is {@code null}
  25      */
  26     BaseNetconfSchema baseSchemaForCapabilities(NetconfSessionPreferences sessionPreferences);
  27 }