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 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 javax.xml.bind.DatatypeConverter;
  16 import org.opendaylight.yangtools.yang.common.RpcError.ErrorType;
  17 import org.opendaylight.yangtools.yang.data.api.codec.BinaryCodec;
  18 import org.opendaylight.yangtools.yang.data.api.codec.YangInvalidValueException;
  19 import org.opendaylight.yangtools.yang.model.api.type.BinaryTypeDefinition;
  20 import org.opendaylight.yangtools.yang.model.api.type.LengthConstraint;
  21
  22 /**
  23  * Do not use this class outside of yangtools, its presence does not fall into the API stability contract.
  24  */
  25 @Beta
  26 public abstract class BinaryStringCodec extends TypeDefinitionAwareCodec<byte[], BinaryTypeDefinition>
  27         implements BinaryCodec<String> {
  28     private static final class Restricted extends BinaryStringCodec {
  29         private final LengthConstraint lengthConstraint;
  30
  31         Restricted(final BinaryTypeDefinition typeDef, final LengthConstraint lengthConstraint) {
  32             super(typeDef);
  33             this.lengthConstraint = requireNonNull(lengthConstraint);
  34         }
  35
  36         @Override
  37         void validate(final byte[] value) {
  38             final RangeSet<Integer> ranges = lengthConstraint.getAllowedRanges();
  39             if (!ranges.contains(value.length)) {
  40                 throw new YangInvalidValueException(ErrorType.PROTOCOL, lengthConstraint,
  41                         "Value length " + value.length + " is not in required ranges " + ranges);
  42             }
  43         }
  44     }
  45
  46     private static final class Unrestricted extends BinaryStringCodec {
  47         Unrestricted(final BinaryTypeDefinition typeDef) {
  48             super(typeDef);
  49         }
  50
  51         @Override
  52         void validate(final byte[] value) {
  53             // No-op
  54         }
  55     }
  56
  57     BinaryStringCodec(final BinaryTypeDefinition typeDef) {
  58         super(requireNonNull(typeDef), byte[].class);
  59     }
  60
  61     public static BinaryStringCodec from(final BinaryTypeDefinition type) {
  62         final java.util.Optional<LengthConstraint> optConstraint = type.getLengthConstraint();
  63         return optConstraint.isPresent() ? new Restricted(type, optConstraint.get()) : new Unrestricted(type);
  64     }
  65
  66     @Override
  67     public final byte[] deserializeImpl(final String product) {
  68         final byte[] ret = DatatypeConverter.parseBase64Binary(product);
  69         validate(ret);
  70         return ret;
  71     }
  72
  73     @Override
  74     protected final String serializeImpl(final byte[] data) {
  75         return Base64.getEncoder().encodeToString(data);
  76     }
  77
  78     abstract void validate(byte[] value);
  79 }