001// ***************************************************************************************************************************
002// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  See the NOTICE file *
003// * distributed with this work for additional information regarding copyright ownership.  The ASF licenses this file        *
004// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance            *
005// * with the License.  You may obtain a copy of the License at                                                              *
006// *                                                                                                                         *
007// *  http://www.apache.org/licenses/LICENSE-2.0                                                                             *
008// *                                                                                                                         *
009// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an  *
010// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the License for the        *
011// * specific language governing permissions and limitations under the License.                                              *
012// ***************************************************************************************************************************
013package org.apache.juneau.rest.reshandlers;
014
015import java.io.*;
016
017import org.apache.juneau.rest.*;
018import org.apache.juneau.http.exception.*;
019import org.apache.juneau.utils.*;
020
021/**
022 * Response handler for {@link InputStream} objects.
023 *
024 * <p>
025 * Simply pipes the contents of the {@link InputStream} to {@link RestResponse#getNegotiatedOutputStream()}.
026 *
027 * <p>
028 * Sets the <c>Content-Type</c> response header to whatever was set via {@link RestResponse#setContentType(String)}.
029 *
030 * <ul class='seealso'>
031 *    <li class='link'>{@doc RestmReturnTypes}
032 * </ul>
033 */
034public final class InputStreamHandler implements ResponseHandler {
035
036   @Override /* ResponseHandler */
037   public boolean handle(RestRequest req, RestResponse res) throws IOException, NotAcceptable, HttpException {
038      if (res.isOutputType(InputStream.class)) {
039         try (OutputStream os = res.getNegotiatedOutputStream()) {
040            IOPipe.create(res.getOutput(InputStream.class), os).run();
041         }
042         return true;
043      }
044      return false;
045   }
046}