thredds.servlet

Class ServletUtil

java.lang.Object

thredds.servlet.ServletUtil

public class ServletUtil
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTENT_TEXT
static org.slf4j.Logger	logServerStartup
static int	STATUS_CLIENT_ABORT
static int	STATUS_FORWARD_FAILURE
static int	STATUS_FORWARDED

Constructor Summary

Constructors

Constructor and Description
ServletUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	copyDir(String fromDir, String toDir)
static String	formFilename(String dirPath, String filePath) Return the file path dealing with leading and trailing path seperators (which must be a slash ("/")) for the given directory and file paths.
static void	forwardToCatalogServices(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) Forward this request to the CatalogServices servlet ("/catalog.html").
static String	getContentPath() Return the content path for the given servlet.
static String	getContextPath() Return the context path for the given servlet.
static FileCache	getFileCache()
static String	getFileURL(String filename)
static String	getInitialContentPath() Return the default/initial content path for the given servlet.
static String	getParameterIgnoreCase(javax.servlet.http.HttpServletRequest req, String paramName) Return the value of the given parameter for the given request.
static String[]	getParameterValuesIgnoreCase(javax.servlet.http.HttpServletRequest req, String paramName) Return the values of the given parameter (ignoring case) for the given request.
static String	getReletiveURL(javax.servlet.http.HttpServletRequest req) Return the request URL relative to the server (i.e., starting with the context path).
static String	getRequest(javax.servlet.http.HttpServletRequest req) The entire request including query string
static String	getRequestBase(javax.servlet.http.HttpServletRequest req) This is everything except the query string
static String	getRequestParsed(javax.servlet.http.HttpServletRequest req) Show the pieces of the request, for debugging
static String	getRequestPath(javax.servlet.http.HttpServletRequest req) servletPath + pathInfo
static String	getRequestServer(javax.servlet.http.HttpServletRequest req) This is the server part, eg http://motherlode:8080
static URI	getRequestURI(javax.servlet.http.HttpServletRequest req) The request base as a URI
static String	getRootPath() Return the real path on the servers file system that corresponds to the root document ("/") on the given servlet.
static void	handleException(Throwable t, javax.servlet.http.HttpServletResponse res) ************************************************************************ Sends an error to the client.
static void	handleRequestForContentFile(String path, javax.servlet.http.HttpServlet servlet, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) Handle an explicit request for a content directory file (path must start with "/content/".
static void	handleRequestForRawFile(String path, javax.servlet.http.HttpServlet servlet, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) Handle a request for a raw/static file (i.e., not a catalog or dataset request).
static void	handleRequestForRootFile(String path, javax.servlet.http.HttpServlet servlet, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) Handle an explicit request for a root directory file (path must start with "/root/".
static void	initContext(javax.servlet.ServletContext context) Deprecated. Now handled in TdsContext.init().
static void	initDebugging(javax.servlet.ServletContext webapp)
static void	returnFile(javax.servlet.http.HttpServlet servlet, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, File file, String contentType) Write a file to the response stream.
static void	returnFile(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, File file, String contentType) Write a file to the response stream.
static void	returnFile(javax.servlet.http.HttpServlet servlet, String contentPath, String path, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, String contentType) Write a file to the response stream.
static void	returnString(String contents, javax.servlet.http.HttpServletResponse res) Send given content string as the HTTP response.
static boolean	saveFile(javax.servlet.http.HttpServlet servlet, String contentPath, String path, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
static void	sendPermanentRedirect(String targetPath, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) Send a permanent redirect (HTTP status 301 "Moved Permanently") response with the given target path.
static void	setContentPath(String newContentPath)
static void	setContextPath(String newContextPath)
static void	setFileCache(FileCache fileCache)
static void	setRootPath(String newRootPath)
static String	showRequestDetail(javax.servlet.http.HttpServlet servlet, javax.servlet.http.HttpServletRequest req) Show details about the request
static String	showRequestHeaders(javax.servlet.http.HttpServletRequest req)
static String	showSecurity(javax.servlet.http.HttpServletRequest req, String role)
static void	showServerInfo(PrintStream out)
static void	showServletInfo(javax.servlet.http.HttpServlet servlet, PrintStream out)
static void	showSession(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, PrintStream out)
static void	showSession(javax.servlet.http.HttpServletRequest req, PrintStream out)
static void	showThreads(PrintStream pw)

Methods inherited from class java.lang.Object

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

Field Detail

logServerStartup

public static final org.slf4j.Logger logServerStartup

CONTENT_TEXT

public static final String CONTENT_TEXT

See Also:

Constant Field Values

STATUS_CLIENT_ABORT

public static final int STATUS_CLIENT_ABORT

See Also:

Constant Field Values

STATUS_FORWARDED

public static final int STATUS_FORWARDED

See Also:

Constant Field Values

STATUS_FORWARD_FAILURE

public static final int STATUS_FORWARD_FAILURE

See Also:

Constant Field Values

Constructor Detail

ServletUtil

public ServletUtil()

Method Detail

initContext

public static void initContext(javax.servlet.ServletContext context)

Deprecated. Now handled in TdsContext.init().

Parameters:

context - the Servlet context.

setContextPath

public static void setContextPath(String newContextPath)

setRootPath

public static void setRootPath(String newRootPath)

setContentPath

public static void setContentPath(String newContentPath)

initDebugging

public static void initDebugging(javax.servlet.ServletContext webapp)

getRootPath

public static String getRootPath()

Return the real path on the servers file system that corresponds to the root document ("/") on the given servlet.

Returns:

the real path on the servers file system that corresponds to the root document ("/") on the given servlet.

getContextPath

public static String getContextPath()

Return the context path for the given servlet. Note - ToDo: Why not just use ServletContext.getServletContextName()?

Returns:

the context path for the given servlet.

getContentPath

public static String getContentPath()

Return the content path for the given servlet.

Returns:

the content path for the given servlet.

getInitialContentPath

public static String getInitialContentPath()

Return the default/initial content path for the given servlet. The content of which is copied to the content path when the web app is first installed.

Returns:

the default/initial content path for the given servlet.

formFilename

public static String formFilename(String dirPath,
                  String filePath)

Return the file path dealing with leading and trailing path seperators (which must be a slash ("/")) for the given directory and file paths. Note: Dealing with path strings is fragile. ToDo: Switch from using path strings to java.io.Files.

Parameters:

dirPath - the directory path.

filePath - the file path.

Returns:

a full file path with the given directory and file paths.

handleRequestForRawFile

public static void handleRequestForRawFile(String path,
                           javax.servlet.http.HttpServlet servlet,
                           javax.servlet.http.HttpServletRequest req,
                           javax.servlet.http.HttpServletResponse res)
                                    throws IOException

Handle a request for a raw/static file (i.e., not a catalog or dataset request).

Look in the content (user) directory then the root (distribution) directory for a file that matches the given path and, if found, return it as the content of the HttpServletResponse. If the file is forbidden (i.e., the path contains a "..", "WEB-INF", or "META-INF" directory), send a HttpServletResponse.SC_FORBIDDEN response. If no file matches the request (including an "index.html" file if the path ends in "/"), send an HttpServletResponse.SC_NOT_FOUND..

1. Make sure the path does not contain ".." directories.
2. Make sure the path does not contain "WEB-INF" or "META-INF".
3. Check for requested file in the content directory (if the path is a directory, make sure the path ends with "/" and check for an "index.html" file).
4. Check for requested file in the root directory (if the path is a directory, make sure the path ends with "/" and check for an "index.html" file).

Parameters:

path - the requested path

servlet - the servlet handling the request

req - the HttpServletRequest

res - the HttpServletResponse

Throws:

IOException - if can't complete request due to IO problems.

handleRequestForContentFile

public static void handleRequestForContentFile(String path,
                               javax.servlet.http.HttpServlet servlet,
                               javax.servlet.http.HttpServletRequest req,
                               javax.servlet.http.HttpServletResponse res)
                                        throws IOException

Handle an explicit request for a content directory file (path must start with "/content/".

Note: As these requests will show the configuration files for the server, these requests should be covered by security constraints.

1. Make sure the path does not contain ".." directories.
2. Check for the requested file in the content directory.

Parameters:

path - the requested path (must start with "/content/")

servlet - the servlet handling the request

req - the HttpServletRequest

res - the HttpServletResponse

Throws:

IOException - if can't complete request due to IO problems.

handleRequestForRootFile

public static void handleRequestForRootFile(String path,
                            javax.servlet.http.HttpServlet servlet,
                            javax.servlet.http.HttpServletRequest req,
                            javax.servlet.http.HttpServletResponse res)
                                     throws IOException

Handle an explicit request for a root directory file (path must start with "/root/".

Note: As these requests will show the configuration files for the server, these requests should be covered by security constraints.

1. Make sure the path does not contain ".." directories.
2. Check for the requested file in the root directory.

Parameters:

path - the requested path (must start with "/root/")

servlet - the servlet handling the request

req - the HttpServletRequest

res - the HttpServletResponse

Throws:

IOException - if can't complete request due to IO problems.

sendPermanentRedirect

public static void sendPermanentRedirect(String targetPath,
                         javax.servlet.http.HttpServletRequest req,
                         javax.servlet.http.HttpServletResponse res)
                                  throws IOException

Send a permanent redirect (HTTP status 301 "Moved Permanently") response with the given target path.

The given target path may be relative or absolute. If it is relative, it will be resolved against the request URL.

Parameters:

targetPath - the path to which the client is redirected.

req - the HttpServletRequest

res - the HttpServletResponse

Throws:

IOException - if can't write the response.

returnFile

public static void returnFile(javax.servlet.http.HttpServlet servlet,
              String contentPath,
              String path,
              javax.servlet.http.HttpServletRequest req,
              javax.servlet.http.HttpServletResponse res,
              String contentType)
                       throws IOException

Write a file to the response stream.

Parameters:

servlet - called from here

contentPath - file root path

path - file path reletive to the root

req - the request

res - the response

contentType - content type, or null

Throws:

IOException - on write error

setFileCache

public static void setFileCache(FileCache fileCache)

getFileCache

public static FileCache getFileCache()

returnFile

public static void returnFile(javax.servlet.http.HttpServlet servlet,
              javax.servlet.http.HttpServletRequest req,
              javax.servlet.http.HttpServletResponse res,
              File file,
              String contentType)
                       throws IOException

Write a file to the response stream. Handles Range requests.

Parameters:

servlet - called from here

req - the request

res - the response

file - to serve

contentType - content type, if null, will try to guess

Throws:

IOException - on write error

returnFile

public static void returnFile(javax.servlet.http.HttpServletRequest req,
              javax.servlet.http.HttpServletResponse res,
              File file,
              String contentType)
                       throws IOException

Write a file to the response stream. Handles Range requests.

Parameters:

req - request

res - response

file - must exist and not be a directory

contentType - must not be null

Throws:

IOException - or error

returnString

public static void returnString(String contents,
                javax.servlet.http.HttpServletResponse res)
                         throws IOException

Send given content string as the HTTP response.

Parameters:

contents - the string to return as the HTTP response.

res - the HttpServletResponse

Throws:

IOException - if an I/O error occurs while writing the response.

getReletiveURL

public static String getReletiveURL(javax.servlet.http.HttpServletRequest req)

Return the request URL relative to the server (i.e., starting with the context path).

Parameters:

req - request

Returns:

URL relative to the server

forwardToCatalogServices

public static void forwardToCatalogServices(javax.servlet.http.HttpServletRequest req,
                            javax.servlet.http.HttpServletResponse res)
                                     throws IOException,
                                            javax.servlet.ServletException

Forward this request to the CatalogServices servlet ("/catalog.html").

Parameters:

req - request

res - response

Throws:

IOException - on IO error

javax.servlet.ServletException - other error

saveFile

public static boolean saveFile(javax.servlet.http.HttpServlet servlet,
               String contentPath,
               String path,
               javax.servlet.http.HttpServletRequest req,
               javax.servlet.http.HttpServletResponse res)

copyDir

public static boolean copyDir(String fromDir,
              String toDir)
                       throws IOException

Throws:

IOException

handleException

public static void handleException(Throwable t,
                   javax.servlet.http.HttpServletResponse res)

************************************************************************ Sends an error to the client.

Parameters:

t - The exception that caused the problem.

res - The HttpServletResponse for the client.

showServerInfo

public static void showServerInfo(PrintStream out)

showServletInfo

public static void showServletInfo(javax.servlet.http.HttpServlet servlet,
                   PrintStream out)

getRequestParsed

public static String getRequestParsed(javax.servlet.http.HttpServletRequest req)

Show the pieces of the request, for debugging

Parameters:

req - the HttpServletRequest

Returns:

parsed request

getRequestServer

public static String getRequestServer(javax.servlet.http.HttpServletRequest req)

This is the server part, eg http://motherlode:8080

Parameters:

req - the HttpServletRequest

Returns:

request server

getRequestBase

public static String getRequestBase(javax.servlet.http.HttpServletRequest req)

This is everything except the query string

Parameters:

req - the HttpServletRequest

Returns:

parsed request base

getRequestURI

public static URI getRequestURI(javax.servlet.http.HttpServletRequest req)

The request base as a URI

Parameters:

req - the HttpServletRequest

Returns:

parsed request as a URI

getRequestPath

public static String getRequestPath(javax.servlet.http.HttpServletRequest req)

servletPath + pathInfo

Parameters:

req - the HttpServletRequest

Returns:

parsed request servletPath + pathInfo

getRequest

public static String getRequest(javax.servlet.http.HttpServletRequest req)

The entire request including query string

Parameters:

req - the HttpServletRequest

Returns:

entire parsed request

getParameterIgnoreCase

public static String getParameterIgnoreCase(javax.servlet.http.HttpServletRequest req,
                            String paramName)

Return the value of the given parameter for the given request. Should only be used if the parameter is known to only have one value. If used on a multi-valued parameter, the first value is returned.

Parameters:

req - the HttpServletRequest

paramName - the name of the parameter to find.

Returns:

the value of the given parameter for the given request.

getParameterValuesIgnoreCase

public static String[] getParameterValuesIgnoreCase(javax.servlet.http.HttpServletRequest req,
                                    String paramName)

Return the values of the given parameter (ignoring case) for the given request.

Parameters:

req - the HttpServletRequest

paramName - the name of the parameter to find.

Returns:

the values of the given parameter for the given request.

getFileURL

public static String getFileURL(String filename)

showRequestDetail

public static String showRequestDetail(javax.servlet.http.HttpServlet servlet,
                       javax.servlet.http.HttpServletRequest req)

Show details about the request

Parameters:

servlet - used to get teh servlet context, may be null

req - the request

Returns:

string showing the details of the request.

showRequestHeaders

public static String showRequestHeaders(javax.servlet.http.HttpServletRequest req)

showSession

public static void showSession(javax.servlet.http.HttpServletRequest req,
               javax.servlet.http.HttpServletResponse res,
               PrintStream out)

showSession

public static void showSession(javax.servlet.http.HttpServletRequest req,
               PrintStream out)

showSecurity

public static String showSecurity(javax.servlet.http.HttpServletRequest req,
                  String role)

showThreads

public static void showThreads(PrintStream pw)