co.cask.http.internal.InternalHttpResponse Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of netty-http Show documentation

Netty based path router

The newest version!

/*
 * Copyright © 2017 Cask Data, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */

package co.cask.http.internal;

import java.io.IOException;
import java.io.InputStream;

/**
 * Interface used to get the status code and content from calling another handler internally.
 */
public interface InternalHttpResponse {

  int getStatusCode();

  /**
   * Opens an {@link InputStream} that contains the response content. The caller is responsible of closing the
   * returned stream.
   *
   * @return an {@link InputStream} for reading response content
   * @throws IOException if failed to open the stream
   */
  InputStream openInputStream() throws IOException;
}