001package ca.uhn.fhir.rest.api.server;
002
003/*
004 * #%L
005 * HAPI FHIR - Server Framework
006 * %%
007 * Copyright (C) 2014 - 2022 Smile CDR, Inc.
008 * %%
009 * Licensed under the Apache License, Version 2.0 (the "License");
010 * you may not use this file except in compliance with the License.
011 * You may obtain a copy of the License at
012 *
013 *      http://www.apache.org/licenses/LICENSE-2.0
014 *
015 * Unless required by applicable law or agreed to in writing, software
016 * distributed under the License is distributed on an "AS IS" BASIS,
017 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
018 * See the License for the specific language governing permissions and
019 * limitations under the License.
020 * #L%
021 */
022
023import ca.uhn.fhir.rest.api.MethodOutcome;
024import ca.uhn.fhir.rest.api.SummaryEnum;
025import org.hl7.fhir.instance.model.api.IBaseBinary;
026import org.hl7.fhir.instance.model.api.IBaseResource;
027import org.hl7.fhir.instance.model.api.IIdType;
028import org.hl7.fhir.instance.model.api.IPrimitiveType;
029
030import java.io.IOException;
031import java.io.Writer;
032import java.util.Date;
033import java.util.List;
034import java.util.Map;
035import java.util.Set;
036
037public interface IRestfulResponse {
038
039        Object streamResponseAsResource(IBaseResource theActualResourceToReturn, boolean thePrettyPrint, Set<SummaryEnum> theSummaryMode, int theStatusCode, String theStatusMessage, boolean theRespondGzip, boolean theAddContentLocation) throws IOException;
040
041        /**
042         * This is only used for DSTU1 getTags operations, so it can be removed at some point when we
043         * drop DSTU1
044         */
045        Object returnResponse(ParseAction<?> outcome, int operationStatus, boolean allowPrefer, MethodOutcome response, String resourceName) throws IOException;
046
047        Writer getResponseWriter(int theStatusCode, String theStatusMessage, String theContentType, String theCharset, boolean theRespondGzip) throws IOException;
048
049        Object sendWriterResponse(int status, String contentType, String charset, Writer writer) throws IOException;
050
051        void addHeader(String headerKey, String headerValue);
052
053        Object sendAttachmentResponse(IBaseBinary bin, int stausCode, String contentType) throws IOException;
054
055        void setOperationResourceLastUpdated(IPrimitiveType<Date> theOperationResourceLastUpdated);
056
057        Map<String, List<String>> getHeaders();
058
059        void setOperationResourceId(IIdType theOperationResourceId);
060
061}