com.github.wuic.nut.dao.servlet

Class WebappNutDao

java.lang.Object

com.github.wuic.util.PollingScheduler<NutDaoListener>

com.github.wuic.nut.AbstractNutDao

com.github.wuic.nut.dao.core.PathNutDao

com.github.wuic.nut.dao.servlet.WebappNutDao

All Implemented Interfaces:

NutDao, ServletContextHandler, Runnable

@NutDaoService
public class WebappNutDao
extends PathNutDao
implements ServletContextHandler

A NutDao implementation for webapp accesses.

If the war exploded, then path could be retrieved with file system access through FilePath. However, if the packaged war is used, then we have a more limited access to files. For instance, time stamp is not available on the file so we will always return '-1' for polling.

Since:

0.4.2

Version:

1.2

Author:

Guillaume DROUET

Nested Class Summary

Nested classes/interfaces inherited from class com.github.wuic.nut.AbstractNutDao

AbstractNutDao.VersionNumberStrategy, AbstractNutDao.WithRootPathNutDao

Nested classes/interfaces inherited from class com.github.wuic.util.PollingScheduler

PollingScheduler.Polling

Nested classes/interfaces inherited from interface com.github.wuic.nut.dao.NutDao

NutDao.PathFormat

Constructor Summary

Constructors

Constructor and Description
WebappNutDao(String base, String[] proxies, int pollingSeconds, Boolean regex, Boolean wildcard, Boolean contentBasedVersionNumber, Boolean computeVersionAsynchronously, String fixedVersionNumber) Builds a new instance with a base directory.

Method Summary

Methods

Modifier and Type	Method and Description
protected DirectoryPath	createBaseDirectory() Creates the DirectoryPath associated to the AbstractNutDao.basePath.
void	setServletContext(ServletContext context) Sets the servlet context.
protected List<String>	skipStartsWith() Gets the beginning of path to be skipped during research.

Methods inherited from class com.github.wuic.nut.dao.core.PathNutDao

accessFor, exists, getLastUpdateTimestampFor, getRegularExpression, getWildcardExpression, listNutsPaths, newInputStream, save, saveSupported, toString

Methods inherited from class com.github.wuic.nut.AbstractNutDao

absolutePathOf, computeRealPaths, create, create, getBasePath, getProxyUris, getVersionNumber, getVersionNumberStrategy, proxyUriFor, run, shutdown, withRootPath

Methods inherited from class com.github.wuic.util.PollingScheduler

getNutObservers, getPollingInterval, observe, setPollingInterval

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.github.wuic.nut.dao.NutDao

observe

Constructor Detail

WebappNutDao

@ConfigConstructor
public WebappNutDao(@StringConfigParam(defaultValue="/WEB-INF",propertyKey="c.g.wuic.dao.basePath")
                              String base,
                              @ObjectConfigParam(defaultValue="",propertyKey="c.g.wuic.dao.proxyUris",setter=ProxyUrisPropertySetter.class)
                              String[] proxies,
                              @IntegerConfigParam(defaultValue=-1,propertyKey="c.g.wuic.dao.pollingInterval")
                              int pollingSeconds,
                              @BooleanConfigParam(defaultValue=false,propertyKey="c.g.wuic.dao.regex")
                              Boolean regex,
                              @BooleanConfigParam(defaultValue=false,propertyKey="c.g.wuic.dao.wildcard")
                              Boolean wildcard,
                              @BooleanConfigParam(defaultValue=false,propertyKey="c.g.wuic.dao.contentBasedVersionNumber")
                              Boolean contentBasedVersionNumber,
                              @BooleanConfigParam(defaultValue=true,propertyKey="c.g.wuic.computeVersionAsynchronously")
                              Boolean computeVersionAsynchronously,
                              @StringConfigParam(defaultValue="",propertyKey="c.g.wuic.fixedVersionNumber")
                              String fixedVersionNumber)

Builds a new instance with a base directory.

Parameters:

base - the directory where we have to look up

pollingSeconds - the interval for polling operations in seconds (-1 to deactivate)

proxies - the proxies URIs in front of the nut

regex - if the path should be considered as a regex or not

wildcard - if the path should be considered as a wildcard or not

contentBasedVersionNumber - true if version number is computed from nut content, false if based on timestamp

computeVersionAsynchronously - (@code true} if version number can be computed asynchronously, false otherwise

fixedVersionNumber - fixed version number, null if version number is computed from content or is last modification date

Method Detail

skipStartsWith

protected List<String> skipStartsWith()

Gets the beginning of path to be skipped during research. Should be overridden by subclass.

Overrides:

skipStartsWith in class PathNutDao

Returns:

the list of beginning paths

createBaseDirectory

protected DirectoryPath createBaseDirectory()
                                     throws IOException

Creates the DirectoryPath associated to the AbstractNutDao.basePath.

Specified by:

createBaseDirectory in class PathNutDao

Returns:

the DirectoryPath

Throws:

IOException - if any I/O error occurs

setServletContext

public void setServletContext(ServletContext context)

Sets the servlet context.

Specified by:

setServletContext in interface ServletContextHandler

Parameters:

context - the servlet context