Jian Li | 8bcef8b | 2016-01-06 11:35:53 -0800 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2016 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 | package org.onosproject.codec.impl; |
| 17 | |
| 18 | import com.fasterxml.jackson.databind.JsonNode; |
| 19 | import com.fasterxml.jackson.databind.node.ArrayNode; |
| 20 | import com.fasterxml.jackson.databind.node.ObjectNode; |
| 21 | import org.onosproject.codec.CodecContext; |
| 22 | import org.onosproject.codec.JsonCodec; |
| 23 | import org.onosproject.core.ApplicationId; |
| 24 | import org.onosproject.core.CoreService; |
| 25 | import org.onosproject.net.flow.TrafficTreatment; |
| 26 | import org.onosproject.net.flow.criteria.Criterion; |
| 27 | import org.onosproject.net.flowobjective.DefaultFilteringObjective; |
| 28 | import org.onosproject.net.flowobjective.FilteringObjective; |
| 29 | import org.slf4j.Logger; |
| 30 | |
| 31 | import java.util.stream.IntStream; |
| 32 | |
| 33 | import static com.google.common.base.Preconditions.checkNotNull; |
| 34 | import static org.onlab.util.Tools.nullIsIllegal; |
| 35 | import static org.slf4j.LoggerFactory.getLogger; |
| 36 | |
| 37 | /** |
| 38 | * Filtering Objective Codec. |
| 39 | */ |
| 40 | public class FilteringObjectiveCodec extends JsonCodec<FilteringObjective> { |
| 41 | private final Logger log = getLogger(getClass()); |
| 42 | |
| 43 | // JSON field names |
| 44 | private static final String ID = "id"; |
| 45 | private static final String TYPE = "type"; |
| 46 | private static final String KEY = "key"; |
| 47 | private static final String META = "meta"; |
| 48 | private static final String OPERATION = "operation"; |
| 49 | private static final String CONDITIONS = "conditions"; |
| 50 | |
| 51 | // messages to be printed out |
| 52 | private static final String MISSING_MEMBER_MESSAGE = |
| 53 | " member is required in FilteringObjective"; |
| 54 | private static final String NOT_NULL_MESSAGE = |
| 55 | "FilteringObjective cannot be null"; |
| 56 | private static final String INVALID_TYPE_MESSAGE = |
| 57 | "The requested type {} is not defined in FilteringObjective."; |
| 58 | private static final String INVALID_OP_MESSAGE = |
| 59 | "The requested operation {} is not defined for FilteringObjective."; |
| 60 | |
| 61 | public static final String REST_APP_ID = "org.onosproject.rest"; |
| 62 | |
| 63 | @Override |
| 64 | public ObjectNode encode(FilteringObjective filteringObjective, CodecContext context) { |
| 65 | |
| 66 | checkNotNull(filteringObjective, NOT_NULL_MESSAGE); |
| 67 | |
| 68 | final JsonCodec<Criterion> criterionCodec = context.codec(Criterion.class); |
| 69 | final JsonCodec<TrafficTreatment> trafficTreatmentCodec = context.codec(TrafficTreatment.class); |
| 70 | |
| 71 | // encode common properties |
| 72 | ObjectiveCodecHelper och = new ObjectiveCodecHelper(); |
| 73 | ObjectNode result = och.encode(filteringObjective, context); |
| 74 | |
| 75 | // encode id |
| 76 | result.put(ID, filteringObjective.id()); |
| 77 | |
| 78 | // encode type |
| 79 | result.put(TYPE, filteringObjective.type().toString()); |
| 80 | |
| 81 | // encode key |
| 82 | if (filteringObjective.key() != null) { |
| 83 | ObjectNode criterionNode = criterionCodec.encode(filteringObjective.key(), context); |
| 84 | result.set(KEY, criterionNode); |
| 85 | } |
| 86 | |
| 87 | // encode meta |
| 88 | if (filteringObjective.meta() != null) { |
| 89 | ObjectNode trafficTreatmentNode = trafficTreatmentCodec.encode(filteringObjective.meta(), context); |
| 90 | result.set(META, trafficTreatmentNode); |
| 91 | } |
| 92 | |
| 93 | // encode conditions |
| 94 | ArrayNode conditions = context.mapper().createArrayNode(); |
| 95 | filteringObjective.conditions().forEach(c -> { |
| 96 | ObjectNode criterionJson = criterionCodec.encode(c, context); |
| 97 | conditions.add(criterionJson); |
| 98 | }); |
| 99 | result.set(CONDITIONS, conditions); |
| 100 | |
| 101 | return result; |
| 102 | } |
| 103 | |
| 104 | @Override |
| 105 | public FilteringObjective decode(ObjectNode json, CodecContext context) { |
| 106 | if (json == null || !json.isObject()) { |
| 107 | return null; |
| 108 | } |
| 109 | |
| 110 | CoreService coreService = context.getService(CoreService.class); |
| 111 | |
| 112 | final JsonCodec<Criterion> criterionCodec = context.codec(Criterion.class); |
| 113 | final JsonCodec<TrafficTreatment> trafficTreatmentCodec = context.codec(TrafficTreatment.class); |
| 114 | |
| 115 | ObjectiveCodecHelper och = new ObjectiveCodecHelper(); |
| 116 | |
| 117 | DefaultFilteringObjective.Builder baseBuilder = DefaultFilteringObjective.builder(); |
| 118 | final DefaultFilteringObjective.Builder builder = |
| 119 | (DefaultFilteringObjective.Builder) och.decode(json, baseBuilder, context); |
| 120 | |
| 121 | // application id |
| 122 | ApplicationId appId = coreService.registerApplication(REST_APP_ID); |
| 123 | builder.fromApp(appId); |
| 124 | |
| 125 | // decode type |
| 126 | String typeStr = nullIsIllegal(json.get(TYPE), TYPE + MISSING_MEMBER_MESSAGE).asText(); |
| 127 | |
| 128 | switch (typeStr) { |
| 129 | case "PERMIT": |
| 130 | builder.permit(); |
| 131 | break; |
| 132 | case "DENY": |
| 133 | builder.deny(); |
| 134 | break; |
| 135 | default: |
| 136 | log.warn(INVALID_TYPE_MESSAGE, typeStr); |
| 137 | return null; |
| 138 | } |
| 139 | |
| 140 | // decode key |
| 141 | JsonNode keyJson = json.get(KEY); |
| 142 | if (keyJson != null) { |
| 143 | Criterion key = criterionCodec.decode((ObjectNode) keyJson, context); |
| 144 | builder.withKey(key); |
| 145 | } |
| 146 | |
| 147 | // decode conditions |
| 148 | JsonNode conditionsJson = json.get(CONDITIONS); |
| 149 | checkNotNull(conditionsJson); |
| 150 | if (conditionsJson != null) { |
| 151 | IntStream.range(0, conditionsJson.size()).forEach(i -> { |
| 152 | ObjectNode conditionJson = get(conditionsJson, i); |
| 153 | builder.addCondition(criterionCodec.decode(conditionJson, context)); |
| 154 | }); |
| 155 | } |
| 156 | |
| 157 | // decode meta |
| 158 | JsonNode metaJson = json.get(META); |
| 159 | if (metaJson != null) { |
| 160 | TrafficTreatment trafficTreatment = trafficTreatmentCodec.decode((ObjectNode) metaJson, context); |
| 161 | builder.withMeta(trafficTreatment); |
| 162 | } |
| 163 | |
| 164 | // decode operation |
| 165 | String opStr = nullIsIllegal(json.get(OPERATION), OPERATION + MISSING_MEMBER_MESSAGE).asText(); |
| 166 | FilteringObjective filteringObjective; |
| 167 | |
| 168 | switch (opStr) { |
| 169 | case "ADD": |
| 170 | filteringObjective = builder.add(); |
| 171 | break; |
| 172 | case "REMOVE": |
| 173 | filteringObjective = builder.remove(); |
| 174 | break; |
| 175 | default: |
| 176 | log.warn(INVALID_OP_MESSAGE, opStr); |
| 177 | return null; |
| 178 | } |
| 179 | |
| 180 | return filteringObjective; |
| 181 | } |
| 182 | } |