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