ca.uhn.fhir.jpa.binary.api.StoredDetails Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hapi-fhir-storage Show documentation
This project provides services useful for fhir repository storage. Actual repository storage services are not in this project, just the api and helper libraries.
The newest version!
/*-
 * #%L
 * HAPI FHIR Storage api
 * %%
 * Copyright (C) 2014 - 2024 Smile CDR, Inc.
 * %%
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */
package ca.uhn.fhir.jpa.binary.api;

import ca.uhn.fhir.model.api.IModelJson;
import ca.uhn.fhir.rest.server.util.JsonDateDeserializer;
import ca.uhn.fhir.rest.server.util.JsonDateSerializer;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;
import com.google.common.hash.HashingInputStream;
import jakarta.annotation.Nonnull;
import org.apache.commons.lang3.builder.ToStringBuilder;

import java.util.Date;

public class StoredDetails implements IModelJson {

	@JsonProperty(value = "binaryContentId")
	private String myBinaryContentId;

	/**
	 * This field exists to fix a break that changing this property name caused.
	 * in 7.2.0 we went from blobId to binaryContentId. However this did not consider installations using filesystem
	 * mode storage in which the data on disk was not updated, and needed to be Serialized/Deserialized at runtime.
	 * Existing stored details used `blobId`. This causes Jackson deserialization failures which are tough to recover
	 * from without manually modifying all those stored details
	 * on disk.
	 * This field is a relic to support old blobs post-upgrade to 7.2.0. It is not ever surfaced to the user, and is proxied
	 * into `myBinaryContentId` when needed.
	 */
	@JsonProperty(value = "blobId")
	private String myBlobId;

	@JsonProperty("bytes")
	private long myBytes;

	@JsonProperty("contentType")
	private String myContentType;

	@JsonProperty("hash")
	private String myHash;

	@JsonProperty("published")
	@JsonSerialize(using = JsonDateSerializer.class)
	@JsonDeserialize(using = JsonDateDeserializer.class)
	private Date myPublished;

	/**
	 * Constructor
	 */
	@SuppressWarnings("unused")
	public StoredDetails() {
		super();
	}

	/**
	 * Constructor
	 */
	public StoredDetails(
			@Nonnull String theBinaryContentId,
			long theBytes,
			@Nonnull String theContentType,
			HashingInputStream theIs,
			Date thePublished) {
		myBinaryContentId = theBinaryContentId;
		myBytes = theBytes;
		myContentType = theContentType;
		myHash = theIs.hash().toString();
		myPublished = thePublished;
	}

	@Override
	public String toString() {
		return new ToStringBuilder(this)
				.append("binaryContentId", getBinaryContentId())
				.append("bytes", myBytes)
				.append("contentType", myContentType)
				.append("hash", myHash)
				.append("published", myPublished)
				.toString();
	}

	public String getHash() {
		return myHash;
	}

	public StoredDetails setHash(String theHash) {
		myHash = theHash;
		return this;
	}

	public Date getPublished() {
		return myPublished;
	}

	public StoredDetails setPublished(Date thePublished) {
		myPublished = thePublished;
		return this;
	}

	@Nonnull
	public String getContentType() {
		return myContentType;
	}

	public StoredDetails setContentType(String theContentType) {
		myContentType = theContentType;
		return this;
	}

	@Nonnull
	public String getBinaryContentId() {
		if (myBinaryContentId == null && myBlobId != null) {
			return myBlobId;
		} else {
			return myBinaryContentId;
		}
	}

	public StoredDetails setBinaryContentId(String theBinaryContentId) {
		myBinaryContentId = theBinaryContentId;
		return this;
	}

	public long getBytes() {
		return myBytes;
	}

	public StoredDetails setBytes(long theBytes) {
		myBytes = theBytes;
		return this;
	}
}