Package org.apache.juneau.http.resource

Class FileResource

java.lang.Object

org.apache.juneau.http.resource.BasicResource

org.apache.juneau.http.resource.FileResource

All Implemented Interfaces:

HttpEntity, HttpResource

public class FileResource
extends BasicResource

A repeatable resource that obtains its content from a File.

See Also:

• juneau-rest-common

Constructor Summary

Constructors

Modifier	Constructor	Description
	FileResource()	Constructor.
	FileResource(ContentType contentType, File contents)	Constructor.
protected	FileResource(FileResource copyFrom)	Copy constructor.

Method Summary

Modifier and Type	Method	Description
FileResource	copy()	Creates a builder for this class initialized with the contents of this bean.
FileResource	setCached()	Specifies that the contents of this resource should be cached into an internal byte array so that it can be read multiple times.
FileResource	setChunked()	Sets the 'chunked' flag value to true.
FileResource	setChunked(boolean value)	Sets the 'chunked' flag value.
FileResource	setContent(Object value)	Sets the content on this entity bean.
FileResource	setContent(Supplier<?> value)	Sets the content on this entity bean from a supplier.
FileResource	setContentEncoding(String value)	Sets the content encoding header on this entity bean.
FileResource	setContentEncoding(ContentEncoding value)	Sets the content encoding header on this entity bean.
FileResource	setContentLength(long value)	Sets the content length on this entity bean.
FileResource	setContentType(String value)	Sets the content type on this entity bean.
FileResource	setContentType(ContentType value)	Sets the content type on this entity bean.
FileResource	setHeaders(HeaderList value)	Sets the specified headers in this builder.
FileResource	setUnmodifiable()	Specifies whether this bean should be unmodifiable.

Methods inherited from class org.apache.juneau.http.resource.BasicResource

addHeader, addHeaders, asBytes, assertBytes, assertModifiable, assertString, asString, consumeContent, copyFrom, getContent, getContentEncoding, getContentLength, getContentType, getEntity, getHeaders, isChunked, isRepeatable, isStreaming, isUnmodifiable, setHeader, setHeaders, writeTo

Methods inherited from class java.lang.Object

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

Constructor Details

FileResource

public FileResource()

Constructor.

FileResource

public FileResource(ContentType contentType,
 File contents)

Constructor.

Parameters:

contentType - The entity content type.

contents - The entity contents.

FileResource

protected FileResource(FileResource copyFrom)

Copy constructor.

Parameters:

copyFrom - The bean being copied.

Method Details

copy

public FileResource copy()

Description copied from class: BasicResource

Creates a builder for this class initialized with the contents of this bean.

Allows you to create a modifiable copy of this bean.

Overrides:

copy in class BasicResource

Returns:

A new builder bean.

setCached

public FileResource setCached()
                       throws IOException

Description copied from class: BasicResource

Specifies that the contents of this resource should be cached into an internal byte array so that it can be read multiple times.

Overrides:

setCached in class BasicResource

Returns:

This object.

Throws:

IOException - If entity could not be read into memory.

setChunked

public FileResource setChunked()

Description copied from class: BasicResource

Sets the 'chunked' flag value to true.

Notes:

• If the HttpEntity.getContentLength() method returns a negative value, the HttpClient code will always use chunked encoding.

Overrides:

setChunked in class BasicResource

Returns:

This object.

setChunked

public FileResource setChunked(boolean value)

Description copied from class: BasicResource

Sets the 'chunked' flag value.

Notes:

• If the HttpEntity.getContentLength() method returns a negative value, the HttpClient code will always use chunked encoding.

Overrides:

setChunked in class BasicResource

Parameters:

value - The new value for this flag.

Returns:

This object.

setContent

public FileResource setContent(Object value)

Description copied from class: BasicResource

Sets the content on this entity bean.

Overrides:

setContent in class BasicResource

Parameters:

value - The entity content, can be null.

Returns:

This object.

setContent

public FileResource setContent(Supplier<?> value)

Description copied from class: BasicResource

Sets the content on this entity bean from a supplier.

Repeatable entities such as StringEntity use this to allow the entity content to be resolved at serialization time.

Overrides:

setContent in class BasicResource

Parameters:

value - The entity content, can be null.

Returns:

This object.

setContentEncoding

public FileResource setContentEncoding(String value)

Description copied from class: BasicResource

Sets the content encoding header on this entity bean.

Overrides:

setContentEncoding in class BasicResource

Parameters:

value - The new Content-Encoding header, or null to unset.

Returns:

This object.

setContentEncoding

public FileResource setContentEncoding(ContentEncoding value)

Description copied from class: BasicResource

Sets the content encoding header on this entity bean.

Overrides:

setContentEncoding in class BasicResource

Parameters:

value - The new Content-Encoding header, or null to unset.

Returns:

This object.

setContentLength

public FileResource setContentLength(long value)

Description copied from class: BasicResource

Sets the content length on this entity bean.

Overrides:

setContentLength in class BasicResource

Parameters:

value - The new Content-Length header value, or -1 to unset.

Returns:

This object.

setContentType

public FileResource setContentType(String value)

Description copied from class: BasicResource

Sets the content type on this entity bean.

Overrides:

setContentType in class BasicResource

Parameters:

value - The new Content-Type header, or null to unset.

Returns:

This object.

setContentType

public FileResource setContentType(ContentType value)

Description copied from class: BasicResource

Sets the content type on this entity bean.

Overrides:

setContentType in class BasicResource

Parameters:

value - The new Content-Type header, or null to unset.

Returns:

This object.

setHeaders

public FileResource setHeaders(HeaderList value)

Description copied from class: BasicResource

Sets the specified headers in this builder.

Overrides:

setHeaders in class BasicResource

Parameters:

value - The new value.

Returns:

This object.

setUnmodifiable

public FileResource setUnmodifiable()

Description copied from class: BasicResource

Specifies whether this bean should be unmodifiable.

When enabled, attempting to set any properties on this bean will cause an UnsupportedOperationException.

Overrides:

setUnmodifiable in class BasicResource

Returns:

This object.