2 * Copyright (c) 2015 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.yangtools.yang.data.impl.codec;
10 import static java.util.Objects.requireNonNull;
12 import com.google.common.annotations.Beta;
13 import com.google.common.collect.RangeSet;
14 import java.util.Base64;
15 import org.opendaylight.yangtools.yang.common.RpcError.ErrorType;
16 import org.opendaylight.yangtools.yang.data.api.codec.BinaryCodec;
17 import org.opendaylight.yangtools.yang.data.api.codec.YangInvalidValueException;
18 import org.opendaylight.yangtools.yang.model.api.type.BinaryTypeDefinition;
19 import org.opendaylight.yangtools.yang.model.api.type.LengthConstraint;
22 * Do not use this class outside of yangtools, its presence does not fall into the API stability contract.
25 public abstract class BinaryStringCodec extends TypeDefinitionAwareCodec<byte[], BinaryTypeDefinition>
26 implements BinaryCodec<String> {
27 private static final class Restricted extends BinaryStringCodec {
28 private final LengthConstraint lengthConstraint;
30 Restricted(final BinaryTypeDefinition typeDef, final LengthConstraint lengthConstraint) {
32 this.lengthConstraint = requireNonNull(lengthConstraint);
36 void validate(final byte[] value) {
37 final RangeSet<Integer> ranges = lengthConstraint.getAllowedRanges();
38 if (!ranges.contains(value.length)) {
39 throw new YangInvalidValueException(ErrorType.APPLICATION, lengthConstraint,
40 "Value length " + value.length + " is not in required ranges " + ranges);
45 private static final class Unrestricted extends BinaryStringCodec {
46 Unrestricted(final BinaryTypeDefinition typeDef) {
51 void validate(final byte[] value) {
56 BinaryStringCodec(final BinaryTypeDefinition typeDef) {
57 super(requireNonNull(typeDef), byte[].class);
60 public static BinaryStringCodec from(final BinaryTypeDefinition type) {
61 final java.util.Optional<LengthConstraint> optConstraint = type.getLengthConstraint();
62 return optConstraint.isPresent() ? new Restricted(type, optConstraint.get()) : new Unrestricted(type);
66 public final byte[] deserializeImpl(final String product) {
67 // https://tools.ietf.org/html/rfc4648#section-4 plus lenient to allow for MIME blocks
68 final byte[] ret = Base64.getMimeDecoder().decode(product);
74 protected final String serializeImpl(final byte[] data) {
75 // We do not split data on 76 characters on output
76 return Base64.getEncoder().encodeToString(data);
79 abstract void validate(byte[] value);