WebUtil (OpenMRS 2.7.0-SNAPSHOT API)

java.lang.Object
- org.openmrs.web.WebUtil

All Implemented Interfaces:: GlobalPropertyListener

public class WebUtil
extends Object
implements GlobalPropertyListener

Constructor Summary

Constructors
Constructor and Description

WebUtil()

Constructors
Constructor and Description
`WebUtil()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`encodeForCDATA(String s)` Encodes data for an XML CDATA section.
`static String`	`encodeForCssString(String s)` Encodes for CSS strings.
`static String`	`encodeForCssUrl(String s)` Encodes for CSS URL contexts.
`static String`	`encodeForHtmlAttribute(String s)` Encodes for HTML text attributes.
`static String`	`encodeForHtmlContent(String s)` Encodes for HTML text content.
`static String`	`encodeForHtmlUnquotedAttribute(String s)` Encodes for unquoted HTML attribute values.
`static String`	`encodeForJava(String s)` Encodes for a Java string.
`static String`	`encodeForJavaScript(String s)` Encodes for a JavaScript string.
`static String`	`encodeForJavaScriptAttribute(String s)` This method encodes for JavaScript strings contained within HTML script attributes (such as onclick).
`static String`	`encodeForJavaScriptBlock(String s)` Encodes for JavaScript strings contained within HTML script blocks.
`static String`	`encodeForJavaScriptSource(String s)` Encodes for JavaScript strings contained within a JavaScript or JSON file.
`static String`	`encodeForUri(String s)` Performs percent-encoding of a URL according to RFC 3986.
`static String`	`encodeForUriComponent(String s)` Performs percent-encoding for a component of a URI, such as a query parameter name or value, path or query-string.
`static String`	`encodeForXml(String s)` Encodes for XML and XHTML.
`static String`	`encodeForXmlAttribute(String s)` Encodes for XML and XHTML attribute content.
`static String`	`encodeForXmlComment(String s)` Encodes for XML comments.
`static String`	`encodeForXmlContent(String s)` Encodes for XML and XHTML text content.
`static String`	`escapeHTML(String s)` Encodes for (X)HTML text content and text attributes.
`static String`	`escapeNewlines(String s)`
`static String`	`escapeQuotes(String s)`
`static String`	`escapeQuotesAndNewlines(String s)`
`static String`	`formatDate(Date date)`
`static String`	`formatDate(Date date, Locale locale, Format.FORMAT_TYPE type)`
`static String`	`getContextPath()` Method that returns WebConstants.WEBAPP_NAME or an empty string if WebConstants.WEBAPP_NAME is empty.
`void`	`globalPropertyChanged(GlobalProperty newValue)` Called after a global property is created or updated
`void`	`globalPropertyDeleted(String propertyName)` Called after a global property is deleted
`static Locale`	`normalizeLocale(String localeString)` This method checks if input locale string contains control characters and tries to clean up actually contained ones.
`static String`	`sanitizeLocales(String localesString)` Convenient method that parses the given string object, that contains locale parameters which are separated by comma.
`static String`	`stripFilename(String filename)` Strips out the path from a string if "C:\documents\file.doc", will return "file.doc" if "file.doc", will return "file.doc" if "/home/file.doc" will return "file.doc"
`boolean`	`supportsPropertyName(String propertyName)` Asks this listener whether it wants to be notified about the given property name

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - WebUtil
```
public WebUtil()
```
- Method Detail
  - escapeHTML
```
public static String escapeHTML(String s)
```
    Encodes for (X)HTML text content and text attributes.
    
    Parameters:
    
    s -
    
    Returns:
    
    Encoded String
  - encodeForCDATA
```
public static String encodeForCDATA(String s)
```
    Encodes data for an XML CDATA section.
    
    Parameters:
    
    s -
    
    Returns:
    
    Encoded String
  - encodeForCssString
```
public static String encodeForCssString(String s)
```
    Encodes for CSS strings.
    
    Parameters:
    
    s -
    
    Returns:
    
    Encoded String
  - encodeForCssUrl
```
public static String encodeForCssUrl(String s)
```
    Encodes for CSS URL contexts.
    
    Parameters:
    
    s -
    
    Returns:
    
    Encoded String
  - encodeForHtmlAttribute
```
public static String encodeForHtmlAttribute(String s)
```
    Encodes for HTML text attributes.
    
    Parameters:
    
    s -
    
    Returns:
    
    Encoded String
  - encodeForHtmlContent
```
public static String encodeForHtmlContent(String s)
```
    Encodes for HTML text content.
    
    Parameters:
    
    s -
    
    Returns:
    
    Encoded String
  - encodeForHtmlUnquotedAttribute
```
public static String encodeForHtmlUnquotedAttribute(String s)
```
    Encodes for unquoted HTML attribute values.
    
    Parameters:
    
    s -
    
    Returns:
    
    Encoded String
  - encodeForJava
```
public static String encodeForJava(String s)
```
    Encodes for a Java string.
    
    Parameters:
    
    s -
    
    Returns:
    
    Encoded String
  - encodeForJavaScript
```
public static String encodeForJavaScript(String s)
```
    Encodes for a JavaScript string.
    
    Parameters:
    
    s -
    
    Returns:
    
    Encoded String
  - encodeForJavaScriptAttribute
```
public static String encodeForJavaScriptAttribute(String s)
```
    This method encodes for JavaScript strings contained within HTML script attributes (such as onclick).
    
    Parameters:
    
    s -
    
    Returns:
    
    Encoded String
  - encodeForJavaScriptBlock
```
public static String encodeForJavaScriptBlock(String s)
```
    Encodes for JavaScript strings contained within HTML script blocks.
    
    Parameters:
    
    s -
    
    Returns:
    
    Encoded String
  - encodeForJavaScriptSource
```
public static String encodeForJavaScriptSource(String s)
```
    Encodes for JavaScript strings contained within a JavaScript or JSON file.
    
    Parameters:
    
    s -
    
    Returns:
    
    Encoded String
  - encodeForUri
```
public static String encodeForUri(String s)
```
    Performs percent-encoding of a URL according to RFC 3986.
    
    Parameters:
    
    s -
    
    Returns:
    
    Encoded String
  - encodeForUriComponent
```
public static String encodeForUriComponent(String s)
```
    Performs percent-encoding for a component of a URI, such as a query parameter name or value, path or query-string.
    
    Parameters:
    
    s -
    
    Returns:
    
    Encoded String
  - encodeForXml
```
public static String encodeForXml(String s)
```
    Encodes for XML and XHTML.
    
    Parameters:
    
    s -
    
    Returns:
    
    Encoded String
  - encodeForXmlAttribute
```
public static String encodeForXmlAttribute(String s)
```
    Encodes for XML and XHTML attribute content.
    
    Parameters:
    
    s -
    
    Returns:
    
    Encoded String
  - encodeForXmlComment
```
public static String encodeForXmlComment(String s)
```
    Encodes for XML comments.
    
    Parameters:
    
    s -
    
    Returns:
    
    Encoded String
  - encodeForXmlContent
```
public static String encodeForXmlContent(String s)
```
    Encodes for XML and XHTML text content.
    
    Parameters:
    
    s -
    
    Returns:
    
    Encoded String
  - escapeQuotes
```
public static String escapeQuotes(String s)
```
  - escapeNewlines
```
public static String escapeNewlines(String s)
```
  - escapeQuotesAndNewlines
```
public static String escapeQuotesAndNewlines(String s)
```
  - stripFilename
```
public static String stripFilename(String filename)
```
    Strips out the path from a string if "C:\documents\file.doc", will return "file.doc" if "file.doc", will return "file.doc" if "/home/file.doc" will return "file.doc"
    
    Parameters:
    
    filename -
    
    Returns:
    
    filename stripped down
  - normalizeLocale
```
public static Locale normalizeLocale(String localeString)
```
    This method checks if input locale string contains control characters and tries to clean up actually contained ones. Also it parses locale object from string representation and validates it object.
    
    Parameters:
    
    localeString - input string with locale parameter
    
    Returns:
    
    locale object for input string if CTLs were cleaned up or weren't exist or null if could not to clean up CTLs from input string Should ignore leading spaces Should accept language only locales Should not accept invalid locales Should not fail with empty strings Should not fail with whitespace only Should not fail with "_" character only
  - sanitizeLocales
```
public static String sanitizeLocales(String localesString)
```
    Convenient method that parses the given string object, that contains locale parameters which are separated by comma. Tries to clean up CTLs and other unsupported chars within input string. If invalid locales are included, they are not returned in the resultant list
    
    Parameters:
    
    localesString - input string with locale parameters separeted by comma (e.g. "en, fr_RW, gh")
    
    Returns:
    
    cleaned up string (or same string) if success or null otherwise
    
    See Also:
    
    Should skip over invalid locales Should not fail with empty string
  - getContextPath
```
public static String getContextPath()
```
    Method that returns WebConstants.WEBAPP_NAME or an empty string if WebConstants.WEBAPP_NAME is empty.
    
    Returns:
    
    return WebConstants.WEBAPP_NAME or empty string if WebConstants.WEBAPP_NAME is null Should return empty string if WebConstants.WEBAPP_NAME is null
  - formatDate
```
public static String formatDate(Date date)
```
  - formatDate
```
public static String formatDate(Date date,
                                Locale locale,
                                Format.FORMAT_TYPE type)
