ca.uhn.fhir.rest.api.MethodOutcome Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hapi-fhir-base Show documentation
Builds the hapi fhir base. Requires Common lang, commons-text, and guava be built first.
There is a newer version: 7.0.2-r12
/*
 * #%L
 * HAPI FHIR - Core Library
 * %%
 * 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.rest.api;

import ca.uhn.fhir.util.CoverageIgnore;
import org.apache.commons.lang3.Validate;
import org.hl7.fhir.instance.model.api.IBaseOperationOutcome;
import org.hl7.fhir.instance.model.api.IBaseResource;
import org.hl7.fhir.instance.model.api.IIdType;

import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Optional;

public class MethodOutcome {

	private Boolean myCreated;
	private IIdType myId;
	private IBaseOperationOutcome myOperationOutcome;
	private IBaseResource myResource;
	private Map> myResponseHeaders;
	private Collection myResourceViewCallbacks;
	private Integer myResponseStatusCode;

	/**
	 * Constructor
	 */
	public MethodOutcome() {
		super();
	}

	/**
	 * Constructor
	 *
	 * @param theId      The ID of the created/updated resource
	 * @param theCreated If not null, indicates whether the resource was created (as opposed to being updated). This is generally not needed, since the server can assume based on the method being called
	 *                   whether the result was a creation or an update. However, it can be useful if you are implementing an update method that does a create if the ID doesn't already exist.
	 */
	@CoverageIgnore
	public MethodOutcome(IIdType theId, Boolean theCreated) {
		myId = theId;
		myCreated = theCreated;
	}

	/**
	 * Constructor
	 *
	 * @param theId                   The ID of the created/updated resource
	 * @param theBaseOperationOutcome The operation outcome to return with the response (or null for none)
	 */
	public MethodOutcome(IIdType theId, IBaseOperationOutcome theBaseOperationOutcome) {
		myId = theId;
		myOperationOutcome = theBaseOperationOutcome;
	}

	/**
	 * Constructor
	 *
	 * @param theId                   The ID of the created/updated resource
	 * @param theBaseOperationOutcome The operation outcome to return with the response (or null for none)
	 * @param theCreated              If not null, indicates whether the resource was created (as opposed to being updated). This is generally not needed, since the server can assume based on the method being called
	 *                                whether the result was a creation or an update. However, it can be useful if you are implementing an update method that does a create if the ID doesn't already exist.
	 */
	public MethodOutcome(IIdType theId, IBaseOperationOutcome theBaseOperationOutcome, Boolean theCreated) {
		myId = theId;
		myOperationOutcome = theBaseOperationOutcome;
		myCreated = theCreated;
	}

	/**
	 * Constructor
	 *
	 * @param theId The ID of the created/updated resource
	 */
	public MethodOutcome(IIdType theId) {
		myId = theId;
	}

	/**
	 * Constructor
	 *
	 * @param theOperationOutcome The operation outcome resource to return
	 */
	public MethodOutcome(IBaseOperationOutcome theOperationOutcome) {
		myOperationOutcome = theOperationOutcome;
	}

	/**
	 * This will be set to {@link Boolean#TRUE} for instance of MethodOutcome which are
	 * returned to client instances, if the server has responded with an HTTP 201 Created.
	 */
	public Boolean getCreated() {
		return myCreated;
	}

	/**
	 * If not null, indicates whether the resource was created (as opposed to being updated). This is generally not needed, since the server can assume based on the method being called whether the
	 * result was a creation or an update. However, it can be useful if you are implementing an update method that does a create if the ID doesn't already exist.
	 * 
	 * Users of HAPI should only interact with this method in Server applications
	 * 
	 *
	 * @param theCreated If not null, indicates whether the resource was created (as opposed to being updated). This is generally not needed, since the server can assume based on the method being called
	 *                   whether the result was a creation or an update. However, it can be useful if you are implementing an update method that does a create if the ID doesn't already exist.
	 * @return Returns a reference to this for easy method chaining
	 */
	public MethodOutcome setCreated(Boolean theCreated) {
		myCreated = theCreated;
		return this;
	}

	public IIdType getId() {
		return myId;
	}

	/**
	 * @param theId The ID of the created/updated resource
	 * @return Returns a reference to this for easy method chaining
	 */
	public MethodOutcome setId(IIdType theId) {
		myId = theId;
		return this;
	}

	/**
	 * Returns the {@link IBaseOperationOutcome} resource to return to the client or null if none.
	 *
	 * @return This method will return null, unlike many methods in the API.
	 */
	public IBaseOperationOutcome getOperationOutcome() {
		return myOperationOutcome;
	}

	/**
	 * Sets the {@link IBaseOperationOutcome} resource to return to the client. Set to null (which is the default) if none.
	 *
	 * @return Returns a reference to this for easy method chaining
	 */
	public MethodOutcome setOperationOutcome(IBaseOperationOutcome theBaseOperationOutcome) {
		myOperationOutcome = theBaseOperationOutcome;
		return this;
	}

	/**
	 * From a client response: If the method returned an actual resource body (e.g. a create/update with
	 * "Prefer: return=representation") this field will be populated with the
	 * resource itself.
	 */
	public IBaseResource getResource() {
		return myResource;
	}

	/**
	 * In a server response: This field may be populated in server code with the final resource for operations
	 * where a resource body is being created/updated. E.g. for an update method, this field could be populated with
	 * the resource after the update is applied, with the new version ID, lastUpdate time, etc.
	 * 
	 * This field is optional, but if it is populated the server will return the resource body if requested to
	 * do so via the HTTP Prefer header.
	 * 
	 *
	 * @return Returns a reference to this for easy method chaining
	 * @see #registerResourceViewCallback(Runnable) to register a callback that should be invoked by the framework before the resource is shown/returned to a client
	 */
	public MethodOutcome setResource(IBaseResource theResource) {
		myResource = theResource;
		return this;
	}

	/**
	 * Gets the headers for the HTTP response
	 */
	public Map> getResponseHeaders() {
		if (myResponseHeaders == null) {
			myResponseHeaders = new HashMap<>();
		}
		return myResponseHeaders;
	}

	/**
	 * Sets the headers for the HTTP response
	 */
	public void setResponseHeaders(Map> theResponseHeaders) {
		myResponseHeaders = theResponseHeaders;
	}

	public Optional getFirstResponseHeader(String theHeader) {
		List values = getResponseHeaders().get(theHeader);

		if (values == null || values.isEmpty()) {
			return Optional.empty();
		} else {
			return Optional.of(values.get(0));
		}
	}

	/**
	 * Registers a callback to be invoked before the resource in this object gets
	 * returned to the client. Note that this is an experimental API and may change.
	 *
	 * @param theCallback The callback
	 * @since 4.0.0
	 */
	public void registerResourceViewCallback(Runnable theCallback) {
		Validate.notNull(theCallback, "theCallback must not be null");

		if (myResourceViewCallbacks == null) {
			myResourceViewCallbacks = new ArrayList<>(2);
		}
		myResourceViewCallbacks.add(theCallback);
	}

	/**
	 * Fires callbacks registered to {@link #registerResourceViewCallback(Runnable)} and then
	 * clears the list of registered callbacks.
	 *
	 * @since 4.0.0
	 */
	public void fireResourceViewCallbacks() {
		if (myResourceViewCallbacks != null) {
			myResourceViewCallbacks.forEach(t -> t.run());
			myResourceViewCallbacks.clear();
		}
	}

	public void setCreatedUsingStatusCode(int theResponseStatusCode) {
		if (theResponseStatusCode == Constants.STATUS_HTTP_201_CREATED) {
			setCreated(true);
		}
	}

	protected boolean hasResource() {
		return myResource != null;
	}

	public void setResponseStatusCode(int theResponseStatusCode) {
		myResponseStatusCode = theResponseStatusCode;
	}

	public int getResponseStatusCode() {
		return isResponseStatusCodeSet() ? myResponseStatusCode : 0;
	}

	public boolean isResponseStatusCodeSet() {
		return myResponseStatusCode != null;
	}
}