001package org.hl7.fhir.r4.model;
002
003/*
004  Copyright (c) 2011+, HL7, Inc.
005  All rights reserved.
006  
007  Redistribution and use in source and binary forms, with or without modification, 
008  are permitted provided that the following conditions are met:
009    
010   * Redistributions of source code must retain the above copyright notice, this 
011     list of conditions and the following disclaimer.
012   * Redistributions in binary form must reproduce the above copyright notice, 
013     this list of conditions and the following disclaimer in the documentation 
014     and/or other materials provided with the distribution.
015   * Neither the name of HL7 nor the names of its contributors may be used to 
016     endorse or promote products derived from this software without specific 
017     prior written permission.
018  
019  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 
020  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
021  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
022  IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 
023  INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 
024  NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 
025  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
026  WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
027  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
028  POSSIBILITY OF SUCH DAMAGE.
029  
030 */
031
032
033
034import ca.uhn.fhir.model.api.IElement;
035import ca.uhn.fhir.parser.DataFormatException;
036import org.apache.commons.codec.binary.Base64;
037
038import ca.uhn.fhir.model.api.annotation.DatatypeDef;
039import org.hl7.fhir.instance.model.api.IBaseHasExtensions;
040import org.hl7.fhir.instance.model.api.IPrimitiveType;
041
042import java.io.Externalizable;
043import java.io.IOException;
044import java.io.ObjectInput;
045import java.io.ObjectOutput;
046
047/**
048 * Primitive type "base64Binary" in FHIR: a sequence of bytes represented in base64
049 */
050@DatatypeDef(name = "base64Binary")
051public class Base64BinaryType extends PrimitiveType<byte[]> implements IPrimitiveType<byte[]>, IBaseHasExtensions, IElement, Externalizable {
052
053  private static final long serialVersionUID = 3L;
054  private byte[] myValue;
055
056  /**
057   * Constructor
058   */
059  public Base64BinaryType() {
060    super();
061  }
062
063  public Base64BinaryType(byte[] theBytes) {
064    super();
065    setValue(theBytes);
066  }
067
068  public Base64BinaryType(String theValue) {
069    super();
070    // Null values still result in non-null instance being created
071    if (theValue != null) checkValidBase64(theValue);
072    setValueAsString(theValue);
073  }
074
075  protected byte[] parse(String theValue) {
076    if (theValue != null) {
077      return Base64.decodeBase64(theValue.getBytes(ca.uhn.fhir.rest.api.Constants.CHARSET_UTF8));
078    } else {
079      return null;
080    }
081  }
082
083  protected String encode(byte[] theValue) {
084    if (theValue == null) {
085      return null;
086    }
087    return new String(Base64.encodeBase64(theValue), ca.uhn.fhir.rest.api.Constants.CHARSET_UTF8);
088  }
089
090  @Override
091  public Base64BinaryType copy() {
092    return new Base64BinaryType(getValue());
093  }
094
095  @Override
096  protected Type typedCopy() {
097    return null;
098  }
099
100  public String fhirType() {
101    return "base64Binary";
102  }
103
104  @Override
105  public void writeExternal(ObjectOutput out) throws IOException {
106    out.writeObject(getValue());
107  }
108
109  @Override
110  public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException {
111    setValue((byte[]) in.readObject());
112  }
113
114  @Override
115  public String getValueAsString() {
116    return encode(myValue);
117  }
118
119  @Override
120  public void setValueAsString(String theValue) throws IllegalArgumentException {
121    fromStringValue(theValue);
122    setValue(parse(theValue));
123  }
124
125  @Override
126  public byte[] getValue() {
127    return myValue;
128  }
129
130  @Override
131  public Base64BinaryType setValue(byte[] theValue) throws IllegalArgumentException {
132    myValue = theValue;
133    return this;
134  }
135
136  @Override
137  public boolean hasValue() {
138    return myValue != null && myValue.length > 0;
139  }
140
141  @Override
142  public boolean isEmpty() {
143    // Custom isEmpty() in order to avoid generating the text representation unneccessarily
144    return ca.uhn.fhir.util.ElementUtil.isEmpty(id, extension) && !hasValue();
145  }
146
147  /**
148   * Checks if the passed in String is a valid {@link Base64} encoded String. Will throw a {@link DataFormatException} if not
149   * formatted correctly.
150   *
151   * @param toCheck {@link String} to check if valid {@link Base64}
152   * @throws DataFormatException
153   */
154  public void checkValidBase64(String toCheck) throws DataFormatException {
155    if (!Base64.isBase64(toCheck.getBytes())) {
156      throw new DataFormatException("");
157    }
158  }
159}