uws.config

Class ConfigurableUWSServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

uws.config.ConfigurableUWSServlet

All Implemented Interfaces:

java.io.Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

public class ConfigurableUWSServlet
extends javax.servlet.http.HttpServlet

HTTP servlet fully configured with a UWS configuration file.

This configuration file may be specified in the initial parameter named UWSConfiguration.UWS_CONF_PARAMETER of this servlet inside the WEB-INF/web.xml file. If none is specified, the file UWSConfiguration.DEFAULT_UWS_CONF_FILE will be searched inside the directories of the classpath, and inside WEB-INF and META-INF.

Since:

4.2

Version:

4.3 (07/2018)

Author:

Grégory Mantelet (CDS;ARI)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ConfigurableUWSServlet()

Method Summary

Modifier and Type	Method and Description
void	destroy()
protected java.io.File	getFile(java.lang.String filePath, java.lang.String webAppRootPath, java.lang.String propertyName) Resolve the given file name/path.
void	init(javax.servlet.ServletConfig config)
protected java.io.InputStream	searchFile(java.lang.String filePath, javax.servlet.ServletConfig config) Search the given file name/path in the directories of the classpath, then inside WEB-INF and finally inside META-INF.
protected void	service(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp)

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doGet, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service

Methods inherited from class javax.servlet.GenericServlet

getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigurableUWSServlet

public ConfigurableUWSServlet()

Method Detail

init

public void init(javax.servlet.ServletConfig config)
          throws javax.servlet.ServletException

Specified by:

init in interface javax.servlet.Servlet

Overrides:

init in class javax.servlet.GenericServlet

Throws:

javax.servlet.ServletException

searchFile

protected final java.io.InputStream searchFile(java.lang.String filePath,
                                               javax.servlet.ServletConfig config)

Search the given file name/path in the directories of the classpath, then inside WEB-INF and finally inside META-INF.

Parameters:

filePath - A file name/path.

config - Servlet configuration (containing also the context class loader - link with the servlet classpath).

Returns:

The input stream toward the specified file, or NULL if no file can be found.

Since:

2.0

getFile

protected final java.io.File getFile(java.lang.String filePath,
                                     java.lang.String webAppRootPath,
                                     java.lang.String propertyName)
                              throws UWSException

Resolve the given file name/path.

Only the URI protocol "file:" is allowed. If the protocol is different a UWSException is thrown.

If not an absolute URI, the given path may be either relative or absolute. A relative path is always considered as relative from the Web Application directory (supposed to be given in 2nd parameter).

Parameters:

filePath - URI/Path/Name of the file to get.

webAppRootPath - Web Application directory local path.

propertyName - Name of the property which gives the given file path.

Returns:

The specified File instance.

Throws:

UWSException - If the given URI is malformed or if the used URI scheme is different from "file:".

destroy

public void destroy()

Specified by:

destroy in interface javax.servlet.Servlet

Overrides:

destroy in class javax.servlet.GenericServlet

service

protected void service(javax.servlet.http.HttpServletRequest req,
                       javax.servlet.http.HttpServletResponse resp)
                throws javax.servlet.ServletException,
                       java.io.IOException

Overrides:

service in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

java.io.IOException