com.github.bordertech.wcomponents.addons.common.relative

Class EnvironmentHelper

java.lang.Object

com.github.bordertech.wcomponents.addons.common.relative.EnvironmentHelper

public final class EnvironmentHelper
extends Object

Environment helper to make the environment details available on the thread.

Allows relative base URLs to be used so the URLs can be used in different contexts without changing.

Author:

jonathan

Method Summary

Methods

Modifier and Type	Method and Description
static void	clearDetails() Clear the details of the current Environment on the thread.
static String	getBaseUrl() Get the base URL at which this web application is hosted.
static String	getSecureServletPath() Get the path of the secure servlet.
static String	prefixBaseUrl(String relativeUrl) Helper method to append the base URL.
static String	prefixSecureServletPath(String relativeUrl) Helper method to append the secure servlet path.
static void	setEnvironment(com.github.bordertech.wcomponents.Environment env)

Methods inherited from class java.lang.Object

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

Method Detail

clearDetails

public static void clearDetails()

Clear the details of the current Environment on the thread.

setEnvironment

public static void setEnvironment(com.github.bordertech.wcomponents.Environment env)

Parameters:

env - the current environment details

getBaseUrl

public static String getBaseUrl()

Get the base URL at which this web application is hosted.

Implementations ensure that this method returns a URL WITHOUT a trailing slash, as in above example.

Returns:

the base url at which this web application is hosted.

prefixBaseUrl

public static String prefixBaseUrl(String relativeUrl)

Helper method to append the base URL.

Parameters:

relativeUrl - the relative URL

Returns:

the URL with the base URL appended

getSecureServletPath

public static String getSecureServletPath()

Get the path of the secure servlet.

Implementations ensure that this method returns a URL WITH a trailing slash.

Returns:

the secure servlet path at which this web application is hosted.

prefixSecureServletPath

public static String prefixSecureServletPath(String relativeUrl)

Helper method to append the secure servlet path.

Parameters:

relativeUrl - the relative URL to prefix with the servlet path

Returns:

the relative URL with the sevlet path