001package org.hl7.fhir.dstu3.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.model.api.annotation.DatatypeDef;
036import ca.uhn.fhir.parser.DataFormatException;
037import org.apache.commons.codec.binary.Base64;
038import org.hl7.fhir.instance.model.api.IBaseHasExtensions;
039import org.hl7.fhir.instance.model.api.IPrimitiveType;
040
041import java.io.Externalizable;
042import java.io.IOException;
043import java.io.ObjectInput;
044import java.io.ObjectOutput;
045
046/**
047 * Primitive type "base64Binary" in FHIR: a sequence of bytes represented in base64
048 */
049@DatatypeDef(name = "base64Binary")
050public class Base64BinaryType extends PrimitiveType<byte[]> implements IPrimitiveType<byte[]>, IBaseHasExtensions, IElement, Externalizable {
051
052  private static final long serialVersionUID = 3L;
053  private byte[] myValue;
054
055  /**
056   * Constructor
057   */
058  public Base64BinaryType() {
059    super();
060  }
061
062  public Base64BinaryType(byte[] theBytes) {
063    super();
064    setValue(theBytes);
065  }
066
067  public Base64BinaryType(String theValue) {
068    super();
069    // Null values still result in non-null instance being created
070    if (theValue != null) checkValidBase64(theValue);
071    setValueAsString(theValue);
072  }
073
074  protected byte[] parse(String theValue) {
075    if (theValue != null) {
076      return Base64.decodeBase64(theValue.getBytes(ca.uhn.fhir.rest.api.Constants.CHARSET_UTF8));
077    } else {
078      return null;
079    }
080  }
081
082  protected String encode(byte[] theValue) {
083    if (theValue == null) {
084      return null;
085    }
086    return new String(Base64.encodeBase64(theValue), ca.uhn.fhir.rest.api.Constants.CHARSET_UTF8);
087  }
088
089  @Override
090  public Base64BinaryType copy() {
091    return new Base64BinaryType(getValue());
092  }
093
094  @Override
095  protected Type typedCopy() {
096    return copy();
097  }
098
099  public String fhirType() {
100    return "base64Binary";
101  }
102
103  @Override
104  public void writeExternal(ObjectOutput out) throws IOException {
105    out.writeObject(getValue());
106  }
107
108  @Override
109  public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException {
110    setValue((byte[]) in.readObject());
111  }
112
113  @Override
114  public String getValueAsString() {
115    return encode(myValue);
116  }
117
118  @Override
119  public void setValueAsString(String theValue) throws IllegalArgumentException {
120    fromStringValue(theValue);
121    setValue(parse(theValue));
122  }
123
124  @Override
125  public byte[] getValue() {
126    return myValue;
127  }
128
129  @Override
130  public Base64BinaryType setValue(byte[] theValue) throws IllegalArgumentException {
131    myValue = theValue;
132    return this;
133  }
134
135  @Override
136  public boolean hasValue() {
137    return myValue != null && myValue.length > 0;
138  }
139
140  @Override
141  public boolean isEmpty() {
142    // Custom isEmpty() in order to avoid generating the text representation unneccessarily
143    return ca.uhn.fhir.util.ElementUtil.isEmpty(id, extension) && !hasValue();
144  }
145
146  /**
147   * Checks if the passed in String is a valid {@link Base64} encoded String. Will throw a {@link DataFormatException} if not
148   * formatted correctly.
149   *
150   * @param toCheck {@link String} to check if valid {@link Base64}
151   * @throws DataFormatException
152   */
153  public void checkValidBase64(String toCheck) throws DataFormatException {
154    if (!Base64.isBase64(toCheck.getBytes())) {
155      throw new DataFormatException("");
156    }
157  }
158}