org.thales.punch.platform.impl

Class LocalEnvironment

java.lang.Object

org.thales.punch.platform.impl.LocalEnvironment

public class LocalEnvironment
extends Object

Watchout : this is the only api that lets you interact with local server resources.

Punchlets may need to load resource files. Some of them are big like the GeoIp databases, or Json files. These are installed on storm servers, or made available through http. In both case they are loaded by the punchlets once compiled in the worker, i.e. on remote servers.

Resources files are searched in order from the PUNCHPLATFORM_CONF_DIR directory (not likely there is one), next from a PUNCHPLATFORM_RESOURCES_DIR directory.

If none are defined you are likely to run in a Storm cluster. Bolts add the STORM_DIR/external/punchplatform/resources directory in the path.

This class provides the interface to set additional path to search for installed resources.

Author:

dimi

Method Summary

Modifier and Type	Method and Description
static String	getCharset()
static URL	getPunchPlatformResourcesUrl() Lookup for a path, relative to one of the resources directory.
static URL	getPunchPlatformResourcesUrl(String resourcePath) Lookup for a path, relative to one of the resources directory.
static void	setCharset(Map<?,?> map) Set the charset to be used in the scope of this process.
static void	setCharset(String charset) Set the charset to be used in the scope of this process.
static void	setPunchPlatformResourcesUrl(String path) Add a resource directory.
static void	setPunchPlatformResourcesUrl(URL url) Test method only.

Methods inherited from class java.lang.Object

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

Method Detail

setPunchPlatformResourcesUrl

public static void setPunchPlatformResourcesUrl(String path)

Add a resource directory.

Parameters:

path - the path where to find the top level resource directory.

setPunchPlatformResourcesUrl

public static void setPunchPlatformResourcesUrl(URL url)

Test method only. Set the url of a resource file, such as geomap files.

Parameters:

url - the resource url.

getPunchPlatformResourcesUrl

public static URL getPunchPlatformResourcesUrl()

Lookup for a path, relative to one of the resources directory.

Returns:

the url

getPunchPlatformResourcesUrl

public static URL getPunchPlatformResourcesUrl(String resourcePath)

Lookup for a path, relative to one of the resources directory. Watch out this method relies on the $PUNCHPLATFORM_CONF_DIR environment variable.

Parameters:

resourcePath - the path you look for

Returns:

the corresponding URL

setCharset

public static void setCharset(Map<?,?> map)

Set the charset to be used in the scope of this process. This must be called by spouts and bolts at prepare or open time.

Parameters:

map - a configuration map with a possible "punchplatform.charset" property.

setCharset

public static void setCharset(String charset)

Set the charset to be used in the scope of this process. This must be called by spouts and bolts at prepare or open time.

Parameters:

charset - the charset

getCharset

public static String getCharset()

Returns:

the charset to be used by all components of this process.