Package org.apache.juneau.rest.staticfile

Class BasicStaticFiles

java.lang.Object

org.apache.juneau.rest.staticfile.BasicStaticFiles

All Implemented Interfaces:

FileFinder, StaticFiles

public class BasicStaticFiles
extends Object
implements StaticFiles

API for retrieving localized static files from either the classpath or file system.

Provides the same functionality as BasicFileFinder but adds support for returning files as HttpResource objects with arbitrary headers.

See Also:

• Static files

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.juneau.rest.staticfile.StaticFiles

StaticFiles.Builder, StaticFiles.Void

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BasicStaticFiles()	Constructor.
	BasicStaticFiles(BeanStore beanStore)	Constructor.
	BasicStaticFiles(StaticFiles.Builder builder)	Constructor.

Method Summary

Modifier and Type	Method	Description
static StaticFiles.Builder	create(BeanStore beanStore)	Creates a new builder for this object.
boolean	equals(Object o)
Optional<InputStream>	getStream(String name, Locale locale)	Returns the contents of the resource with the specified name.
Optional<String>	getString(String name, Locale locale)	Returns the file with the specified name as a string.
int	hashCode()
Optional<HttpResource>	resolve(String path, Locale locale)	Resolve the specified path.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

BasicStaticFiles

public BasicStaticFiles(BeanStore beanStore)

Constructor.

Parameters:

beanStore - The bean store containing injectable beans for this logger.

BasicStaticFiles

public BasicStaticFiles(StaticFiles.Builder builder)

Constructor.

Parameters:

builder - The builder object.

BasicStaticFiles

protected BasicStaticFiles()

Constructor.

Can be used when subclassing and overriding the resolve(String, Locale) method.

Method Details

create

public static StaticFiles.Builder create(BeanStore beanStore)

Creates a new builder for this object.

Parameters:

beanStore - The bean store to use for creating beans.

Returns:

A new builder for this object.

resolve

public Optional<HttpResource> resolve(String path,
 Locale locale)

Resolve the specified path.

Subclasses can override this method to provide specialized handling.

Specified by:

resolve in interface StaticFiles

Parameters:

path - The path to resolve to a static file.

locale - Optional locale.

Returns:

The resource, or null if not found.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

getStream

public Optional<InputStream> getStream(String name,
 Locale locale)
                                throws IOException

Description copied from interface: FileFinder

Returns the contents of the resource with the specified name.

Specified by:

getStream in interface FileFinder

Parameters:

name - The resource name. See Class.getResource(String) for format.

locale - The locale of the resource to retrieve.
If null, won't look for localized file names.

Returns:

The resolved resource contents, or null if the resource was not found.

Throws:

IOException - Thrown by underlying stream.

getString

public Optional<String> getString(String name,
 Locale locale)
                           throws IOException

Description copied from interface: FileFinder

Returns the file with the specified name as a string.

Specified by:

getString in interface FileFinder

Parameters:

name - The file name.

locale - The locale of the resource to retrieve.
If null, won't look for localized file names.

Returns:

The contents of the file as a string. Assumes UTF-8 encoding.

Throws:

IOException - If file could not be read.

toString

public String toString()

Overrides:

toString in class Object