fr.paris.lutece.portal.service.util

Class AppPathService

java.lang.Object

fr.paris.lutece.portal.service.util.AppPathService

public final class AppPathService
extends Object

this class provides services for locate repository or url

Field Summary

Fields

Modifier and Type	Field and Description
static String	SESSION_BASE_URL

Method Summary

Methods

Modifier and Type	Method and Description
static UrlItem	buildRedirectUrlItem(String strRootUrl, String strUrlPropertySuffixKey) Build the url item to use for a url that includes the redirection parameter for reconnection.
static String	getAbsolutePathFromRelativePath(String strDirectory) Returns the absolute path of a repository from a relative path
static String	getAbsoluteUrl(javax.servlet.http.HttpServletRequest request, String strUrl) Returns the absolute url corresponding to the given one, if the later was found to be relative.
static String	getAdminMenuUrl() Returns the admin menu page relative url (jsp/admin/site/AdminMenu.jsp) defined in lutece.properties
static String	getAdminPortalUrl() Returns the admin portal page relative url (jsp/admin/site/AdminSite.jsp) defined in lutece.properties
static ReferenceList	getAvailableVirtualHosts() Gets available virtual hosts defined in the config.properties
static String	getBaseUrl() Deprecated. Use getBaseUrl(HttpServletRequest) instead
static String	getBaseUrl(javax.servlet.http.HttpServletRequest request) Return the url of the webapp, built from the request
static String	getPath(String strKey) Returns the absolute path of a repository from a relative definition in properties file
static String	getPath(String strKey, String strFilename) Returns the absolute path of file from its relative definition in properties file.
static String	getPortalUrl() Returns the portal page relative url (jsp/site/Portal.jsp) defined in lutece.properties
static String	getProdUrl() Deprecated. Use getProdUrl(String) instead
static String	getProdUrl(javax.servlet.http.HttpServletRequest request) Return the webapp prod url (or the base url if no prod url has been definied).
static String	getProdUrl(String strBaseUrl) Return the webapp prod url.
static FileInputStream	getResourceAsStream(String strPath, String strFilename) Gets a file as stream
static String	getRootForwardUrl() Returns the forward URL for webapp's root path.
static String	getSiteMessageUrl() Returns the Site Message relative url (jsp/site/SiteMessage.jsp) defined in lutece.properties
static String	getSiteMessageUrl(javax.servlet.http.HttpServletRequest request) Return the url of the webapp, built from the request
static String	getVirtualHostKey(javax.servlet.http.HttpServletRequest request) Gets a Virtual Host Key if the request contains a virtual host key
static String	getWebappInstance() Gets the webapp instance defined in the config.properties file with the key lutece.webapp.instance
static String	getWebAppPath() Returns the webapp path from the properties file
static void	init(javax.servlet.ServletContext context) Initialize The path service
static void	init(String strWebAppPath) Initialize The webapppath
static boolean	isDefaultWebappInstance() Returns whether the current instance is the default webapp instance
static UrlItem	resolveRedirectUrl(javax.servlet.http.HttpServletRequest request, String strDefaultRedirectUrl) Retrieve the url to redirect to after login.

Methods inherited from class java.lang.Object

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

Field Detail

SESSION_BASE_URL

public static final String SESSION_BASE_URL

See Also:

Constant Field Values

Method Detail

init

public static void init(javax.servlet.ServletContext context)

Initialize The path service

Parameters:

context - The servlet context

init

public static void init(String strWebAppPath)

Initialize The webapppath

Parameters:

strWebAppPath - The Webapp path

getPath

public static String getPath(String strKey)

Returns the absolute path of a repository from a relative definition in properties file

Parameters:

strKey - the repository key definied in properties file

Returns:

the repository absolute path

getWebAppPath

public static String getWebAppPath()

Returns the webapp path from the properties file

Returns:

the webapp path

getPath

public static String getPath(String strKey,
             String strFilename)

Returns the absolute path of file from its relative definition in properties file.

Parameters:

strKey - the repository key defined in properties file

strFilename - The name of file

Returns:

the absolute path of file

getResourceAsStream

public static FileInputStream getResourceAsStream(String strPath,
                                  String strFilename)

Gets a file as stream

Parameters:

strPath - the path

strFilename - The name of file

Returns:

a FileInput Stream object

getAbsolutePathFromRelativePath

public static String getAbsolutePathFromRelativePath(String strDirectory)

Returns the absolute path of a repository from a relative path

Parameters:

strDirectory - the relative path

Returns:

the repository absolute path

getBaseUrl

public static String getBaseUrl(javax.servlet.http.HttpServletRequest request)

