sapphire.util

Class HttpUtil

java.lang.Object

com.labvantage.sapphire.BaseClass

sapphire.util.HttpUtil

public class HttpUtil
extends com.labvantage.sapphire.BaseClass

Utility class providing methods to manipulate cookies and redirecting

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	STANDARD_ENCODE
static java.lang.String	UTF8

Fields inherited from class com.labvantage.sapphire.BaseClass

FAILURE, SUCCESS

Constructor Summary

Constructors

Constructor and Description
HttpUtil() HttpUtil Constructor
HttpUtil(HttpServletRequest request, HttpServletResponse response) HttpUtil Constructor option2
HttpUtil(HttpServletResponse response) HttpUtil Constructor option3
HttpUtil(PageContext pagecontext) HttpUtil Constructor option1

Method Summary

Modifier and Type	Method and Description
static java.lang.String	appendRequestParameters(PageContext pageContext, java.lang.String url)
static java.lang.String	decode(java.lang.String str) Decodes a String that is encoded using HttpUtil.encode method
static java.lang.String	decodeURIComponent(java.lang.String component) Performs decoding on a URL component (individual parameter values) that has been encoded client-side using JavaScript encodeURIComponent.
static java.lang.String	decodeURIComponent(java.lang.String component, java.lang.String encoding) Performs decoding on a URL component (individual parameter values) that has been encoded client-side using JavaScript encodeURIComponent
static java.lang.String	decrypt(java.lang.String text)
static java.lang.String	encode(java.lang.String str) Encodes a String value for BO authentication
static java.lang.String	encodeURIComponent(java.lang.String component) Performs encoding on a URL component (individual parameter values) that can safely be decoded on the client-side using JavaScript decodeURIComponent.
static java.lang.String	encodeURIComponent(java.lang.String component, java.lang.String encoding) Performs encoding on a URL component (individual parameter values) that can safely be decoded on the client-side using JavaScript decodeURIComponent
boolean	existCookie(java.lang.String name) Checks for the existence of a cookie (requires constructor option1 or option2)
static java.lang.String	getApplicationHome() Gets the APPLICATION_HOME folder
static java.lang.String	getAppRoot(ServletContext servletContext) Gets the root folder for the application server
static java.lang.String	getConnectionId(javax.servlet.jsp.PageContext pageContext) Gets the current sapphire connectionid from the page Context
static com.labvantage.sapphire.services.ConnectionInfo	getConnectionInfo(javax.servlet.jsp.PageContext pageContext) Gets the current sapphire ConnectionInfo from the page Context
java.util.HashMap	getCookies() Get cookies
java.lang.String	getCookieValue(java.lang.String name) Gets a cookie value (requires constructor option1 or option2 or option3)
static java.lang.String	getEncryptionJS() Gets the core sapphire javascript encryption API
static java.lang.String	getEncryptionJS(boolean useFullIncludes)
static java.lang.String	getEncryptionJS(java.lang.String pathpreifx)
static java.lang.String	getEncryptionJS(java.lang.String pathpreifx, boolean useFullIncludes)
static java.lang.String	getGWTEncryptionJS(java.io.File consoleConfigFile)
static java.lang.String	getNameServerList(javax.servlet.jsp.PageContext pageContext) Deprecated.
static java.util.HashMap<java.lang.String,java.lang.String>	getQueryStringMap(java.net.URL url) Converts a query string in a URL to a hashmap of parameter and value
static java.util.HashMap	getRequestMap(ServletRequest request) Puts the request parameters into a convenient hashmap
static PropertyList	getRequestPropertyList(ServletRequest request) Puts the request parameters into a convenient propertylist
static java.lang.String	getSapphireHome() Gets the SAPPHIRE_HOME folder
static java.util.Locale	getSessionLocale(PageContext pageContext) Returns the current user's locale
static java.util.TimeZone	getSessionTimeZone(PageContext pageContext) Returns the current user's timezone
static java.lang.String	getWebAppRoot(ServletContext servletContext) Gets the root folder for the web application
void	goErrorPage(java.lang.String errorpage, java.lang.String errormsg) Redirects to an error page if the response has not been commited, otherwise displays the error message (requires constructor option1)
void	removeCookie(java.lang.String name) Removes a cookie, i.e.
void	setCookieValue(java.lang.String name, java.lang.String value) Sets a cookie value (requires constructor option1 or option2 or option3)
void	setCookieValue(java.lang.String name, java.lang.String value, boolean permenant) Sets a cookie value (requires constructor option1 or option2 or option3)
void	setCookieValue(java.lang.String name, java.lang.String value, boolean permenant, boolean httponly) Sets a cookie value (requires constructor option1 or option2 or option3)
static void	setRequestVariables(HttpServletRequest request, java.lang.String varName, PropertyList propertyList)

