data/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 static java.util.Objects.requireNonNull;
  11
  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;
  20
  21 /**
  22  * Do not use this class outside of yangtools, its presence does not fall into the API stability contract.
  23  */
  24 @Beta
  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;
  29
  30         Restricted(final BinaryTypeDefinition typeDef, final LengthConstraint lengthConstraint) {
  31             super(typeDef);
  32             this.lengthConstraint = requireNonNull(lengthConstraint);
  33         }
  34
  35         @Override
  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);
  41             }
  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(requireNonNull(typeDef), byte[].class);
  58     }
  59
  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);
  63     }
  64
  65     @Override
  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);
  69         validate(ret);
  70         return ret;
  71     }
  72
  73     @Override
  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);
  77     }
  78
  79     abstract void validate(byte[] value);
  80 }