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