thredds.servlet

Class ServletUtil

java.lang.Object

thredds.servlet.ServletUtil

public class ServletUtil
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static org.slf4j.Logger	logServerStartup

Constructor Summary

Constructors

Constructor and Description
ServletUtil()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	formFilename(java.lang.String dirPath, java.lang.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 java.lang.String	getParameterIgnoreCase(javax.servlet.http.HttpServletRequest req, java.lang.String paramName) Return the value of the given parameter for the given request.
static java.lang.String	getReletiveURL(javax.servlet.http.HttpServletRequest req) Return the request URL relative to the server (i.e., starting with the context path).
static java.lang.String	getRequest(javax.servlet.http.HttpServletRequest req) The entire request including query string
static java.lang.String	getRequestBase(javax.servlet.http.HttpServletRequest req) This is everything except the query string
static java.lang.String	getRequestPath(javax.servlet.http.HttpServletRequest req) servletPath + pathInfo
static java.lang.String	getRequestServer(javax.servlet.http.HttpServletRequest req) This is the server part, eg http://motherlode:8080
static java.net.URI	getRequestURI(javax.servlet.http.HttpServletRequest req) The request base as a URI
static void	returnFile(javax.servlet.http.HttpServlet servlet, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, java.io.File file, java.lang.String contentType) Write a file to the response stream.
static void	returnFile(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, java.io.File file, java.lang.String contentType) Write a file to the response stream.
static void	returnFile(javax.servlet.http.HttpServlet servlet, java.lang.String contentPath, java.lang.String path, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, java.lang.String contentType) Write a file to the response stream.
static void	returnString(java.lang.String contents, javax.servlet.http.HttpServletResponse res) Send given content string as the HTTP response.
static int	setResponseContentLength(javax.servlet.http.HttpServletResponse response, java.lang.String s) Set the proper content length for the string
static java.lang.String	showRequestDetail(javax.servlet.http.HttpServletRequest req) Show details about the request
static java.lang.String	showRequestHeaders(javax.servlet.http.HttpServletRequest req)
static java.lang.String	showSecurity(javax.servlet.http.HttpServletRequest req, java.lang.String role)
static void	showSession(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, java.io.PrintStream out)
static void	showSystemProperties(java.io.PrintStream out)
static void	showThreads(java.io.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

Constructor Detail

ServletUtil

public ServletUtil()

Method Detail

formFilename

public static java.lang.String formFilename(java.lang.String dirPath,
                                            java.lang.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.

returnFile

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

Write a file to the response stream.

Parameters:

servlet - called from this servlet, may be null

contentPath - file root path

path - file path reletive to the root

req - the request

res - the response

contentType - content type, or null

Throws:

java.io.IOException - on write error

returnFile

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

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

Parameters:

servlet - called from this servlet, may be null

req - the request

res - the response

file - to serve

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

Throws:

java.io.IOException - on write error

returnFile

public static void returnFile(javax.servlet.http.HttpServletRequest req,
                              javax.servlet.http.HttpServletResponse res,
                              java.io.File file,
                              java.lang.String contentType)
                       throws java.io.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:

java.io.IOException - or error

returnString

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

Send given content string as the HTTP response.

Parameters:

contents - the string to return as the HTTP response.

res - the HttpServletResponse

Throws:

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

setResponseContentLength

public static int setResponseContentLength(javax.servlet.http.HttpServletResponse response,
                                           java.lang.String s)
                                    throws java.io.UnsupportedEncodingException

Set the proper content length for the string

Parameters:

response - the HttpServletResponse to act upon

s - the string that will be returned

Returns:

the number of bytes

Throws:

java.io.UnsupportedEncodingException - on bad character encoding

getReletiveURL

public static java.lang.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 java.io.IOException,
                                            javax.servlet.ServletException

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

Parameters:

req - request

res - response

Throws:

java.io.IOException - on IO error

javax.servlet.ServletException - other error

showSystemProperties

public static void showSystemProperties(java.io.PrintStream out)

getRequestServer

public static java.lang.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 java.lang.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 java.net.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 java.lang.String getRequestPath(javax.servlet.http.HttpServletRequest req)

servletPath + pathInfo

Parameters:

req - the HttpServletRequest

Returns:

parsed request servletPath + pathInfo

getRequest

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

The entire request including query string

Parameters:

req - the HttpServletRequest

Returns:

entire parsed request

getParameterIgnoreCase

public static java.lang.String getParameterIgnoreCase(javax.servlet.http.HttpServletRequest req,
                                                      java.lang.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.

showRequestDetail

public static java.lang.String showRequestDetail(javax.servlet.http.HttpServletRequest req)

Show details about the request

Parameters:

req - the request

Returns:

string showing the details of the request.

showRequestHeaders

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

showSession

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

showSecurity

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

showThreads

public static void showThreads(java.io.PrintStream pw)