org.apache.clerezza.web.fileserver

Class FileServer

java.lang.Object

org.apache.clerezza.web.fileserver.AbstractFileServer

org.apache.clerezza.web.fileserver.FileServer

Direct Known Subclasses:

Editor, GenericResourcePage

public class FileServer
extends AbstractFileServer

A utility class providing a FileServer that can be configured in different ways. It provides an alternative to AbstractFileServer for jax-rs resources serviceng static files to override.

Author:

reto

Constructor Summary

Constructors

Constructor and Description
FileServer() Construct a new instance that has to be configured using one of the configure-methods.
FileServer(org.wymiwyg.commons.util.dirbrowser.PathNode pathNode) creates a new instance configured with specified pathnode as root

Method Summary

Methods

Modifier and Type	Method and Description
void	configure(org.osgi.framework.BundleContext context) Configures the instance to use the 'staticweb' folder next to (sub-)class in the bundle associated to the specified context.
void	configure(org.osgi.framework.BundleContext context, String path) Sets up a path in a bundle or file system to be exposed over a org.apache.clerezza.web.fileserver.FileServer.
void	configure(File rootDir) configures the instance to use the specified directory as root
void	configure(org.wymiwyg.commons.util.dirbrowser.PathNode pathNode) configures the instance with the specified PathNode
protected org.wymiwyg.commons.util.dirbrowser.PathNode	getRootNode() This method return the root of the served hierarchy.
void	reset() resets the configuration

Methods inherited from class org.apache.clerezza.web.fileserver.AbstractFileServer

getNode

Methods inherited from class java.lang.Object

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

Constructor Detail

FileServer

public FileServer()

Construct a new instance that has to be configured using one of the configure-methods.

FileServer

public FileServer(org.wymiwyg.commons.util.dirbrowser.PathNode pathNode)

creates a new instance configured with specified pathnode as root

Parameters:

pathNode - the root of the PathNode hierarchy

Method Detail

configure

public void configure(org.wymiwyg.commons.util.dirbrowser.PathNode pathNode)

configures the instance with the specified PathNode

Parameters:

pathNode - the root of the PathNode hierarchy

configure

public void configure(org.osgi.framework.BundleContext context)

Configures the instance to use the 'staticweb' folder next to (sub-)class in the bundle associated to the specified context.

Parameters:

context - The scr component context of the bundle containing the 'staticweb' directory where the subclass is located.

configure

public void configure(org.osgi.framework.BundleContext context,
             String path)

Sets up a path in a bundle or file system to be exposed over a org.apache.clerezza.web.fileserver.FileServer. The path is relative to the locationof the class.

Parameters:

context - The bundle context of the bundle containing the path.

path - the path where the file are to be exposed

configure

public void configure(File rootDir)

configures the instance to use the specified directory as root

Parameters:

rootDir - the root of the serverd hierarchy

reset

public void reset()

resets the configuration

getRootNode

protected org.wymiwyg.commons.util.dirbrowser.PathNode getRootNode()

Description copied from class: AbstractFileServer

This method return the root of the served hierarchy. For example if the instance is to server all Files in /var/www, this method would return an instance of org.wymiwyg.commons.util.dirbrowser.FilePathNode initialized with "/var/www".

Specified by:

getRootNode in class AbstractFileServer

Returns:

the root of the served hierarchy