com.github.wuic.nut.dao.core

Class PathNutDao

java.lang.Object

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

com.github.wuic.nut.AbstractNutDao

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

All Implemented Interfaces:

NutDao, Runnable

Direct Known Subclasses:

DiskNutDao, WebappNutDao

public abstract class PathNutDao
extends AbstractNutDao

A NutDao implementation for accesses based on the path API provided by WUIC.

The class is abstract and asks subclass to define the way the base directory should be defined.

Since:

0.4.2

Version:

1.1

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
PathNutDao(String base, Boolean basePathAsSysProp, String[] proxies, int pollingSeconds, Boolean regex, Boolean wildcard, AbstractNutDao.VersionNumberStrategy versionNumberStrategy) Builds a new instance with a base directory.

Method Summary

Methods

Modifier and Type	Method and Description
Nut	accessFor(String realPath, NutType type, ProcessContext processContext) Creates an access for the given parameters through a Nut implementation.
protected abstract DirectoryPath	createBaseDirectory() Creates the DirectoryPath associated to the AbstractNutDao.basePath.
Boolean	exists(String path, ProcessContext processContext) Indicates if the given path exists or not.
protected Long	getLastUpdateTimestampFor(String path) Retrieves a timestamp that indicates the last time this nut has changed.
Boolean	getRegularExpression() Indicates if paths are a regular expression.
Boolean	getWildcardExpression() Indicates if paths are a wildcard expression.
List<String>	listNutsPaths(String pattern) Lists all the nuts path matching the given pattern.
InputStream	newInputStream(String path, ProcessContext processContext) Opens the stream for the given path.
void	save(Nut nut) Saves the give nut.
Boolean	saveSupported() Indicates if this DAO is able to save a nut, which depends on the underlying protocol.
protected List<String>	skipStartsWith() Gets the beginning of path to be skipped during research.
String	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

PathNutDao

public PathNutDao(String base,
          Boolean basePathAsSysProp,
          String[] proxies,
          int pollingSeconds,
          Boolean regex,
          Boolean wildcard,
          AbstractNutDao.VersionNumberStrategy versionNumberStrategy)

Builds a new instance with a base directory.

Parameters:

base - the directory where we have to look up

basePathAsSysProp - true if the base path is a system property

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

versionNumberStrategy - the version number management strategy

Method Detail

getRegularExpression

public Boolean getRegularExpression()

Indicates if paths are a regular expression.

Returns:

true if regex is used, false otherwise

getWildcardExpression

public Boolean getWildcardExpression()

Indicates if paths are a wildcard expression.

Returns:

true if wildcard is used, false otherwise

skipStartsWith

protected List<String> skipStartsWith()

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

Returns:

the list of beginning paths

listNutsPaths

public List<String> listNutsPaths(String pattern)
                           throws IOException

Lists all the nuts path matching the given pattern.

Specified by:

listNutsPaths in class AbstractNutDao

Parameters:

pattern - the pattern

Throws:

IOException - if any I/O error occurs while reading nuts

accessFor

public Nut accessFor(String realPath,
            NutType type,
            ProcessContext processContext)
              throws IOException

Creates an access for the given parameters through a Nut implementation.

Specified by:

accessFor in class AbstractNutDao

Parameters:

realPath - the real path to use to access the nut

type - the path's type

processContext - the process context

Returns:

the Nut

Throws:

IOException - if an I/O error occurs while creating access

getLastUpdateTimestampFor

protected Long getLastUpdateTimestampFor(String path)
                                  throws IOException

Retrieves a timestamp that indicates the last time this nut has changed.

Specified by:

getLastUpdateTimestampFor in class PollingScheduler<NutDaoListener>

Parameters:

path - the real path of the nut

Returns:

the timestamp

Throws:

IOException - if any I/O error occurs

save

public void save(Nut nut)

Saves the give nut. An UnsupportedOperationException will be thrown if the implementation supports only nut access.

Specified by:

save in interface NutDao

Overrides:

save in class AbstractNutDao

Parameters:

nut - the nut to save

saveSupported

public Boolean saveSupported()

Indicates if this DAO is able to save a nut, which depends on the underlying protocol.

Specified by:

saveSupported in interface NutDao

Overrides:

saveSupported in class AbstractNutDao

Returns:

true if NutDao.save(Nut) is supported, false otherwise

toString

public String toString()

Overrides:

toString in class AbstractNutDao

newInputStream

public InputStream newInputStream(String path,
                         ProcessContext processContext)
                           throws IOException

Opens the stream for the given path.

Parameters:

path - the path to access

processContext - the process context calling this method

Returns:

the stream

Throws:

IOException - if stream could not be opened

exists

public Boolean exists(String path,
             ProcessContext processContext)
               throws IOException

Indicates if the given path exists or not.

Parameters:

path - the path the DAO should be able to resolve

processContext - the process context calling this method

Returns:

true if path is resolved, false otherwise

Throws:

IOException - if any I/O error occurs

createBaseDirectory

protected abstract DirectoryPath createBaseDirectory()
                                              throws IOException

Creates the DirectoryPath associated to the AbstractNutDao.basePath.

Returns:

the DirectoryPath

Throws:

IOException - if any I/O error occurs