Methods inherited from class java.lang.Object

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

Field Detail

UTF8

public static final java.lang.String UTF8

See Also:

Constant Field Values

STANDARD_ENCODE

public static final java.lang.String STANDARD_ENCODE

See Also:

Constant Field Values

Constructor Detail

HttpUtil

public HttpUtil()

HttpUtil Constructor

HttpUtil

public HttpUtil(PageContext pagecontext)

HttpUtil Constructor option1

Parameters:

pagecontext - A valid pointer to the PageContext

HttpUtil

public HttpUtil(HttpServletRequest request,
                HttpServletResponse response)

HttpUtil Constructor option2

Parameters:

request - A valid pointer to the HttpServletRequest

response - A valid pointer to the HttpServletResponse

HttpUtil

public HttpUtil(HttpServletResponse response)

HttpUtil Constructor option3

Parameters:

response - A valid pointer to the HttpServletResponse

Method Detail

existCookie

public boolean existCookie(java.lang.String name)

Checks for the existence of a cookie (requires constructor option1 or option2)

Parameters:

name - Name of the cookie to retrieve

Returns:

true If the cookie exists and its value is different to 'null'.

removeCookie

public void removeCookie(java.lang.String name)

Removes a cookie, i.e. sets its value to null (requires constructor option1 or option2)

Parameters:

name - Name of the cookie to remove

setCookieValue

public void setCookieValue(java.lang.String name,
                           java.lang.String value)

Sets a cookie value (requires constructor option1 or option2 or option3)

Parameters:

name - Name of the cookie to update

value - New value for the cookie

setCookieValue

public void setCookieValue(java.lang.String name,
                           java.lang.String value,
                           boolean permenant)

Sets a cookie value (requires constructor option1 or option2 or option3)

Parameters:

name - Name of the cookie to update

value - New value for the cookie

permenant - True if cookie is permenant

setCookieValue

public void setCookieValue(java.lang.String name,
                           java.lang.String value,
                           boolean permenant,
                           boolean httponly)

Sets a cookie value (requires constructor option1 or option2 or option3)

Parameters:

name - Name of the cookie to update

value - New value for the cookie

permenant - True if cookie is permenant

httponly - True if cookie is to be httponly

getCookieValue

public java.lang.String getCookieValue(java.lang.String name)

Gets a cookie value (requires constructor option1 or option2 or option3)

Parameters:

name - Name of the cookie

Returns:

The cookie value if different to null, an empty string otherwise

getCookies

public java.util.HashMap getCookies()

Get cookies

Returns:

Hashmap of all cookie values

goErrorPage

public void goErrorPage(java.lang.String errorpage,
                        java.lang.String errormsg)

Redirects to an error page if the response has not been commited, otherwise displays the error message (requires constructor option1)

Parameters:

errorpage -

errormsg -

getAppRoot

public static java.lang.String getAppRoot(ServletContext servletContext)

Gets the root folder for the application server

Parameters:

servletContext - The current servletContext

Returns:

The full path of the application server root directory

getWebAppRoot

public static java.lang.String getWebAppRoot(ServletContext servletContext)

Gets the root folder for the web application

Parameters:

servletContext - The current servletContext

Returns:

The full path of the web server root

getSapphireHome

public static java.lang.String getSapphireHome()

Gets the SAPPHIRE_HOME folder

Returns:

The full path of the SAPPHIRE_HOME folder

getApplicationHome

public static java.lang.String getApplicationHome()

Gets the APPLICATION_HOME folder

Returns:

The full path of the APPLICATION_HOME folder

getRequestPropertyList

public static PropertyList getRequestPropertyList(ServletRequest request)

Puts the request parameters into a convenient propertylist

