Module SimpleHttpServer

Package dev.katsute.simplehttpserver.handler.file

Class FileHandler

java.lang.Object

dev.katsute.simplehttpserver.handler.file.FileHandler

All Implemented Interfaces:

HttpHandler, SimpleHttpHandler

public class FileHandler
extends Object
implements SimpleHttpHandler

A file handler can be used to serve single or multiple files on a server with optional pre/post processing using FileAdapters.

FileAdapter

A FileAdapter determines where a file can be accessed and what content it will return. By default files would be accessible at the file name (including extension) with the file content.

Adding Files

The name parameters in the add methods supersedes the FileAdapter and makes a file accessible at whatever name you set.

FileOptions

File options can be added to influence the behavior of added files.

Context

The FileOptions.context property determines at where the file will be located with respect to the file handler. By default this is "" and any added files will be accessible directly after the file handler's context.
Example: /fileHandlerContext/file.txt by default and /fileHandlerContext/optionsContext/file.txt if a context was set.

Loading Options

The FileOptions.loading option determines how a file should be loaded when added.

• FileOptions.FileLoadingOption.PRELOAD - files are read when added
• FileOptions.FileLoadingOption.MODIFY - files are read when added and when modified
• FileOptions.FileLoadingOption.CACHE - files are read when requested and cached for a set time
• FileOptions.FileLoadingOption.LIVE - files are read when requested

Cache

If the loading option FileOptions.FileLoadingOption.CACHE is used, the FileOptions.cache determines how long to cache files for in milliseconds.

Walk

When directories are added, if true, will also include subdirectories; if false, will only include files in the immediate directory.

Since:

5.0.0

Version:

5.0.0

Author:

Katsute

See Also:

• FileAdapter
• FileOptions

Constructor Summary

Constructors

Constructor	Description
FileHandler()	Creates a file handler.
FileHandler(FileAdapter adapter)	Creates a file handler, adapting the added files with an FileAdapter.

Method Summary

Modifier and Type	Method	Description
final void	addDirectory(File directory)	Adds a directory to the handler using the directory name.
final void	addDirectory(File directory, FileOptions options)	Adds a directory to the handler using the directory name from a set of file options.
final void	addDirectory(File directory, String directoryName)	Adds a directory to the handler with a set name.
final void	addDirectory(File directory, String directoryName, FileOptions options)	Adds a directory to the handler using the directory name from a set of file options.
final void	addFile(File file)	Adds a file to the handler.
final void	addFile(File file, FileOptions options)	Adds a file to the handler from a set of FileOptionss.
final void	addFile(File file, String fileName)	Adds a file to the handler with a set name.
final void	addFile(File file, String fileName, FileOptions options)	Adds a file to the handler with a set name from a set of FileOptions.
final void	addFiles(File[] files)	Adds multiple files to the handler.
final void	addFiles(File[] files, FileOptions options)	Adds multiple files to the handler from a set of FileOptions.
final void	handle(HttpExchange exchange)	Do not override this method, it will cause SimpleHttpHandler.handle(SimpleHttpExchange) to not work.
final void	handle(SimpleHttpExchange exchange)	Handles an exchange.
void	handle(SimpleHttpExchange exchange, File source, byte[] bytes)	Handles a file exchange.
final void	removeDirectory(File directory)	Removes a directory from the handler.
final void	removeDirectory(File directory, FileOptions options)	Removes a directory from the handler with file options.
final void	removeDirectory(String context)	Removes a directory from the handler at a specified context.
final void	removeFile(File file)	Removes a file from the handler.
final void	removeFile(File file, FileOptions options)	Removes a file from the handler with file options.
final void	removeFile(String context)	Removes a file from the handler at the specified context.
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

FileHandler

public FileHandler()

Creates a file handler.

Since:

5.0.0

FileHandler

public FileHandler(FileAdapter adapter)

Creates a file handler, adapting the added files with an FileAdapter.

Parameters:

adapter - file adapter

Since:

5.0.0

See Also:

• FileAdapter

Method Details

addFile

public final void addFile(File file)

Adds a file to the handler.

Parameters:

file - file to add

Since:

5.0.0

See Also:

• addFile(File, FileOptions)
• addFile(File, String)
• addFile(File, String, FileOptions)

addFile

public final void addFile(File file,
 FileOptions options)

Adds a file to the handler from a set of FileOptionss.

Parameters:

file - file to add

options - file options

Since:

5.0.0

See Also:

• FileOptions
• addFile(File)
• addFile(File, String)
• addFile(File, String, FileOptions)

addFile

public final void addFile(File file,
 String fileName)

Adds a file to the handler with a set name. Ignores the FileAdapter if set.

Parameters:

file - file to add

fileName - file name to use

Since:

5.0.0

See Also:

• addFile(File)
• addFile(File, FileOptions)
• addFile(File, String, FileOptions)

addFile

public final void addFile(File file,
 String fileName,
 FileOptions options)

