Package jmri.web.servlet

Class ServletUtil

java.lang.Object

jmri.web.servlet.ServletUtil

All Implemented Interfaces:

InstanceManagerAutoDefault

public class ServletUtil
extends Object
implements InstanceManagerAutoDefault

Utility methods to reduce code duplication in servlets.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	APPLICATION_JAVASCRIPT
static final String	APPLICATION_JSON
static final String	APPLICATION_XML
static final String	HIDDEN
static final String	IMAGE_PNG
static final String	TEXT_HTML
static final String	UTF8
static final String	UTF8_APPLICATION_JAVASCRIPT
static final String	UTF8_APPLICATION_JSON
static final String	UTF8_APPLICATION_XML
static final String	UTF8_CHARSET
static final String	UTF8_TEXT_HTML

Constructor Summary

Constructors

Constructor	Description
ServletUtil()

Method Summary

Modifier and Type	Method	Description
String	getFooter(Locale locale, String context)	Create a common footer.
String	getNavBar(Locale locale, String context)	Create a common navigation header.
String	getRailroadName(boolean inComments)	Get the railroad name for HTML documents.
String	getTitle(Locale locale, String title)	Return the complete title for an HTML document given the portion of the title specific to the document.
Date	setNonCachingHeaders(javax.servlet.http.HttpServletResponse response)	Set HTTP headers to prevent caching.
void	writeFile(javax.servlet.http.HttpServletResponse response, File file, String contentType)	Write a file to the given response.

Methods inherited from class java.lang.Object

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

Field Details

UTF8

public static final String UTF8

APPLICATION_JAVASCRIPT

public static final String APPLICATION_JAVASCRIPT

See Also:

• Constant Field Values

APPLICATION_JSON

public static final String APPLICATION_JSON

See Also:

• Constant Field Values

APPLICATION_XML

public static final String APPLICATION_XML

See Also:

• Constant Field Values

IMAGE_PNG

public static final String IMAGE_PNG

See Also:

• Constant Field Values

TEXT_HTML

public static final String TEXT_HTML

See Also:

• Constant Field Values

UTF8_CHARSET

public static final String UTF8_CHARSET

See Also:

• Constant Field Values

UTF8_APPLICATION_JAVASCRIPT

public static final String UTF8_APPLICATION_JAVASCRIPT

See Also:

• Constant Field Values

UTF8_APPLICATION_JSON

public static final String UTF8_APPLICATION_JSON

See Also:

• Constant Field Values

UTF8_APPLICATION_XML

public static final String UTF8_APPLICATION_XML

See Also:

• Constant Field Values

UTF8_TEXT_HTML

public static final String UTF8_TEXT_HTML

See Also:

• Constant Field Values

HIDDEN

public static final String HIDDEN

See Also:

• Constant Field Values

Constructor Details

ServletUtil

public ServletUtil()

Method Details

getRailroadName

public String getRailroadName(boolean inComments)

Get the railroad name for HTML documents.

Parameters:

inComments - Return the railroad name prepended and appended by closing and opening comment markers

Returns:

the Railroad name, possibly with formatting

getFooter

public String getFooter(Locale locale,
 String context)
                 throws IOException

Create a common footer.

Parameters:

locale - If a template is not available in locale, will return US English.

context - divs included in footer template with class context-<context>-only will be shown.

Returns:

an HTML footer

Throws:

IOException - if template cannot be located

getNavBar

public String getNavBar(Locale locale,
 String context)
                 throws IOException

Create a common navigation header.

Parameters:

locale - If a template is not available in locale, will return US English.

context - divs included in navigation bar template with class context-<context>-only will be shown.

Returns:

an HTML navigation bar

Throws:

IOException - if template cannot be located

setNonCachingHeaders

public Date setNonCachingHeaders(javax.servlet.http.HttpServletResponse response)

Set HTTP headers to prevent caching.

Parameters:

response - the response to set headers in

Returns:

the date used for headers setting expiration and modification times

writeFile

public void writeFile(javax.servlet.http.HttpServletResponse response,
 File file,
 String contentType)
               throws IOException

Write a file to the given response.

Parameters:

response - the response to write the file into

file - file to write

contentType - file mime content type

Throws:

IOException - if communications lost with client

getTitle

public String getTitle(Locale locale,
 String title)

Return the complete title for an HTML document given the portion of the title specific to the document.

Parameters:

locale - The requested Locale

title - Portion of title specific to page

Returns:

The complete title