com.github.wuic.nut.dao

Interface NutDao

All Known Implementing Classes:

AbstractNutDao, AbstractNutDao.WithRootPathNutDao, ClasspathNutDao, DiskNutDao, HttpNutDao, PathNutDao, ProxyNutDao, RequestDispatcherNutDao, WebappNutDao

public interface NutDao

This interface abstracts the way you can read and eventually save nuts through a particular protocol.

Since:

0.3.1

Version:

1.6

Author:

Guillaume DROUET

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	NutDao.PathFormat This enumeration specifies formats of path specified to create nuts.

Method Summary

Methods

Modifier and Type	Method and Description
List<Nut>	create(String path, NutDao.PathFormat format, ProcessContext processContext) Creates a list of nuts thanks to the given path.
List<Nut>	create(String path, ProcessContext processContext) Creates a list of nuts thanks to the given path considered as represented in any format.
Boolean	exists(String path, ProcessContext processContext) Indicates if the given path exists or not.
InputStream	newInputStream(String path, ProcessContext processContext) Opens the stream for the given path.
void	observe(String realPath, NutDaoListener... listeners) Adds a set of listeners to be notified when an update has been detected on the nut.
String	proxyUriFor(Nut nut) Returns an URI in a String representation of a proxy serving the given nut.
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.
void	shutdown() Shutdowns this DAO by releasing its resources.
NutDao	withRootPath(String rootPath) Returns an instance that prefixes any nut name to be created with the given root path.

Method Detail

observe

void observe(String realPath,
           NutDaoListener... listeners)
             throws IOException

Adds a set of listeners to be notified when an update has been detected on the nut. The targeted nut is represented by the specified path.

The listeners will be stored in a weak reference so if no strong reference to them exist, they will be garbage collected.

Parameters:

realPath - the real path name of the nut.

listeners - some listeners to be notified when an update has been detected on a nut

Throws:

IOException - if an I/O occurs while retrieving last update of the nut

create

List<Nut> create(String path,
               ProcessContext processContext)
                 throws IOException

Creates a list of nuts thanks to the given path considered as represented in any format.

Parameters:

path - the path representing the location of the nut(s)

processContext - the process context calling this method

Returns:

the created nut(s)

Throws:

IOException - if an I/O error occurs when creating the nut

See Also:

create(String, com.github.wuic.nut.dao.NutDao.PathFormat, com.github.wuic.ProcessContext)

create

List<Nut> create(String path,
               NutDao.PathFormat format,
               ProcessContext processContext)
                 throws IOException

Creates a list of nuts thanks to the given path.

A NutDao.PathFormat also gives information on the format used in the string representation of the given path.

Parameters:

path - the path representing the location of the nut(s)

format - the path format

processContext - the process context calling this method

Returns:

the created nut(s)

Throws:

IOException - if an I/O error occurs when creating the nut

proxyUriFor

String proxyUriFor(Nut nut)

Returns an URI in a String representation of a proxy serving the given nut.

If many proxies are defined, proxy URI is selected in a round-robin mode. Each time a proxy is used, it won't be reused until all other proxies have been used too.

Parameters:

nut - the nut

Returns:

the proxy URI, null if not proxy is set

save

void save(Nut nut)

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

Parameters:

nut - the nut to save

saveSupported

Boolean saveSupported()

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

Returns:

true if save(Nut) is supported, false otherwise

shutdown

void shutdown()

Shutdowns this DAO by releasing its resources.

withRootPath

NutDao withRootPath(String rootPath)

Returns an instance that prefixes any nut name to be created with the given root path.

Parameters:

rootPath - the root path

Returns:

the enclosed instance

newInputStream

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

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