blob: 416f02cbd9043ea57401a099dd71fa92f7dd6a27 [file] [log] [blame]
Jian Lidab72562016-04-12 14:10:32 -07001/*
Brian O'Connora09fe5b2017-08-03 21:12:30 -07002 * Copyright 2016-present Open Networking Foundation
Jian Lidab72562016-04-12 14:10:32 -07003 *
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 */
16package org.onosproject.codec;
17
18import com.fasterxml.jackson.databind.node.ObjectNode;
19import org.onosproject.net.driver.HandlerBehaviour;
20import org.onosproject.net.flow.instructions.ExtensionTreatment;
21
22/**
23 * Interface for encode and decode extension treatment.
Andrea Campanella2cfe8ef2017-07-13 19:45:15 +020024 * @deprecated 1.11.0 Loon use interface under core/api/net/flow.
Jian Lidab72562016-04-12 14:10:32 -070025 */
Andrea Campanella2cfe8ef2017-07-13 19:45:15 +020026@Deprecated
Jian Lidab72562016-04-12 14:10:32 -070027public interface ExtensionTreatmentCodec extends HandlerBehaviour {
28
29 /**
30 * Encodes an extension treatment to an JSON object.
31 *
32 * @param extensionTreatment extension treatment
33 * @param context encoding context
34 * @return JSON object
35 */
36 default ObjectNode encode(ExtensionTreatment extensionTreatment, CodecContext context) {
37 return null;
38 }
39
40 /**
41 * Decodes an JSON object to an extension treatment.
42 *
43 * @param objectNode JSON object
44 * @param context decoding context
45 * @return extension treatment
46 */
47 default ExtensionTreatment decode(ObjectNode objectNode, CodecContext context) {
48 return null;
49 }
50}