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 java.util.Optional;
  16 import javax.xml.bind.DatatypeConverter;
  17 import org.opendaylight.yangtools.yang.data.api.codec.BinaryCodec;
  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             // FIXME: throw an exception capturing the constraint violation
  38             checkArgument(lengthConstraint.getAllowedRanges().contains(value.length),
  39                 "Value length %s does not match constraint %s", value.length, lengthConstraint);
  40         }
  41     }
  42
  43     private static final class Unrestricted extends BinaryStringCodec {
  44         Unrestricted(final BinaryTypeDefinition typeDef) {
  45             super(typeDef);
  46         }
  47
  48         @Override
  49         void validate(final byte[] value) {
  50             // No-op
  51         }
  52     }
  53
  54     BinaryStringCodec(final BinaryTypeDefinition typeDef) {
  55         super(Optional.of(typeDef), byte[].class);
  56     }
  57
  58     public static BinaryStringCodec from(final BinaryTypeDefinition type) {
  59         final java.util.Optional<LengthConstraint> optConstraint = type.getLengthConstraint();
  60         return optConstraint.isPresent() ? new Restricted(type, optConstraint.get()) : new Unrestricted(type);
  61     }
  62
  63     @Override
  64     public String serialize(final byte[] data) {
  65         return data == null ? "" : Base64.getEncoder().encodeToString(data);
  66     }
  67
  68     @Override
  69     public byte[] deserialize(final String stringRepresentation) {
  70         if (stringRepresentation == null) {
  71             return null;
  72         }
  73
  74         final byte[] ret = DatatypeConverter.parseBase64Binary(stringRepresentation);
  75         validate(ret);
  76         return ret;
  77     }
  78
  79     abstract void validate(byte[] value);
  80 }