com.sapportals.portal.prt.util

Class StringUtils

java.lang.Object

com.sapportals.portal.prt.util.StringUtils

Deprecated.

Use the class XSSEncoder instead

public class StringUtils
extends Object

StringUtils is a collection of String utilities in the web environment. Many of the methods of this class serve to get correct and cross-site scripting safe encoding for usage in HTML mark-up, JavaScript String, and URLs.

Most of the methods of this class are depreciated. Please use the class XSSEncoder for encoding / escaping according the SAP XSS Secure Programming Guide

See Also:

XSSEncoder

Field Summary

Fields

Modifier and Type	Field and Description
protected static StringBufferPool	BUFFER_POOL_URLS Deprecated.
protected static int	URL_SIZE Deprecated.

Constructor Summary

Constructors

Constructor and Description
StringUtils() Deprecated.

Method Summary

Modifier and Type	Method and Description
static String	escapeScriptEndTag(String pStr) Deprecated. Use the class XSSEncoder instead
static String	escapeToAttributeValue(String input) Deprecated. Use the class XSSEncoder method encodeHTML instead
static String	escapeToAttributeValue(String input, int maxLength) Deprecated. Use the class XSSEncoder method encodeHTML instead
static String	escapeToHTML(String input) Deprecated. Use the class XSSEncoder method encodeHTML instead
static String	escapeToHTML(String input, int maxLength) Deprecated. Use the class XSSEncoder method encodeHTML instead
static String	escapeToJS(String input) Deprecated. Use the class XSSEncoder method encodeJavaScript instead
static String	escapeToJS(String input, int maxLength) Deprecated. Use the class XSSEncoder method encodeJavaScript instead
static String	escapeToURL(String input) Deprecated. Use the class XSSEncoder method encodeHTML instead
static String	escapeToURL(String input, int maxLength) Deprecated. Use the class XSSEncoder method encodeHTML instead
static boolean	isEmpty(String str) Deprecated.
static String[]	tokenize(String szInput, char delimiter) Deprecated. Take the given string and chop it up into a series of strings.
static String[]	tokenize(String szInput, String szDelim) Deprecated. Take the given string and chop it up into a series of strings.
static List	tokenizeInList(String szInput, char delimiter) Deprecated. Take the given string and chop it up into a List.
static List	tokenizeInList(String szInput, String szDelim) Deprecated. Take the given string and chop it up into a List
static String	urlEncode(String s) Deprecated. Use the class XSSEncoder method escapeURL instead
static String	urlEncode(String s, char[] forceEncode) Deprecated. Use the class XSSEncoder method escapeURL instead
static SharedString	urlEncodeShared(String s, char[] forceEncode) Deprecated. This is an extended version of the URLEncoder.encode method.

Methods inherited from class java.lang.Object

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

Field Detail

BUFFER_POOL_URLS

protected static StringBufferPool BUFFER_POOL_URLS

Deprecated.

URL_SIZE

protected static int URL_SIZE

Deprecated.

Constructor Detail

StringUtils

public StringUtils()

Deprecated.

Method Detail

escapeToJS

public static String escapeToJS(String input)

Deprecated. Use the class XSSEncoder method encodeJavaScript instead

Encode a string inside a JS string declaration (CASE5)

Parameters:

input - The string to parse.

escapeToJS

public static String escapeToJS(String input,
                                int maxLength)

Deprecated. Use the class XSSEncoder method encodeJavaScript instead

Encode a string inside a JS string declaration (CASE5)

Parameters:

input - The string to parse.

maxLength - The maximum length the String input SHOULD have

escapeToHTML

public static String escapeToHTML(String input)

Deprecated. Use the class XSSEncoder method encodeHTML instead

Encode a string for output between tags (CASE1)

Parameters:

input - The string to parse.

escapeToHTML

public static String escapeToHTML(String input,
                                  int maxLength)

Deprecated. Use the class XSSEncoder method encodeHTML instead

Encode a string for output between tags (CASE1)

Parameters:

input - The string to parse.

maxLength - The maximum length the String input SHOULD have

escapeToAttributeValue

public static String escapeToAttributeValue(String input)

Deprecated. Use the class XSSEncoder method encodeHTML instead

Encode a string for output as an attribute string of a tag, no URLs! (CASE2)

Parameters:

input - The string to parse.

escapeToAttributeValue

public static String escapeToAttributeValue(String input,
                                            int maxLength)

Deprecated. Use the class XSSEncoder method encodeHTML instead

Encode a string for output as an attribute string of a tag, no URLs! (CASE2)

Parameters:

input - The string to parse.

maxLength - The maximum length the String input SHOULD have

escapeToURL

public static String escapeToURL(String input)

Deprecated. Use the class XSSEncoder method encodeHTML instead

Encode a string that represents a URL (CASE3) Note that this function will call 'disableScriptSignatures'. Please read the note on that function as well.

Parameters:

input - The string to parse.

escapeToURL

public static String escapeToURL(String input,
                                 int maxLength)

Deprecated. Use the class XSSEncoder method encodeHTML instead

Encode a string that represents a URL (CASE3) Note that this function will call 'disableScriptSignatures'. Please read the note on that function as well.

Parameters:

input - The string to parse.

maxLength - The maximum length the String input SHOULD have

escapeScriptEndTag

public static String escapeScriptEndTag(String pStr)

Deprecated. Use the class XSSEncoder instead

Prepare a string to be used for a javascript string definition with particular care about script tag. In particular this fixes html parsing problems with </script>.

Parameters:

pStr - input The string to parse.

urlEncode

public static String urlEncode(String s,
                               char[] forceEncode)

Deprecated. Use the class XSSEncoder method escapeURL instead

This is an extended version of the URLEncoder.encode method. It allows to specify more characters to be encoded.

Parameters:

s - The String to be encoded

forceEncode - An array of chars that are to be encoded explicitly. Note: forceEncode should NOT contain digits nor the percent sign!!

urlEncodeShared

public static SharedString urlEncodeShared(String s,
                                           char[] forceEncode)

Deprecated.

This is an extended version of the URLEncoder.encode method. It allows to specify more characters to be encoded.

Parameters:

s - The Shared String to be encoded.
One has to call SharedString.release() in order to free the underlying string resource!

forceEncode - An array of chars that are to be encoded explicitely. Note: forceEncode should NOT contain digits nor the percent sign!!

urlEncode

public static String urlEncode(String s)

Deprecated. Use the class XSSEncoder method escapeURL instead

A trivial replacement of URLEncoder.encode

Parameters:

s - The String to be encoded

tokenize

public static String[] tokenize(String szInput,
                                String szDelim)

Deprecated.

Take the given string and chop it up into a series of strings.

Parameters:

szInput - the input String

szDelim - the delimiter string

Returns:

an array of strings

tokenizeInList

public static List tokenizeInList(String szInput,
                                  String szDelim)

Deprecated.

Take the given string and chop it up into a List

Parameters:

szInput - the input String

szDelim - the delimiter string

Returns:

a List of strings

tokenize

public static String[] tokenize(String szInput,
                                char delimiter)

Deprecated.

Take the given string and chop it up into a series of strings. Better use this optimal version when the tokens are separated by a character.

Parameters:

szInput - the input String

delimiter - the delimiter character

Returns:

an array of strings

tokenizeInList

public static List tokenizeInList(String szInput,
                                  char delimiter)

Deprecated.

Take the given string and chop it up into a List. Better use this optimal version when the tokens are separated by a character.

Parameters:

szInput - the input String

delimiter - the delimiter character

Returns:

a List of strings

isEmpty

public static boolean isEmpty(String str)

Deprecated.