```
  - supportsPropertyName
```
public boolean supportsPropertyName(String propertyName)
```
    Description copied from interface: GlobalPropertyListener
    
    Asks this listener whether it wants to be notified about the given property name
    
    Specified by:
    
    supportsPropertyName in interface GlobalPropertyListener
    
    Returns:
    
    whether this listener wants its action methods to be notified of properties with the given name
    
    See Also:
    
    GlobalPropertyListener.supportsPropertyName(java.lang.String)
  - globalPropertyChanged
```
public void globalPropertyChanged(GlobalProperty newValue)
```
    Description copied from interface: GlobalPropertyListener
    
    Called after a global property is created or updated
    
    Specified by:
    
    globalPropertyChanged in interface GlobalPropertyListener
    
    Parameters:
    
    newValue - the new value of the property that was just saved
    
    See Also:
    
    GlobalPropertyListener.globalPropertyChanged(org.openmrs.GlobalProperty)
  - globalPropertyDeleted
```
public void globalPropertyDeleted(String propertyName)
```
    Description copied from interface: GlobalPropertyListener
    
    Called after a global property is deleted
    
    Specified by:
    
    globalPropertyDeleted in interface GlobalPropertyListener
    
    Parameters:
    
    propertyName - the name of the property that was just deleted
    
    See Also:
    
    GlobalPropertyListener.globalPropertyDeleted(java.lang.String)

Class WebUtil

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

WebUtil

Method Detail

escapeHTML

encodeForCDATA

encodeForCssString

encodeForCssUrl

encodeForHtmlAttribute

encodeForHtmlContent

encodeForHtmlUnquotedAttribute

encodeForJava

encodeForJavaScript

encodeForJavaScriptAttribute

encodeForJavaScriptBlock

encodeForJavaScriptSource

encodeForUri

encodeForUriComponent

encodeForXml

encodeForXmlAttribute

encodeForXmlComment

encodeForXmlContent

escapeQuotes

escapeNewlines

escapeQuotesAndNewlines

stripFilename

normalizeLocale

sanitizeLocales

getContextPath

formatDate

formatDate

supportsPropertyName

globalPropertyChanged

globalPropertyDeleted