blob: f2433fa398b151c50dd8607e459463b9918ca7a8 [file] [log] [blame]
Gaurav Agrawalb102b012016-08-02 12:52:48 +05301/*
2 * Copyright 2016-present Open Networking Laboratory
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package org.onosproject.yms.ych;
18
19/**
20 * Abstraction of an entity which provides interfaces to YANG codec handler.
21 *
22 * In SBI, the provider or driver uses YANG management system as a CODEC
23 * utility. These providers/drivers use the YANG codec utility to register
24 * the device schema. YANG utils is used to generate the java files
25 * corresponding to the device schema. Provider or driver use these classes
26 * to seamlessly manage the device as java objects. While sending the request
27 * to device, drivers use the utility to translate the objects to protocol
28 * specific data representation and then send to the device.
29 * Protocol or driver use the same instance of the codec utility across multiple
30 * translation request.
31 * Protocol or driver should not use the same instance of utility concurrently.
32 */
33public interface YangCodecHandler {
34 //TODO
35}