Package net.officefloor.web.resource.impl

Class HttpFileImpl

java.lang.Object

net.officefloor.web.resource.impl.AbstractHttpResource

net.officefloor.web.resource.impl.HttpFileImpl

All Implemented Interfaces:

Closeable, AutoCloseable, FileCompleteCallback, HttpFile, HttpResource

public class HttpFileImpl
extends AbstractHttpResource
implements HttpFile, FileCompleteCallback

Abstract HttpFile implementation.

Author:

Daniel Sagenschneider

Field Summary

Fields inherited from class net.officefloor.web.resource.impl.AbstractHttpResource

path

Constructor Summary

Constructors

Constructor	Description
HttpFileImpl(String path, Path cleanupResourcePath, FileChannel file, HttpHeaderValue contentEncoding, HttpHeaderValue contentType, Charset charset)	Initiate an existing HttpFile.

Method Summary

Modifier and Type	Method	Description
void	close()
void	complete(FileChannel file, boolean isWritten)	Invoked on completion of writing the FileChannel content.
Charset	getCharset()	Obtains the Charset for the contents.
HttpHeaderValue	getContentEncoding()	Obtains the Content-Encoding for this HttpFile.
HttpHeaderValue	getContentType()	Obtains the Content-Type for this HttpFile.
boolean	isExist()	Indicates if this HttpResource exists.
void	writeTo(HttpResponse response)	Writes the HttpFile to the HttpResponse.

Methods inherited from class net.officefloor.web.resource.impl.AbstractHttpResource

equals, getPath, hashCode

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.officefloor.web.resource.HttpResource

getPath

Constructor Details

HttpFileImpl

public HttpFileImpl(String path,
 Path cleanupResourcePath,
 FileChannel file,
 HttpHeaderValue contentEncoding,
 HttpHeaderValue contentType,
 Charset charset)

Initiate an existing HttpFile.

Parameters:

path - Path.

cleanupResourcePath - Resource Path to clean up. May be null.

file - FileChannel to the file.

contentEncoding - Content-Encoding.

contentType - Content-Type.

charset - Charset.

Method Details

isExist

public boolean isExist()

Description copied from interface: HttpResource

Indicates if this HttpResource exists. Should this HttpResource not exist, only the path will be available.

This allows for caching of HttpResource instances not existing.

Specified by:

isExist in interface HttpResource

Returns:

true if this HttpResource exists.

getContentEncoding

public HttpHeaderValue getContentEncoding()

Description copied from interface: HttpFile

Obtains the Content-Encoding for this HttpFile.

Specified by:

getContentEncoding in interface HttpFile

Returns:

Content-Encoding for this HttpFile.

See Also:

• ResourceTransformer

getContentType

public HttpHeaderValue getContentType()

Description copied from interface: HttpFile

Obtains the Content-Type for this HttpFile.

Specified by:

getContentType in interface HttpFile

Returns:

Content-Type for this HttpFile.

See Also:

• FileTypeDetector

getCharset

public Charset getCharset()

Description copied from interface: HttpFile

Obtains the Charset for the contents.

Specified by:

getCharset in interface HttpFile

Returns:

Charset or null if contents are not text or the Charset is unknown.

See Also:

• ResourceSystem
• ResourceSystemContext

writeTo

public void writeTo(HttpResponse response)
             throws IOException

Writes the HttpFile to the HttpResponse.

Specified by:

writeTo in interface HttpFile

Parameters:

response - HttpResponse

Throws:

IOException - If fails to write the HttpFile.

complete

public void complete(FileChannel file,
 boolean isWritten)
              throws IOException

Description copied from interface: FileCompleteCallback

Invoked on completion of writing the FileChannel content.

Note that may also be invoked if content was not written (rather cancelled).

Typical use is to close the FileChannel once complete.

WARNING: this is typically invoked on the SocketChannel Thread so should not invoke any long running operations.

Specified by:

complete in interface FileCompleteCallback

Parameters:

file - FileChannel from the write.

isWritten - true indicates whether written, while false indicates cancelled.

Throws:

IOException - If issue in interacting with FileChannel.

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException