groovyx.net.http.optional

Class Download

java.lang.Object

groovyx.net.http.optional.Download

public class Download
extends java.lang.Object

Helper methods used to assist in downloading remote content.

def http = HttpBuilder.configure {
    request.uri = 'http://example.com/download/foo.zip
}
File file = http.get { Download.toTempFile(delegate) }

The example will use a GET request to download the content as a temporary file and return the handle. The delegate property is a reference to the Closure delegate, which in our case is an instance of HttpConfig.

Any other configuration of the builder must be done in the configure closure.

Constructor Summary

Constructors

Constructor and Description
Download()

Method Summary

Modifier and Type	Method and Description
static void	toFile(HttpConfig config, java.io.File file) Downloads the content to a specified file.
static void	toFile(HttpConfig config, java.lang.String contentType, java.io.File file) Downloads the content to a specified file with the specified content type.
static void	toStream(HttpConfig config, java.io.OutputStream ostream) Downloads the content into an OutputStream.
static void	toStream(HttpConfig config, java.lang.String contentType, java.io.OutputStream ostream) Downloads the content into an OutputStream with the specified content type.
static void	toTempFile(HttpConfig config) Downloads the content to a temporary file (*.tmp in the system temp directory).
static void	toTempFile(HttpConfig config, java.lang.String contentType) Downloads the content to a temporary file (*.tmp in the system temp directory) with the specified content type.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Download

public Download()

Method Detail

toTempFile

public static void toTempFile(HttpConfig config)

Downloads the content to a temporary file (*.tmp in the system temp directory).

Parameters:

config - the HttpConfig instance

toTempFile

public static void toTempFile(HttpConfig config,
                              java.lang.String contentType)

Downloads the content to a temporary file (*.tmp in the system temp directory) with the specified content type.

Parameters:

config - the HttpConfig instance

contentType - the content type

toFile

public static void toFile(HttpConfig config,
                          java.io.File file)

Downloads the content to a specified file.

Parameters:

config - the HttpConfig instance

file - the file where content will be downloaded

toFile

public static void toFile(HttpConfig config,
                          java.lang.String contentType,
                          java.io.File file)

Downloads the content to a specified file with the specified content type.

Parameters:

config - the HttpConfig instance

file - the file where content will be downloaded

contentType - the content type

toStream

public static void toStream(HttpConfig config,
                            java.io.OutputStream ostream)

Downloads the content into an OutputStream.

Parameters:

config - the HttpConfig instance

ostream - the OutputStream to contain the content.

toStream

public static void toStream(HttpConfig config,
                            java.lang.String contentType,
                            java.io.OutputStream ostream)

Downloads the content into an OutputStream with the specified content type.

Parameters:

config - the HttpConfig instance

ostream - the OutputStream to contain the content.

contentType - the content type