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 Reader} objects.
022 * 
023 * <p>
024 * Simply pipes the contents of the {@link Reader} to {@link RestResponse#getNegotiatedWriter()}.
025 * 
026 * <h5 class='section'>See Also:</h5>
027 * <ul>
028 *    <li class='link'><a class="doclink" href="../../../../../overview-summary.html#juneau-rest-server.MethodReturnTypes">Overview &gt; juneau-rest-server &gt; Method Return Types</a>
029 * </ul>
030 */
031public final class ReaderHandler implements ResponseHandler {
032
033   @Override /* ResponseHandler */
034   public boolean handle(RestRequest req, RestResponse res, Object output) throws IOException, RestException {
035      if (output instanceof Reader) {
036         try (Writer w = res.getNegotiatedWriter()) {
037            IOPipe.create(output, w).run();
038         }
039         return true;
040      }
041      return false;
042   }
043}
044