001package ca.uhn.fhir.rest.server;
002
003/*
004 * #%L
005 * HAPI FHIR - Core Library
006 * %%
007 * Copyright (C) 2014 - 2017 University Health Network
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 java.io.IOException;
024import java.io.UnsupportedEncodingException;
025import java.io.Writer;
026import java.util.Date;
027import java.util.Set;
028
029import org.hl7.fhir.instance.model.api.IBaseBinary;
030import org.hl7.fhir.instance.model.api.IBaseResource;
031import org.hl7.fhir.instance.model.api.IIdType;
032import org.hl7.fhir.instance.model.api.IPrimitiveType;
033
034import ca.uhn.fhir.model.api.Bundle;
035import ca.uhn.fhir.rest.api.MethodOutcome;
036import ca.uhn.fhir.rest.api.SummaryEnum;
037import ca.uhn.fhir.rest.method.ParseAction;
038
039public interface IRestfulResponse {
040
041        Object streamResponseAsResource(IBaseResource theActualResourceToReturn, boolean thePrettyPrint, Set<SummaryEnum> theSummaryMode, int theStatusCode, String theStatusMessage, boolean theRespondGzip, boolean theAddContentLocation) throws IOException;
042
043        Object streamResponseAsBundle(Bundle bundle, Set<SummaryEnum> summaryMode, boolean respondGzip, boolean requestIsBrowser) throws IOException;
044
045        /**
046         * This is only used for DSTU1 getTags operations, so it can be removed at some point when we
047         * drop DSTU1
048         */
049        Object returnResponse(ParseAction<?> outcome, int operationStatus, boolean allowPrefer, MethodOutcome response, String resourceName) throws IOException;
050
051        Writer getResponseWriter(int theStatusCode, String theStatusMessage, String theContentType, String theCharset, boolean theRespondGzip) throws UnsupportedEncodingException, IOException;
052
053        Object sendWriterResponse(int status, String contentType, String charset, Writer writer) throws IOException;
054
055        void addHeader(String headerKey, String headerValue);
056
057        Object sendAttachmentResponse(IBaseBinary bin, int stausCode, String contentType) throws IOException;
058
059        void setOperationResourceLastUpdated(IPrimitiveType<Date> theOperationResourceLastUpdated);
060
061        void setOperationResourceId(IIdType theOperationResourceId);
062
063}