Adds a file to the handler with a set name from a set of FileOptions. Ignores the FileAdapter if set.

Parameters:

file - file to add

fileName - file name to use

options - file options

Since:

5.0.0

See Also:

• FileOptions
• addFile(File)
• addFile(File, FileOptions)
• addFile(File, String)

addFiles

public final void addFiles(File[] files)

Adds multiple files to the handler.

Parameters:

files - files to add

Since:

5.0.0

See Also:

• addFiles(File[], FileOptions)

addFiles

public final void addFiles(File[] files,
 FileOptions options)

Adds multiple files to the handler from a set of FileOptions.

Parameters:

files - files to add

options - file options

Since:

5.0.0

See Also:

• FileOptions
• addFiles(File[], FileOptions)

addDirectory

public final void addDirectory(File directory)

Adds a directory to the handler using the directory name.

Parameters:

directory - directory to add

Since:

5.0.0

See Also:

• addDirectory(File, FileOptions)
• addDirectory(File, String)
• addDirectory(File, String, FileOptions)

addDirectory

public final void addDirectory(File directory,
 FileOptions options)

Adds a directory to the handler using the directory name from a set of file options.

Parameters:

directory - directory to add

options - file options

Since:

5.0.0

See Also:

• FileOptions
• addDirectory(File)
• addDirectory(File, String)
• addDirectory(File, String, FileOptions)

addDirectory

public final void addDirectory(File directory,
 String directoryName)

Adds a directory to the handler with a set name.

Parameters:

directory - directory to add

directoryName - directory name to use

Since:

5.0.0

See Also:

• addDirectory(File)
• addDirectory(File, FileOptions)
• addDirectory(File, String, FileOptions)

addDirectory

public final void addDirectory(File directory,
 String directoryName,
 FileOptions options)

Adds a directory to the handler using the directory name from a set of file options.

Parameters:

directory - directory to add

directoryName - directory name to use

options - file options

Since:

5.0.0

See Also:

• FileOptions
• addDirectory(File)
• addDirectory(File, FileOptions)
• addDirectory(File, String)

removeFile

public final void removeFile(String context)

Removes a file from the handler at the specified context.

Parameters:

context - context

Since:

5.0.0

See Also:

• removeFile(File)
• removeFile(File, FileOptions)

removeFile

public final void removeFile(File file)

Removes a file from the handler.

Parameters:

file - file to remove

Since:

5.0.0

See Also:

• removeFile(String)
• removeFile(File, FileOptions)

removeFile

public final void removeFile(File file,
 FileOptions options)

Removes a file from the handler with file options. Only required if FileOptions.context was used.

Parameters:

file - file to remove

options - file options

Since:

5.0.0

See Also:

• FileOptions
• removeFile(String)
• removeFile(File)

removeDirectory

public final void removeDirectory(String context)

Removes a directory from the handler at a specified context.

Parameters:

context - context

Since:

5.0.0

See Also:

• removeDirectory(File)
• removeDirectory(File, FileOptions)

removeDirectory

public final void removeDirectory(File directory)

Removes a directory from the handler.

Parameters:

directory - directory to remove

Since:

5.0.0

See Also:

• removeDirectory(String)
• removeDirectory(File, FileOptions)

removeDirectory

public final void removeDirectory(File directory,
 FileOptions options)

Removes a directory from the handler with file options. Only required if FileOptions.context was used.

Parameters:

directory - directory to remove

options - file options

Since:

5.0.0

See Also:

• FileOptions
• removeDirectory(String)
• removeDirectory(File)

handle

public final void handle(SimpleHttpExchange exchange)
                  throws IOException

Description copied from interface: SimpleHttpHandler

Handles an exchange.
Http handlers will not throw an exception in the main thread, you must use a try-catch to expose them. All requests must be closed with HttpExchange.close(), otherwise the handler will rerun the request multiple times.

Specified by:

handle in interface SimpleHttpHandler

Parameters:

exchange - http exchange

Throws:

IOException - IO exception

See Also:

• SimpleHttpExchange

handle

public final void handle(HttpExchange exchange)
                  throws IOException

Description copied from interface: SimpleHttpHandler

Do not override this method, it will cause SimpleHttpHandler.handle(SimpleHttpExchange) to not work. Use SimpleHttpHandler.handle(SimpleHttpExchange) instead.

Specified by:

handle in interface HttpHandler

Specified by:

handle in interface SimpleHttpHandler

Parameters:

exchange - the exchange containing the request from the client and used to send the response

Throws:

IOException - IO exception

See Also:

• SimpleHttpHandler.handle(SimpleHttpExchange)

handle

public void handle(SimpleHttpExchange exchange,
 File source,
 byte[] bytes)
            throws IOException

Handles a file exchange. The file bytes are the bytes after post processing if FileAdapter is used.

Parameters:

exchange - http exchange

source - file source

bytes - file bytes

Throws:

IOException - IO exception

Since:

5.0.0

toString

public String toString()

Overrides:

toString in class Object