com.plumtree.uiinfrastructure.statichelpers
Class HTTPHelpers

java.lang.Object
  com.plumtree.uiinfrastructure.statichelpers.HTTPHelpers

public class HTTPHelpers
extends java.lang.Object

This class contains helpers for dealing with HTTP, QS, JS, and other URL related issues.

Author:

RickyW

Constructor Summary

HTTPHelpers()

Method Summary

static void	AppendQSArgument(XPStringBuilder _sbArgs, java.lang.String _strArgName) This helper adds a QS name to your XPStringBuilder.
static void	AppendQSArgument(XPStringBuilder _sbArgs, java.lang.String _strArgName, int _nArgValue)
static void	AppendQSArgument(XPStringBuilder _sbArgs, java.lang.String _strArgName, int _nArgValue, boolean _bLeaveOutAmpersand) This helper adds a QS name/value pair to your XPStringBuilder.
static void	AppendQSArgument(XPStringBuilder _sbArgs, java.lang.String _strArgName, java.lang.String _strArgValue) This helper adds a QS name/value pair to your XPStringBuilder.
static void	AppendQSArgument(XPStringBuilder _sbArgs, java.lang.String _strArgName, java.lang.String _strArgValue, boolean _bLeaveOutAmpersand) This helper adds a QS name/value pair to your XPStringBuilder.
static void	CheckIntegrityOfParameterArrays(java.lang.String[] strParamNames, java.lang.String[] strParamValues)
static boolean	GetArgumentAsBoolean(XPHashtable _htArguments, java.lang.String _strKey, boolean _bDefault) This helper method retrieves a single argument from the argument hashtable.
static int	GetArgumentAsInt(XPHashtable _htArguments, java.lang.String _strKey, int _nDefault) This helper method retrieves a single argument from the argument hashtable.
static java.lang.String	GetArgumentAsString(XPHashtable _htArguments, java.lang.String _strKey, java.lang.String _strDefault) This helper method retrieves a single argument from the argument hashtable.
static java.lang.String	GetParameterArrayAsString(java.lang.String[] listParamNames, java.lang.String[] listParamValues)
static java.lang.String	GetParameterListAsString(XPArrayList listParamNames, XPArrayList listParamValues)
static java.lang.String	GetQSArgString(java.lang.String _strArgName) This helper generates the QS argument string from the given argument name.
static java.lang.String	GetQSArgString(java.lang.String _strArgName, int _nArgValue) This helper adds a QS name/value pair to your XPStringBuilder.
static java.lang.String	GetQSArgString(java.lang.String _strArgName, java.lang.String _strArgValue) This helper adds a QS name/value pair to your XPStringBuilder.
static java.lang.String	GetQueryString(XPHashtable _htArguments) Returns a query string for the redirect containing all the control arguments.
static boolean	StringHasUnsafeURLCharacters(java.lang.String _strInput) Helper method to determine if the given string contains characters that we have deemed to be unsafe for URLs, indicating possible hack attempts.

Methods inherited from class java.lang.Object

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

Constructor Detail

HTTPHelpers

public HTTPHelpers()

Method Detail

GetArgumentAsInt

public static final int GetArgumentAsInt(XPHashtable _htArguments,
                                         java.lang.String _strKey,
                                         int _nDefault)

This helper method retrieves a single argument from the argument hashtable. If the argument does not exist or is null, the default value will be used.

Parameters:

_htArguments - Arguments to reach the new space.

_strKey - The key for the argument you want.

_nDefault - Value to return if argument is null.

Returns:

The specified argument from the argument hashtable.

GetArgumentAsString

public static final java.lang.String GetArgumentAsString(XPHashtable _htArguments,
                                                         java.lang.String _strKey,
                                                         java.lang.String _strDefault)

This helper method retrieves a single argument from the argument hashtable. If the argument does not exist or is null, the default value will be used.

Parameters:

_htArguments - Arguments to reach the new space.

_strKey - The key for the argument you want.

_strDefault - Value to return if argument is null.

Returns:

The specified argument from the argument hashtable.

GetArgumentAsBoolean

public static final boolean GetArgumentAsBoolean(XPHashtable _htArguments,
                                                 java.lang.String _strKey,
                                                 boolean _bDefault)

This helper method retrieves a single argument from the argument hashtable. If the argument does not exist or is null, the default value will be used.

Parameters:

_htArguments - Arguments to reach the new space.

_strKey - The key for the argument you want.

