Package net.officefloor.web.resource.impl

Class HttpResourceStoreImpl

java.lang.Object

net.officefloor.web.resource.impl.HttpResourceStoreImpl

All Implemented Interfaces:

Closeable, AutoCloseable, HttpResourceStore, ResourceSystemContext

public class HttpResourceStoreImpl
extends Object
implements HttpResourceStore, ResourceSystemContext, Closeable

HttpResourceStore implementation.

Author:

Daniel Sagenschneider

Constructor Summary

Constructors

Constructor	Description
HttpResourceStoreImpl(String location, ResourceSystemFactory resourceSystemService, FileCacheFactory fileCacheFactory, ResourceTransformer[] transformers, String[] directoryDefaultResourceNames)	Instantiate.

Method Summary

Modifier and Type	Method	Description
void	close()
Path	createDirectory(String name)	Creates a new directory.
Path	createFile(String name)	Creates a new file.
HttpResourceCache	getCache()	Obtains the HttpResourceCache.
HttpFile	getDefaultHttpFile(HttpDirectory directory)	Obtains the default HttpFile for the HttpDirectory.
String[]	getDirectoryDefaultResourceNames()	Obtains the directory default resource names.
HttpResource	getHttpResource(String path)	Obtains the HttpResource.
HttpResourceStore	getHttpResourceStore()	Obtains the HttpResourceStore.
String	getLocation()	Obtains the location for the ResourceSystem.
void	notifyResourceChanged(String resourcePath)	Allows the ResourceSystem to notify that a resource has changed.
void	setCharset(Charset charset)	Specifies the Charset for files within the ResourceSystem.

Methods inherited from class java.lang.Object

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

Constructor Details

HttpResourceStoreImpl

public HttpResourceStoreImpl(String location,
 ResourceSystemFactory resourceSystemService,
 FileCacheFactory fileCacheFactory,
 ResourceTransformer[] transformers,
 String[] directoryDefaultResourceNames)
                      throws IOException

Instantiate.

Parameters:

location - Location for the ResourceSystemContext.

resourceSystemService - ResourceSystemFactory.

fileCacheFactory - FileCacheFactory.

transformers - ResourceTransformer instances.

directoryDefaultResourceNames - Directory default resource names.

Throws:

IOException - If fails to instantiate the HttpResourceStore.

Method Details

getCache

public HttpResourceCache getCache()

Obtains the HttpResourceCache.

Returns:

HttpResourceCache.

getHttpResource

public HttpResource getHttpResource(String path)
                             throws IOException

Description copied from interface: HttpResourceStore

Obtains the HttpResource.

Specified by:

getHttpResource in interface HttpResourceStore

Parameters:

path - Path to the HttpResource.

Returns:

HttpResource.

Throws:

IOException - If failure in finding the HttpResource.

getDefaultHttpFile

public HttpFile getDefaultHttpFile(HttpDirectory directory)
                            throws IOException

Description copied from interface: HttpResourceStore

Obtains the default HttpFile for the HttpDirectory.

Specified by:

getDefaultHttpFile in interface HttpResourceStore

Parameters:

directory - HttpDirectory.

Returns:

HttpFile for the HttpDirectory or null if no default HttpFile.

Throws:

IOException - If failure in obtaining default HttpFile.

getLocation

public String getLocation()

Description copied from interface: ResourceSystemContext

Obtains the location for the ResourceSystem.

The location is a free text value that is interpreted specific to the ResourceSystem implementation. For example:

• path to a directory of a file system
• class path prefix
• etc

Specified by:

getLocation in interface ResourceSystemContext

Returns:

Location for the ResourceSystem.

getDirectoryDefaultResourceNames

public String[] getDirectoryDefaultResourceNames()

Description copied from interface: ResourceSystemContext

Obtains the directory default resource names.

Specified by:

getDirectoryDefaultResourceNames in interface ResourceSystemContext

Returns:

Directory default resource names.

getHttpResourceStore

public HttpResourceStore getHttpResourceStore()

Description copied from interface: ResourceSystemContext

Obtains the HttpResourceStore.

Specified by:

getHttpResourceStore in interface ResourceSystemContext

Returns:

HttpResourceStore.

createFile

public Path createFile(String name)
                throws IOException

Description copied from interface: ResourceSystemContext

Creates a new file.

All files required should be created via this method. This is to ensure the files are managed.

Specified by:

createFile in interface ResourceSystemContext

Parameters:

name - Name to aid in identifying the file for debugging.

Returns:

Path to the new file.

Throws:

IOException - If fails to create the new file.

createDirectory

public Path createDirectory(String name)
                     throws IOException

Description copied from interface: ResourceSystemContext

Creates a new directory.

All directories should be created via this method. THis is to ensure the directories are managed.

Specified by:

createDirectory in interface ResourceSystemContext

Parameters:

name - Name to aid in identifying the directory for debugging.

Returns:

Path to the new directory.

Throws:

IOException - If fails to create the new directory.

setCharset

public void setCharset(Charset charset)

Description copied from interface: ResourceSystemContext

Specifies the Charset for files within the ResourceSystem.

This is optional to invoke. If not configured (or configured with null) then the Charset.defaultCharset() will be used as the Charset for the files.

Specified by:

setCharset in interface ResourceSystemContext

Parameters:

charset - Charset of the files within the ResourceSystem.

notifyResourceChanged

public void notifyResourceChanged(String resourcePath)

Description copied from interface: ResourceSystemContext

Allows the ResourceSystem to notify that a resource has changed.

The HttpResourceStore will then discard the HttpResource for the path. Should the path be null then all HttpResource instances are discarded.

Specified by:

notifyResourceChanged in interface ResourceSystemContext

Parameters:

resourcePath - Path for the resource. If null then all resources will be discarded.

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException