io.jsync.http.HttpClientResponse Maven / Gradle / Ivy
Show all versions of jsync.io Show documentation
/*
* Copyright (c) 2011-2013 The original author or authors
* ------------------------------------------------------
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* and Apache License v2.0 which accompanies this distribution.
*
* The Eclipse Public License is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* The Apache License v2.0 is available at
* http://www.opensource.org/licenses/apache2.0.php
*
* You may elect to redistribute this code under either of these licenses.
*/
package io.jsync.http;
import io.jsync.Handler;
import io.jsync.MultiMap;
import io.jsync.buffer.Buffer;
import io.jsync.net.NetSocket;
import io.jsync.streams.ReadStream;
import java.util.List;
/**
* Represents a client-side HTTP response.
* An instance is provided to the user via a {@link io.jsync.Handler}
* instance that was specified when one of the HTTP method operations, or the
* generic {@link HttpClient#request(String, String, io.jsync.Handler)}
* method was called on an instance of {@link HttpClient}.
* It implements {@link io.jsync.streams.ReadStream} so it can be used with
* {@link io.jsync.streams.Pump} to pump data with flow control.
* Instances of this class are not thread-safe.
*
* @author Tim Fox
*/
public interface HttpClientResponse extends ReadStream {
/**
* The HTTP status code of the response
*/
int statusCode();
/**
* The HTTP status message of the response
*/
String statusMessage();
/**
* @return The HTTP headers
*/
MultiMap headers();
/**
* @return The HTTP trailers
*/
MultiMap trailers();
/**
* @return The Set-Cookie headers (including trailers)
*/
List cookies();
/**
* Convenience method for receiving the entire request body in one piece. This saves the user having to manually
* set a data and end handler and append the chunks of the body until the whole body received.
* Don't use this if your request body is large - you could potentially run out of RAM.
*
* @param bodyHandler This handler will be called after all the body has been received
*/
HttpClientResponse bodyHandler(Handler bodyHandler);
/**
* Get a net socket for the underlying connection of this request. USE THIS WITH CAUTION!
* Writing to the socket directly if you don't know what you're doing can easily break the HTTP protocol
*
* One valid use-case for calling this is to receive the {@link NetSocket} after a HTTP CONNECT was issued to the
* remote peer and it responded with a status code of 200.
*
* @return the net socket
*/
NetSocket netSocket();
}