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.response;
014
015import java.io.*;
016
017import org.apache.juneau.rest.*;
018import org.apache.juneau.utils.*;
019
020/**
021 * Response handler for {@link InputStream} objects.
022 * 
023 * <p>
024 * Simply pipes the contents of the {@link InputStream} to {@link RestResponse#getNegotiatedOutputStream()}.
025 * 
026 * <p>
027 * Sets the <code>Content-Type</code> response header to whatever was set via {@link RestResponse#setContentType(String)}.
028 * 
029 * <h5 class='section'>See Also:</h5>
030 * <ul>
031 *    <li class='link'><a class="doclink" href="../../../../../overview-summary.html#juneau-rest-server.MethodReturnTypes">Overview &gt; juneau-rest-server &gt; Method Return Types</a>
032 * </ul>
033 */
034public final class InputStreamHandler implements ResponseHandler {
035
036   @Override /* ResponseHandler */
037   public boolean handle(RestRequest req, RestResponse res, Object output) throws IOException, RestException {
038      if (output instanceof InputStream) {
039         res.setHeader("Content-Type", res.getContentType());
040         try (OutputStream os = res.getNegotiatedOutputStream()) {
041            IOPipe.create(output, os).run();
042         }
043         return true;
044      }
045      return false;
046   }
047}