BUG-8039: Enforce binary/string type length
[yangtools.git] / yang / yang-data-impl / src / main / java / org / opendaylight / yangtools / yang / data / impl / codec / BinaryStringCodec.java
1 /*
2  * Copyright (c) 2015 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.yangtools.yang.data.impl.codec;
9
10 import com.google.common.base.Optional;
11 import com.google.common.base.Preconditions;
12 import com.google.common.collect.ImmutableRangeSet;
13 import com.google.common.collect.Range;
14 import com.google.common.collect.RangeSet;
15 import com.google.common.collect.TreeRangeSet;
16 import com.google.common.io.BaseEncoding;
17 import javax.xml.bind.DatatypeConverter;
18 import org.opendaylight.yangtools.yang.data.api.codec.BinaryCodec;
19 import org.opendaylight.yangtools.yang.model.api.type.BinaryTypeDefinition;
20 import org.opendaylight.yangtools.yang.model.api.type.LengthConstraint;
21
22 abstract class BinaryStringCodec extends TypeDefinitionAwareCodec<byte[], BinaryTypeDefinition>
23         implements BinaryCodec<String> {
24     private static final class Restricted extends BinaryStringCodec {
25         private final RangeSet<Integer> ranges;
26
27         Restricted(final BinaryTypeDefinition typeDef) {
28             super(typeDef);
29
30             final RangeSet<Integer> r = TreeRangeSet.create();
31             for (LengthConstraint c : typeDef.getLengthConstraints()) {
32                 r.add(Range.closed(c.getMin().intValue(), c.getMax().intValue()));
33             }
34
35             ranges = ImmutableRangeSet.copyOf(r);
36         }
37
38         @Override
39         void validate(final byte[] value) {
40             Preconditions.checkArgument(ranges.contains(value.length),
41                 "Value length %s does not match constraints %s", value.length, ranges);
42         }
43     }
44
45     private static final class Unrestricted extends BinaryStringCodec {
46         Unrestricted(final BinaryTypeDefinition typeDef) {
47             super(typeDef);
48         }
49
50         @Override
51         void validate(final byte[] value) {
52             // No-op
53         }
54     }
55
56     BinaryStringCodec(final BinaryTypeDefinition typeDef) {
57         super(Optional.of(typeDef), byte[].class);
58     }
59
60     static TypeDefinitionAwareCodec<?, BinaryTypeDefinition> from(final BinaryTypeDefinition type) {
61         return type.getLengthConstraints().isEmpty() ? new Unrestricted(type) : new Restricted(type);
62     }
63
64     @Override
65     public String serialize(final byte[] data) {
66         return data == null ? "" : BaseEncoding.base64().encode(data);
67     }
68
69     @Override
70     public byte[] deserialize(final String stringRepresentation) {
71         if (stringRepresentation == null) {
72             return null;
73         }
74
75         final byte[] ret = DatatypeConverter.parseBase64Binary(stringRepresentation);
76         validate(ret);
77         return ret;
78     }
79
80     abstract void validate(byte[] value);
81 }