org.jahia.services.render

Class URLResolver

java.lang.Object

org.jahia.services.render.URLResolver

public class URLResolver
extends Object

Class to resolve URLs and URL paths, so that the workspace / locale / node-path information is returned. There are also convenience methods to directly return the Node or Resource where the URL points to. The method also considers vanity URL mappings and resolves them to the mapped nodes, so that the URL resolver will return the info as if no mapping have been used.

Author:

Benjamin Papez

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	URLResolver(String url, RenderContext context, net.sf.ehcache.Ehcache nodePathCache, net.sf.ehcache.Ehcache siteInfoCache) Initializes an instance of this class.
protected	URLResolver(String urlPathInfo, String serverName, javax.servlet.http.HttpServletRequest request, net.sf.ehcache.Ehcache nodePathCache, net.sf.ehcache.Ehcache siteInfoCache)
protected	URLResolver(String pathInfo, String serverName, String workspace, javax.servlet.http.HttpServletRequest request, net.sf.ehcache.Ehcache nodePathCache, net.sf.ehcache.Ehcache siteInfoCache) Initializes an instance of this class.

Method Summary

Modifier and Type	Method and Description
Locale	getLocale() Gets the locale of the request resolved by the URL
JCRNodeWrapper	getNode() Creates a node from the path in the URL.
String	getPath() Gets the content node path of the request resolved by the URL
String	getRedirectUrl() If value is not null, then URL resolving encountered that the URL has permanently been changed and thus a server-side redirect to the new location should be triggered.
Resource	getResource() Creates a resource from the path in the URL.
Resource	getResource(String path)
String	getServletPart()
SiteInfo	getSiteInfo()
String	getSiteKey() Gets the site-key of the request resolved by the URL
String	getSiteKeyByServerName()
String	getUrlPathInfo() Gets the pathInfo of the given URL (@link javax.servlet.http.HttpServletRequest.getPathInfo())
String	getVanityUrl()
Date	getVersionDate()
String	getVersionLabel()
String	getWorkspace() Gets the workspace of the request resolved by the URL
boolean	isMappable() Checks whether the URL points to a Jahia content object, which can be mapped to vanity URLs.
boolean	isMapped() Checks whether the URL points to a Jahia content object, which can be mapped to vanity URLs.
protected JCRNodeWrapper	resolveNode(String workspace, Locale locale, String path) Creates a node from the specified path.
protected Resource	resolveResource(String workspace, Locale locale, String path) Creates a resource from the specified path.
protected boolean	resolveUrlMapping(String serverName, javax.servlet.http.HttpServletRequest request)
void	setRedirectUrl(String redirectUrl) Set the URL location for a redirection suggestion.
void	setRenderContext(RenderContext renderContext)
void	setSiteKey(String siteKey) Sets the site-key resolved for the current URL
void	setVanityUrl(String vanityUrl)
void	setVersionDate(Date versionDate)
void	setVersionLabel(String versionLabel)
protected Locale	verifyLanguage(String lang)
protected String	verifyWorkspace(String workspace)

Methods inherited from class java.lang.Object

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

Constructor Detail

URLResolver

protected URLResolver(String urlPathInfo,
                      String serverName,
                      javax.servlet.http.HttpServletRequest request,
                      net.sf.ehcache.Ehcache nodePathCache,
                      net.sf.ehcache.Ehcache siteInfoCache)

URLResolver

protected URLResolver(String pathInfo,
                      String serverName,
                      String workspace,
                      javax.servlet.http.HttpServletRequest request,
                      net.sf.ehcache.Ehcache nodePathCache,
                      net.sf.ehcache.Ehcache siteInfoCache)

Initializes an instance of this class. This constructor is mainly used when resolving URLs of incoming requests.

Parameters:

pathInfo - the path info (usually obtained with @link javax.servlet.http.HttpServletRequest.getPathInfo())

serverName - the server name (usually obtained with @link javax.servlet.http.HttpServletRequest.getServerName())

request - the current HTTP servlet request object

URLResolver

protected URLResolver(String url,
                      RenderContext context,
                      net.sf.ehcache.Ehcache nodePathCache,
                      net.sf.ehcache.Ehcache siteInfoCache)

Initializes an instance of this class. This constructor is mainly used when trying to find mapping for URLs in outgoing requests.

Parameters:

url - URL in HTML links of outgoing requests

context - The current request in order to obtain the context path

Method Detail

setRenderContext

public void setRenderContext(RenderContext renderContext)

resolveUrlMapping

protected boolean resolveUrlMapping(String serverName,
                                    javax.servlet.http.HttpServletRequest request)

getUrlPathInfo

public String getUrlPathInfo()

Gets the pathInfo of the given URL (@link javax.servlet.http.HttpServletRequest.getPathInfo())

Returns:

the pathInfo of the given URL

getServletPart

public String getServletPart()

getWorkspace

public String getWorkspace()

Gets the workspace of the request resolved by the URL

Returns:

the workspace of the given URL

getLocale

public Locale getLocale()

Gets the locale of the request resolved by the URL

Returns:

the locale of the given URL

getPath

public String getPath()

Gets the content node path of the request resolved by the URL

Returns:

the content node path of the given URL

getNode

public JCRNodeWrapper getNode()
                       throws javax.jcr.RepositoryException

Creates a node from the path in the URL.

Returns:

The node, if found

Throws:

javax.jcr.PathNotFoundException - if the resource cannot be resolved

javax.jcr.RepositoryException - in case of JCR-related errors

getResource

public Resource getResource()
                     throws javax.jcr.RepositoryException

Creates a resource from the path in the URL.

The path should looks like : [nodepath][.templatename].[templatetype] or [nodepath].[templatetype] Workspace, locale and path are taken from the given resolved URL.

Returns:

The resource, if found

Throws:

javax.jcr.PathNotFoundException - if the resource cannot be resolved

javax.jcr.RepositoryException - in case of JCR-related errors

getResource

public Resource getResource(String path)
                     throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

resolveNode

protected JCRNodeWrapper resolveNode(String workspace,
                                     Locale locale,
                                     String path)
                              throws javax.jcr.RepositoryException

Creates a node from the specified path.

The path should looks like : [nodepath][.templatename].[templatetype] or [nodepath].[templatetype]

Parameters:

workspace - The workspace where to get the node

locale - current locale

path - The path of the node, in the specified workspace

Returns:

The node, if found

Throws:

javax.jcr.PathNotFoundException - if the resource cannot be resolved

javax.jcr.RepositoryException - in case of JCR-related errors

resolveResource

protected Resource resolveResource(String workspace,
                                   Locale locale,
                                   String path)
                            throws javax.jcr.RepositoryException

Creates a resource from the specified path.

The path should looks like : [nodepath][.templatename].[templatetype] or [nodepath].[templatetype]

Parameters:

workspace - The workspace where to get the node

locale - current locale

path - The path of the node, in the specified workspace

Returns:

The resource, if found

Throws:

javax.jcr.PathNotFoundException - if the resource cannot be resolved

javax.jcr.RepositoryException - in case of JCR-related errors

isMappable

public boolean isMappable()

Checks whether the URL points to a Jahia content object, which can be mapped to vanity URLs.

Returns:

true if current node can be mapped to vanity URLs, otherwise false

isMapped

public boolean isMapped()

Checks whether the URL points to a Jahia content object, which can be mapped to vanity URLs. If this is the case then also check if there already is a mapping for the current node.

Returns:

true if mappings exist(ed) for the current node, otherwise false

getSiteKey

public String getSiteKey()

Gets the site-key of the request resolved by the URL

Returns:

the site-key of the given URL

setSiteKey

public void setSiteKey(String siteKey)

Sets the site-key resolved for the current URL

Parameters:

siteKey - the site-key resolved for the current URL

getSiteKeyByServerName

public String getSiteKeyByServerName()

getRedirectUrl

public String getRedirectUrl()

If value is not null, then URL resolving encountered that the URL has permanently been changed and thus a server-side redirect to the new location should be triggered.

Returns:

URL for the new location

setRedirectUrl

public void setRedirectUrl(String redirectUrl)

Set the URL location for a redirection suggestion.

Parameters:

redirectUrl - suggested vanity URL to redirect to

getVanityUrl

public String getVanityUrl()

setVanityUrl

public void setVanityUrl(String vanityUrl)

verifyLanguage

protected Locale verifyLanguage(String lang)

verifyWorkspace

protected String verifyWorkspace(String workspace)

setVersionDate

public void setVersionDate(Date versionDate)

setVersionLabel

public void setVersionLabel(String versionLabel)

getVersionDate

public Date getVersionDate()

getVersionLabel

public String getVersionLabel()

getSiteInfo

public SiteInfo getSiteInfo()