org.geomajas.service

Interface ResourceService

@Api(allMethods=true)
public interface ResourceService

Service to locate resources in the classpath, the file system, the web context or a list of configurable root paths.

Since:

1.10.0

Author:

Jan De Moerloose

Method Summary

Methods

Modifier and Type	Method and Description
Resource	find(String location) Find a resource.
List<String>	getRootPaths() Returns the list of root paths used by this service.
void	setRootPaths(List<String> rootPaths) Specifies the list of root paths to be used by this service.

Method Detail

find

Resource find(String location)
              throws GeomajasException

Find a resource. If a non-null resource is returned, it is ensured to exist.

Parameters:

location - the location

Returns:

the resource or null if the resource does not exist

Throws:

GeomajasException - oops

getRootPaths

List<String> getRootPaths()

Returns the list of root paths used by this service. In case the resource cannot be resolved directly, the service will consecutively prepend each root path before the resource location in order to find an existing resource. Example root paths are 'classpath:/org/geomajas' or 'file:C:/' or 'WEB-INF/images'.

Returns:

the list of root paths

setRootPaths

void setRootPaths(List<String> rootPaths)

Specifies the list of root paths to be used by this service. In case the resource cannot be resolved directly, the service will consecutively prepend each root path before the resource location in order to find an existing resource. Example root paths are 'classpath:/org/geomajas' or 'file:C:/' or 'WEB-INF/images'.

Parameters:

rootPaths - list of path strings