Return the url of the webapp, built from the request

Parameters:

request - The HttpServletRequest

Returns:

strBase the webapp url

getBaseUrl

@Deprecated
public static String getBaseUrl()

Deprecated. Use getBaseUrl(HttpServletRequest) instead

Return the url of the webapp. The method should only be used out of request context (by daemons for example). If there is a request context, use getBaseUrl(HttpServletRequest) instead.

Returns:

The webapp url, or null if the 'lutece.base.url' property has not been set.

getProdUrl

public static String getProdUrl(javax.servlet.http.HttpServletRequest request)

Return the webapp prod url (or the base url if no prod url has been definied).

Parameters:

request - The HTTP request

Returns:

The prod url

getProdUrl

@Deprecated
public static String getProdUrl()

Deprecated. Use getProdUrl(String) instead

Return the webapp prod url (or the base url if no prod url has been definied)

Returns:

The prod url

getProdUrl

public static String getProdUrl(String strBaseUrl)

Return the webapp prod url. If no prod URL has been defined, then the base URL is returned

Parameters:

strBaseUrl - The base URL

Returns:

The prod url

getSiteMessageUrl

public static String getSiteMessageUrl(javax.servlet.http.HttpServletRequest request)

Return the url of the webapp, built from the request

Parameters:

request - The HttpServletRequest

Returns:

strBase the webapp url

getPortalUrl

public static String getPortalUrl()

Returns the portal page relative url (jsp/site/Portal.jsp) defined in lutece.properties

Returns:

the Portal Url

getRootForwardUrl

public static String getRootForwardUrl()

Returns the forward URL for webapp's root path. Default is (jsp/site/Portal.jsp) defined in lutece.properties

Returns:

the Portal Root forward Url

getSiteMessageUrl

public static String getSiteMessageUrl()

Returns the Site Message relative url (jsp/site/SiteMessage.jsp) defined in lutece.properties

Returns:

the SiteMessage Url

getAdminPortalUrl

public static String getAdminPortalUrl()

Returns the admin portal page relative url (jsp/admin/site/AdminSite.jsp) defined in lutece.properties

Returns:

the Portal Url

getAdminMenuUrl

public static String getAdminMenuUrl()

Returns the admin menu page relative url (jsp/admin/site/AdminMenu.jsp) defined in lutece.properties

Returns:

the Admin Menu Url

getAvailableVirtualHosts

public static ReferenceList getAvailableVirtualHosts()

Gets available virtual hosts defined in the config.properties

Returns:

A reference list containing the key and the description of each virtual host configuration. The list is empty if there is no configuration defined.

getVirtualHostKey

public static String getVirtualHostKey(javax.servlet.http.HttpServletRequest request)

Gets a Virtual Host Key if the request contains a virtual host key

Parameters:

request - The HTTP request

Returns:

A Virtual Host Key if present, otherwise null.

buildRedirectUrlItem

public static UrlItem buildRedirectUrlItem(String strRootUrl,
                           String strUrlPropertySuffixKey)

Build the url item to use for a url that includes the redirection parameter for reconnection.

Parameters:

strRootUrl - the root part of the url, to build an absolute url

strUrlPropertySuffixKey - The property suffix to retrieve the url

Returns:

an absolute url, completed with the redirectUrl parameter (contains the relative part of the url), as an UrlItem

resolveRedirectUrl

public static UrlItem resolveRedirectUrl(javax.servlet.http.HttpServletRequest request,
                         String strDefaultRedirectUrl)

Retrieve the url to redirect to after login. It is given by the redirectUrl parameter if found. The request parameters are copied (except the login and acces code). This is to be used by the doLogin method of AdminLoginJspBean.

Parameters:

request - the http request

strDefaultRedirectUrl - the default url to go to after login

Returns:

an UrlItem corresponding to the url to redirect to after login.

getAbsoluteUrl

public static String getAbsoluteUrl(javax.servlet.http.HttpServletRequest request,
                    String strUrl)

Returns the absolute url corresponding to the given one, if the later was found to be relative. An url starting with "http://" is absolute. A relative url should be given relatively to the webapp root.

Parameters:

request - the http request (provides the base path if needed)

strUrl - the url to transform

Returns:

the corresonding absolute url

getWebappInstance

public static String getWebappInstance()

Gets the webapp instance defined in the config.properties file with the key lutece.webapp.instance

Returns:

The instance name

Since:

4.1

isDefaultWebappInstance

public static boolean isDefaultWebappInstance()

Returns whether the current instance is the default webapp instance

Returns:

true if default, otherwise false