uk.ac.starlink.ttools.server

Class StiltsContext

java.lang.Object

uk.ac.starlink.ttools.server.StiltsContext

public class StiltsContext
extends Object

Encapsulates servlet context aspects specific to the STILTS server mode.

Since:

20 Oct 2008

Author:

Mark Taylor

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALLOWORIGINS_PARAM Name of a servlet initialisation parameter giving allowed origins for permissible Cross-Origin requests.
static String	CACHEDIR_PARAM Name of a Servlet initialisation parameter giving the directory to use for persistent data cache files used during plotting.
static String	CACHELIMIT_PARAM Name of a Servlet initialisation parameter indicating the maximum size for the persistent data cache used during plotting.
static String	PLOTPARALLELISM_PARAM Name of a servlet initalisation parameter giving the maximum number of cores to use in the ForkJoinPool used during parallel plotting.
static String	TABLEFACTORY_PARAM Name of a Servlet initialisation parameter which can be used to customise table location.
static String	TASKBASE_PARAM Name of the Servlet initialisation parameter which defines the base URL on the server at which the TaskServlet runs.
static String	TASKLIST_PARAM Name of the Servlet initialisation parameter which defines the tasks which this servlet will provide over HTTP.

Constructor Summary

Constructors

Constructor and Description
StiltsContext(javax.servlet.ServletContext context) Constructor.

Method Summary

Modifier and Type	Method and Description
String	getAllowOrigins() Returns the intended content of the CORS Access-Control-Allow-Origin header.
DataStoreFactory	getDataStoreFactory() Returns the DataStoreFactory to be used for plots.
DiskCache	getImageCache() Returns a cache that can be used for caching plotted image files.
StarTableFactory	getTableFactory() Acquires a StarTableFactory suitable for use from a servlet from the servlet context.
String	getTaskBase() Returns the server URL below which task servlets can be accessed.

Methods inherited from class java.lang.Object

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

Field Detail

TASKBASE_PARAM

public static final String TASKBASE_PARAM

Name of the Servlet initialisation parameter which defines the base URL on the server at which the TaskServlet runs. A task can be accessed at the value of this parameter with "/(taskname)" appended.

See Also:

Constant Field Values

TASKLIST_PARAM

public static final String TASKLIST_PARAM

Name of the Servlet initialisation parameter which defines the tasks which this servlet will provide over HTTP. The value of this parameter is a space-separated list of the tasks to provide. If it is absent or empty, all tasks will be provided.

See Also:

Constant Field Values

TABLEFACTORY_PARAM

public static final String TABLEFACTORY_PARAM

Name of a Servlet initialisation parameter which can be used to customise table location. If no value is supplied, tables with a leading "/" represent paths in the server filesystem, while others are relative to the servlet root directory. If the value is non-null it will be passed to the TableFactoryParameter.createTableFactory(java.lang.String) method to come up with a StarTableFactory which is used instead of the default one.

See Also:

Constant Field Values

CACHEDIR_PARAM

public static final String CACHEDIR_PARAM

Name of a Servlet initialisation parameter giving the directory to use for persistent data cache files used during plotting. Files in this directory will not be cleared out by the servlet. If not supplied, the java temporary directory as supplied by the java.io.tmpdir system property is used.

See Also:

Constant Field Values

CACHELIMIT_PARAM

public static final String CACHELIMIT_PARAM

Name of a Servlet initialisation parameter indicating the maximum size for the persistent data cache used during plotting. If positive, it's the maximum cache size in bytes. If negative, it's the minimum number of bytes that should be preserved on the cache filesystem. If zero, some adaptive value is used. Note that the cache size may increase beyond this size sometimes.

See Also:

Constant Field Values

PLOTPARALLELISM_PARAM

public static final String PLOTPARALLELISM_PARAM

Name of a servlet initalisation parameter giving the maximum number of cores to use in the ForkJoinPool used during parallel plotting. If not supplied, the common pool is used.

See Also:

Constant Field Values

ALLOWORIGINS_PARAM

public static final String ALLOWORIGINS_PARAM

Name of a servlet initialisation parameter giving allowed origins for permissible Cross-Origin requests. This will provide the content of the CORS Access-Control-Allow-Origin header where that is issued. If this parameter is not set some default behaviour will be used; that may be allowing all cross-origin requests, depending on the perceived security implications. To deny all requests, set it to the empty string.

See Also:

Constant Field Values

Constructor Detail

StiltsContext

public StiltsContext(javax.servlet.ServletContext context)

Constructor.

Parameters:

context - servlet context which provides the information for this object

Method Detail

getTableFactory

public StarTableFactory getTableFactory()
                                 throws javax.servlet.ServletException

Acquires a StarTableFactory suitable for use from a servlet from the servlet context.

Returns:

table factory

Throws:

javax.servlet.ServletException

getTaskBase

public String getTaskBase()

Returns the server URL below which task servlets can be accessed.

Returns:

base task servlet server URL

getDataStoreFactory

public DataStoreFactory getDataStoreFactory()
                                     throws javax.servlet.ServletException

Returns the DataStoreFactory to be used for plots.

Returns:

data store factory

Throws:

javax.servlet.ServletException

getImageCache

public DiskCache getImageCache()
                        throws javax.servlet.ServletException

Returns a cache that can be used for caching plotted image files.

Returns:

image cache

Throws:

javax.servlet.ServletException

getAllowOrigins

public String getAllowOrigins()
                       throws javax.servlet.ServletException

Returns the intended content of the CORS Access-Control-Allow-Origin header. A null value should be taken to mean default behaviour, whatever that is in the context of the servlet. An empty string means that no domains are permitted (no Access-Control-Allow-Origin header to be inserted).

Throws:

javax.servlet.ServletException