com.canto.cumulus.server.esp

Interface ESPContext

public interface ESPContext

Context information for an Embedded Server Plugin module.

Since:

ESP 7.0.0

Method Summary

Methods

Modifier and Type	Method and Description
java.io.File	getDataFolder() Get the folder where this ESP can store private files (configurations, temporary files etc.).
ESP	getESPByID(GUID id) Get the ESP instance with the given ID string.
java.net.URL	getLocation() Get the location of this ESP instance.

Method Detail

getESPByID

ESP getESPByID(GUID id)

Get the ESP instance with the given ID string.

Returns:

the ESP instance, null if no ESP of the given ID can be found.

getLocation

java.net.URL getLocation()

Get the location of this ESP instance. Currently this is a URL to the .esp file on disk.

Returns:

The location of this ESP instance.

getDataFolder

java.io.File getDataFolder()

Get the folder where this ESP can store private files (configurations, temporary files etc.). This folder is located in the "esp" subfolder of the folder specified by the System property "com.canto.cumulus.appdata.home" and has the name of the ESP file itself.

Returns:

The folder for ESP private data.

Since:

ESP 7.0.0