org.pageseeder.berlioz.servlet

Class HttpEnvironment

java.lang.Object

org.pageseeder.berlioz.servlet.HttpEnvironment

All Implemented Interfaces:

Environment

public final class HttpEnvironment
extends Object
implements Environment

Provides the environment common to all services.

Since:

Berlioz 0.9

Version:

Berlioz 0.9.13 - 21 January 2013

Author:

Christophe Lauret

Constructor Summary

Constructors

Constructor and Description
HttpEnvironment(File publicDir, File privateDir, String cacheControl) Creates a new HTTP environment.

Method Summary

Modifier and Type	Method and Description
String	getCacheControl()
File	getPrivateFile(String path) Returns the file pointing to the private area of the Web site (that is within WEB-INF).
File	getPrivateFolder() Returns the directory pointing to the private area of the Web site (generally WEB-INF).
String	getProperty(String name) Return the requested property.
boolean	getProperty(String name, boolean def) Returns the requested property or it default value.
int	getProperty(String name, int def) Returns the requested int property or it default value.
String	getProperty(String name, String def) Returns the requested property or it default value.
File	getPublicFile(String path) Returns the file pointing to the public area of the Web site.
File	getPublicFolder() Returns the directory pointing to the public area of the Web site.

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpEnvironment

public HttpEnvironment(File publicDir,
                       File privateDir,
                       String cacheControl)

Creates a new HTTP environment.

Parameters:

publicDir - The public directory.

privateDir - The private directory.

cacheControl - The default cache control directive.

Method Detail

getPublicFolder

public File getPublicFolder()

Description copied from interface: Environment

Returns the directory pointing to the public area of the Web site.

Specified by:

getPublicFolder in interface Environment

Returns:

the directory pointing to the public area of the Web site.

getPrivateFolder

public File getPrivateFolder()

Description copied from interface: Environment

Returns the directory pointing to the private area of the Web site (generally WEB-INF).

Specified by:

getPrivateFolder in interface Environment

Returns:

the directory pointing to the private area of the Web site (generally WEB-INF).

getPrivateFile

public File getPrivateFile(String path)

Description copied from interface: Environment

Returns the file pointing to the private area of the Web site (that is within WEB-INF).

Specified by:

getPrivateFile in interface Environment

Parameters:

path - The path of the requested file.

Returns:

the requested file.

getPublicFile

public File getPublicFile(String path)

Description copied from interface: Environment

Returns the file pointing to the public area of the Web site.

Specified by:

getPublicFile in interface Environment

Parameters:

path - The path of the requested file.

Returns:

the requested file.

getProperty

public String getProperty(String name)

Description copied from interface: Environment

Return the requested property.

Returns null if the property is not found or defined.

Specified by:

getProperty in interface Environment

Parameters:

name - the name of the property

Returns:

the property value or null.

getProperty

public boolean getProperty(String name,
                           boolean def)

Description copied from interface: Environment

Returns the requested property or it default value.

The given default value is returned only if the property is not found.

Specified by:

getProperty in interface Environment

Parameters:

name - The name of the property.

def - A default value for the property.

Returns:

the property value or the default value.

getProperty

public int getProperty(String name,
                       int def)

Description copied from interface: Environment

Returns the requested int property or it default value.

Specified by:

getProperty in interface Environment

Parameters:

name - The name of the property.

def - A default value for the property.

Returns:

the property value or the default value.

getProperty

public String getProperty(String name,
                          String def)

Description copied from interface: Environment

Returns the requested property or it default value.

The given default value is returned only if the property is not found.

Specified by:

getProperty in interface Environment

Parameters:

name - The name of the property.

def - A default value for the property.

Returns:

the property value or the default value.

getCacheControl

public String getCacheControl()

Returns:

The HTTP cache control value.