opendaylight/sal/yang-prototype/sal/sal-core-api/src/main/java/org/opendaylight/controller/sal/core/api/data/DataValidator.java

   1 /*
   2  * Copyright (c) 2013 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.controller.sal.core.api.data;
   9
  10 import java.util.Set;
  11
  12 import org.opendaylight.controller.sal.common.DataStoreIdentifier;
  13 import org.opendaylight.controller.sal.core.api.Provider;
  14 import org.opendaylight.yangtools.yang.common.RpcResult;
  15 import org.opendaylight.yangtools.yang.data.api.CompositeNode;
  16
  17
  18 /**
  19  * {@link Provider}-supplied Validator of the data.
  20  *
  21  * <p>
  22  * The registration could be done by :
  23  * <ul>
  24  * <li>returning an instance of implementation in the return value of
  25  * {@link Provider#getProviderFunctionality()}
  26  * <li>passing an instance of implementation and {@link DataStoreIdentifier} rpc
  27  * as arguments to the
  28  * {@link DataProviderService#addValidator(DataStoreIdentifier, DataValidator)}
  29  * </ul>
  30  *
  31  **/
  32 public interface DataValidator extends Provider.ProviderFunctionality {
  33
  34     /**
  35      * A set of Data Stores supported by implementation.
  36      *
  37      * The set of {@link DataStoreIdentifier}s which identifies target data
  38      * stores which are supported by this implementation. This set is used, when
  39      * {@link Provider} is registered to the SAL, to register and expose the
  40      * validation functionality to affected data stores.
  41      *
  42      * @return Set of Data Store identifiers
  43      */
  44     Set<DataStoreIdentifier> getSupportedDataStores();
  45
  46     /**
  47      * Performs validation on supplied data.
  48      *
  49      * @param toValidate
  50      *            Data to validate
  51      * @return Validation result. The
  52      *         <code>{@link RpcResult#isSuccessful()} == true</code> if the data
  53      *         passed validation, otherwise contains list of errors.
  54      */
  55     RpcResult<Void> validate(CompositeNode toValidate);
  56
  57 }