Package org.appng.api

Class RequestUtil

java.lang.Object

org.appng.api.RequestUtil

public class RequestUtil
extends Object

Utility-class for retrieving Sites by name,host or ServletRequest and also creating a Path -object based on a ServletRequest.

Author:

Matthias Müller

Method Summary

Modifier and Type	Method	Description
static PathInfo	getPathInfo(Environment env, Site site, String servletPath)	Creates and returns a PathInfo-object based upon the given parameters.
static Site	getSite(Environment env, javax.servlet.ServletRequest servletRequest)	Retrieves a Site by its name.
static Site	getSiteByName(Environment env, String name)	Retrieves a Site by its name.
static String	getSiteName(Environment env, javax.servlet.ServletRequest request)	Retrieves a Site's name for the given ServletRequest, using the given Environment to retrieve the VHostMode.
static Set<String>	getSiteNames(Environment env)	Returns an immutable Set containing all the Site names.
static Site	waitForSite(Environment env, String name)	Retrieves a Site by its name, waiting up to Platform.Property#MAX_WAIT_TIME milliseconds until it's state is SiteState#STARTED.

Methods inherited from class java.lang.Object

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

Method Detail

getSite

public static Site getSite(Environment env,
                           javax.servlet.ServletRequest servletRequest)

Retrieves a Site by its name.

Parameters:

env - the current Environment

servletRequest - the current ServletRequest

Returns:

the Site, if any

See Also:

getSiteName(Environment, ServletRequest)

getSiteByName

public static Site getSiteByName(Environment env,
                                 String name)

Retrieves a Site by its name.

Parameters:

env - the current Environment

name - the name of the Site

Returns:

the Site, if any

See Also:

Nameable.getName()

waitForSite

public static Site waitForSite(Environment env,
                               String name)

Retrieves a Site by its name, waiting up to Platform.Property#MAX_WAIT_TIME milliseconds until it's state is SiteState#STARTED.

Parameters:

env - the current Environment

name - the name of the Site

Returns:

the Site, if any

See Also:

getSiteByName(Environment, String), Site.hasState(SiteState...)

getSiteNames

public static Set<String> getSiteNames(Environment env)

Returns an immutable Set containing all the Site names.

Parameters:

env - the current Environment

Returns:

the Site names

getPathInfo

public static PathInfo getPathInfo(Environment env,
                                   Site site,
                                   String servletPath)

Creates and returns a PathInfo-object based upon the given parameters.

Parameters:

env - the current Environment

site - the current Site

servletPath - the current servlet-path

Returns:

a PathInfo-object

getSiteName

public static String getSiteName(Environment env,
                                 javax.servlet.ServletRequest request)

Retrieves a Site's name for the given ServletRequest, using the given Environment to retrieve the VHostMode.

Parameters:

env - an Environment

request - the ServletRequest

Returns:

• the IP-address, if VHostMode.IP_BASED is used (see ServletRequest.getLocalAddr())
• the value of the request-attribute "SERVER_LOCAL_NAME", if present.

  This header has to be added by the webserver of choice (usually Apache httpd), in case a Site needs to be accessible from a domain that is different from the one configured by Site.getDomain().

• the value of the request-header "X-appNG-site", if present.
• the server name, otherwise (see ServletRequest.getServerName())