Parameters:

request - The current servlet Request

Returns:

PropertyList containing the request parameters

getRequestMap

public static java.util.HashMap getRequestMap(ServletRequest request)

Puts the request parameters into a convenient hashmap

Parameters:

request - The current servlet Request

Returns:

HashMap containing the request parameters

getQueryStringMap

public static java.util.HashMap<java.lang.String,java.lang.String> getQueryStringMap(java.net.URL url)

Converts a query string in a URL to a hashmap of parameter and value

Parameters:

url - the url to process

Returns:

Hashmap containing the query string parameters

setRequestVariables

public static void setRequestVariables(HttpServletRequest request,
                                       java.lang.String varName,
                                       PropertyList propertyList)

appendRequestParameters

public static java.lang.String appendRequestParameters(PageContext pageContext,
                                                       java.lang.String url)

getConnectionId

public static java.lang.String getConnectionId(javax.servlet.jsp.PageContext pageContext)

Gets the current sapphire connectionid from the page Context

Parameters:

pageContext - The current pageContext

Returns:

The current connectionid

getConnectionInfo

public static com.labvantage.sapphire.services.ConnectionInfo getConnectionInfo(javax.servlet.jsp.PageContext pageContext)

Gets the current sapphire ConnectionInfo from the page Context

Parameters:

pageContext - The current pageContext

Returns:

The current ConnectionInfo

getNameServerList

public static java.lang.String getNameServerList(javax.servlet.jsp.PageContext pageContext)

Deprecated.

Gets the nameserverlist from the page Context

Parameters:

pageContext - The current pageContext

Returns:

The current connectionid

getEncryptionJS

public static java.lang.String getEncryptionJS()

Gets the core sapphire javascript encryption API

Returns:

javascript

getEncryptionJS

public static java.lang.String getEncryptionJS(boolean useFullIncludes)

getGWTEncryptionJS

public static java.lang.String getGWTEncryptionJS(java.io.File consoleConfigFile)

getEncryptionJS

public static java.lang.String getEncryptionJS(java.lang.String pathpreifx)

getEncryptionJS

public static java.lang.String getEncryptionJS(java.lang.String pathpreifx,
                                               boolean useFullIncludes)

encode

public static java.lang.String encode(java.lang.String str)

Encodes a String value for BO authentication

Parameters:

str - String to be encoded

Returns:

encoded string

decode

public static java.lang.String decode(java.lang.String str)

Decodes a String that is encoded using HttpUtil.encode method

Parameters:

str - String to be decoded

Returns:

decoded string

getSessionTimeZone

public static java.util.TimeZone getSessionTimeZone(PageContext pageContext)

Returns the current user's timezone

Parameters:

pageContext -

Returns:

the Java Timezone

getSessionLocale

public static java.util.Locale getSessionLocale(PageContext pageContext)

Returns the current user's locale

Parameters:

pageContext -

Returns:

the Java Locale

encodeURIComponent

public static java.lang.String encodeURIComponent(java.lang.String component)

Performs encoding on a URL component (individual parameter values) that can safely be decoded on the client-side using JavaScript decodeURIComponent. Assumes UTF-8 encoding

Parameters:

component - String to be encoded

Returns:

the encoded String

encodeURIComponent

public static java.lang.String encodeURIComponent(java.lang.String component,
                                                  java.lang.String encoding)

Performs encoding on a URL component (individual parameter values) that can safely be decoded on the client-side using JavaScript decodeURIComponent

Parameters:

component - String to be encoded

encoding - What encoding to use

Returns:

the encoded String

decodeURIComponent

public static java.lang.String decodeURIComponent(java.lang.String component)

Performs decoding on a URL component (individual parameter values) that has been encoded client-side using JavaScript encodeURIComponent. Assumes UTF-8 encoding

Parameters:

component - String to be decoded

Returns:

the decoded String

decodeURIComponent

public static java.lang.String decodeURIComponent(java.lang.String component,
                                                  java.lang.String encoding)

Performs decoding on a URL component (individual parameter values) that has been encoded client-side using JavaScript encodeURIComponent

Parameters:

component - String to be decoded

Returns:

the decoded String

decrypt

public static java.lang.String decrypt(java.lang.String text)