com.github.sdorra.webresources

Class WebResourceSender

java.lang.Object

com.github.sdorra.webresources.WebResourceSender

public final class WebResourceSender
extends Object

Serves WebResource over http, using the servlet api.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	WebResourceSender.Sender Sends a web resource to client using the servlet api.

Method Summary

Modifier and Type	Method and Description
static WebResourceSender	create() Creates new WebResourceSender.
WebResourceSender.Sender	resource(File file) Creates a WebResource for the file and calls resource(WebResource).
WebResourceSender.Sender	resource(Path path) Creates a WebResource for the path and calls resource(WebResource).
WebResourceSender.Sender	resource(URL url) Creates a WebResource for the url and calls resource(WebResource).
WebResourceSender.Sender	resource(WebResource webResource) Creates sender for the given web resource.
WebResourceSender	withBufferSize(int bufferSize) Sets the size of used buffers.
WebResourceSender	withExpires(long count, TimeUnit unit) Sets the default expiration date for the resources.
WebResourceSender	withGZIP() Enables gzip compression.
WebResourceSender	withGZIPMinLength(long minLength) Sets the minimum required content length for gzip compression.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static WebResourceSender create()

Creates new WebResourceSender.

Returns:

new web resource sender

withGZIP

public WebResourceSender withGZIP()

Enables gzip compression.

Returns:

this

withBufferSize

public WebResourceSender withBufferSize(int bufferSize)

Sets the size of used buffers.

Parameters:

bufferSize - size of buffer

Returns:

this

withExpires

public WebResourceSender withExpires(long count,
                                     TimeUnit unit)

Sets the default expiration date for the resources.

Parameters:

count - count

unit - time unit

Returns:

this

withGZIPMinLength

public WebResourceSender withGZIPMinLength(long minLength)

Sets the minimum required content length for gzip compression. Requires enabled gzip compression with #withGZIP.

Parameters:

minLength - required minimum content length

Returns:

this

resource

public WebResourceSender.Sender resource(Path path)
                                  throws IOException

Creates a WebResource for the path and calls resource(WebResource).

Parameters:

path - path

Returns:

sender

Throws:

IOException - if web resource could not be created

resource

public WebResourceSender.Sender resource(File file)
                                  throws IOException

Creates a WebResource for the file and calls resource(WebResource).

Parameters:

file - path

Returns:

sender

Throws:

IOException - if web resource could not be created

resource

public WebResourceSender.Sender resource(URL url)
                                  throws IOException

Creates a WebResource for the url and calls resource(WebResource).

Parameters:

url - url

Returns:

sender

Throws:

IOException - if web resource could not be created

resource

public WebResourceSender.Sender resource(WebResource webResource)

Creates sender for the given web resource.

Parameters:

webResource - web resource

Returns:

sender