2 * Copyright (c) 2013 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.controller.sal.core.api.data;
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;
19 * {@link Provider}-supplied Validator of the data.
22 * The registration could be done by :
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
28 * {@link DataProviderService#addValidator(DataStoreIdentifier, DataValidator)}
32 public interface DataValidator extends Provider.ProviderFunctionality {
35 * A set of Data Stores supported by implementation.
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.
42 * @return Set of Data Store identifiers
44 Set<DataStoreIdentifier> getSupportedDataStores();
47 * Performs validation on supplied data.
51 * @return Validation result. The
52 * <code>{@link RpcResult#isSuccessful()} == true</code> if the data
53 * passed validation, otherwise contains list of errors.
55 RpcResult<Void> validate(CompositeNode toValidate);