_bDefault - Value to return if argument is null.

Returns:

The specified argument from the argument hashtable.

AppendQSArgument

public static final void AppendQSArgument(XPStringBuilder _sbArgs,
                                          java.lang.String _strArgName)

This helper adds a QS name to your XPStringBuilder. If the argument name is null, nothing is added.

Parameters:

_sbArgs - XPStringBuilder to append to.

_strArgName - Name of name/value pair.

AppendQSArgument

public static final void AppendQSArgument(XPStringBuilder _sbArgs,
                                          java.lang.String _strArgName,
                                          java.lang.String _strArgValue)

This helper adds a QS name/value pair to your XPStringBuilder. If the argument name or value is null or empty, nothing is added.

Parameters:

_sbArgs - XPStringBuilder to append to.

_strArgName - Name of name/value pair.

_strArgValue - Value of name/value pair.

AppendQSArgument

public static final void AppendQSArgument(XPStringBuilder _sbArgs,
                                          java.lang.String _strArgName,
                                          java.lang.String _strArgValue,
                                          boolean _bLeaveOutAmpersand)

This helper adds a QS name/value pair to your XPStringBuilder. If the argument name or value is null or empty, nothing is added.

Parameters:

_sbArgs - XPStringBuilder to append to.

_strArgName - Name of name/value pair.

_strArgValue - Value of name/value pair.

_bLeaveOutAmpersand - True to leave out the leading "&".

AppendQSArgument

public static final void AppendQSArgument(XPStringBuilder _sbArgs,
                                          java.lang.String _strArgName,
                                          int _nArgValue)

Parameters:

_sbArgs -

_strArgName -

_nArgValue -

AppendQSArgument

public static final void AppendQSArgument(XPStringBuilder _sbArgs,
                                          java.lang.String _strArgName,
                                          int _nArgValue,
                                          boolean _bLeaveOutAmpersand)

This helper adds a QS name/value pair to your XPStringBuilder. If the argument name is null, or if the argument value is -1, nothing is added.

Parameters:

_sbArgs - XPStringBuilder to append to.

_strArgName - Name of name/value pair.

_nArgValue - Value of name/value pair.

_bLeaveOutAmpersand - True to leave out the leading "&".

GetQSArgString

public static final java.lang.String GetQSArgString(java.lang.String _strArgName)

This helper generates the QS argument string from the given argument name. If the argument name is null, empty string is returned.

Parameters:

_strArgName - Name of name/value pair.

Returns:

Argument string to add to your QS.

GetQSArgString

public static final java.lang.String GetQSArgString(java.lang.String _strArgName,
                                                    java.lang.String _strArgValue)

This helper adds a QS name/value pair to your XPStringBuilder. If the argument name or value is null or empty, nothing is added.

Parameters:

_strArgName - Name of name/value pair.

_strArgValue - Value of name/value pair.

Returns:

Argument string to add to your QS.

GetQSArgString

public static final java.lang.String GetQSArgString(java.lang.String _strArgName,
                                                    int _nArgValue)

This helper adds a QS name/value pair to your XPStringBuilder. If the argument name is null, or if the argument value is -1, nothing is added.

Parameters:

_strArgName - Name of name/value pair.

_nArgValue - Value of name/value pair.

Returns:

Argument string to add to your QS.

StringHasUnsafeURLCharacters

public static final boolean StringHasUnsafeURLCharacters(java.lang.String _strInput)

Helper method to determine if the given string contains characters that we have deemed to be unsafe for URLs, indicating possible hack attempts.

Parameters:

__strInput -

Returns:

True if string contains unsafe characters.

GetQueryString

public static java.lang.String GetQueryString(XPHashtable _htArguments)

Returns a query string for the redirect containing all the control arguments. Copied from com.plumtree.uiinfrastructure.activityspace.Redirect.

Returns:

String The querystring, excluding the question mark.

GetParameterArrayAsString

public static java.lang.String GetParameterArrayAsString(java.lang.String[] listParamNames,
                                                         java.lang.String[] listParamValues)

Returns:

CheckIntegrityOfParameterArrays

public static void CheckIntegrityOfParameterArrays(java.lang.String[] strParamNames,
                                                   java.lang.String[] strParamValues)

Parameters:

strParamNames -

strParamValues -

GetParameterListAsString

public static java.lang.String GetParameterListAsString(XPArrayList listParamNames,
                                                        XPArrayList listParamValues)

Returns: