com.github.wuic.nut.dao.core

Class HttpNutDao

java.lang.Object

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

com.github.wuic.nut.AbstractNutDao

com.github.wuic.nut.dao.core.HttpNutDao

All Implemented Interfaces:

NutDao, Runnable

@NutDaoService
public class HttpNutDao
extends AbstractNutDao

A NutDao implementation for HTTP accesses.

Since:

0.3.1

Version:

1.5

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
HttpNutDao(Boolean https, String domain, Integer port, String path, Boolean basePathAsSysProp, int pollingSeconds, Boolean contentBasedVersionNumber, Boolean computeVersionAsynchronously, String fixedVersionNumber) Builds a new instance thanks to the specified HTTP information.

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.
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.
protected 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.
String	toString()

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

absolutePathOf, computeRealPaths, create, create, getBasePath, getProxyUris, getVersionNumber, getVersionNumberStrategy, proxyUriFor, run, save, saveSupported, 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

HttpNutDao

@ConfigConstructor
public HttpNutDao(@BooleanConfigParam(defaultValue=false,propertyKey="c.g.wuic.dao.secret")
                            Boolean https,
                            @StringConfigParam(defaultValue="localhost",propertyKey="c.g.wuic.dao.serverDomain")
                            String domain,
                            @IntegerConfigParam(defaultValue=80,propertyKey="c.g.wuic.dao.serverPort")
                            Integer port,
                            @StringConfigParam(defaultValue="",propertyKey="c.g.wuic.dao.basePath")
                            String path,
                            @BooleanConfigParam(defaultValue=false,propertyKey="c.g.wuic.dao.basePathAsSystemProperty")
                            Boolean basePathAsSysProp,
                            @IntegerConfigParam(defaultValue=-1,propertyKey="c.g.wuic.dao.pollingInterval")
                            int pollingSeconds,
                            @BooleanConfigParam(defaultValue=false,propertyKey="c.g.wuic.dao.basePathAsSystemProperty")
                            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 thanks to the specified HTTP information.

Parameters:

https - use HTTPS protocol instead of HTTP ?

domain - the HTTP server domain name

port - the HTTP server port

path - the base path where nuts are provided

basePathAsSysProp - true if the base path is a system property

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

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

listNutsPaths

protected 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

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

toString

public String toString()

Overrides:

toString in class AbstractNutDao