lumis.portal.url
Class URLManager

Package class diagram package URLManager
java.lang.Object
  extended by lumis.portal.url.URLManager
All Implemented Interfaces:
IURLManager

public class URLManager
extends Object
implements IURLManager

IURLManager implementation.

Since:
5.0.0

Nested Class Summary
 
Nested classes/interfaces inherited from interface lumis.portal.url.IURLManager
IURLManager.CreateStrategy
 
Field Summary
 
Fields inherited from interface lumis.portal.url.IURLManager
FRIENDLY_URL_ENABLE_PROPERTY_NAME, FRIENDLY_URL_PATTERN_PROPERTY_NAME, URL_RESOLVER_PROPERTY_NAME, WEBSITE_PROPERTY_NAME
 
Constructor Summary
URLManager()
           
 
Method Summary
 void clearPageCacheReference(WebResource webResource)
          Clears the page cache reference in a web resource.
 String convertHTMLPathsToDynamicPaths(String html)
          Replaces, in an HTML code, paths to web resources by the corresponding dynamic path.
 String fixReferencesAccordingToPath(String html, String path)
          Fixes references within an HTML according to the given path.
 WebResource getWebResourceByDynamicPath(String dynamicPath, IURLManager.CreateStrategy createStrategy)
          Returns a web resource for the given dynamic path.
 WebResource getWebResourceByDynamicPath(String dynamicPath, IURLManager.CreateStrategy createStrategy, Locale locale)
          Returns a web resource for the given dynamic path.
 String processHTMLDynamicPathReferences(String html)
          Processes references to dynamic paths in a given HTML code.
 String processHTMLDynamicPathReferences(String htmlContent, Locale locale, boolean convertGuestOnlyCaches)
          Processes references to dynamic paths in a given HTML code.
 void setWebResourcesMissingData(IWebResourceFactory webResourceFactory, Collection<WebResource> webResources, boolean cacheEnabled, boolean friendlyURLEnabled)
          Sets missing data in the given web resources.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

URLManager

public URLManager()
Method Detail

getWebResourceByDynamicPath

public WebResource getWebResourceByDynamicPath(String dynamicPath,
                                               IURLManager.CreateStrategy createStrategy)
                                        throws PortalException
Description copied from interface: IURLManager
Returns a web resource for the given dynamic path.

If the corresponding web resource already exists in the persistence, that instance is returned. Otherwise, createStrategy defines the behavior:

This method uses its own transactions.

Specified by:
getWebResourceByDynamicPath in interface IURLManager
Parameters:
dynamicPath - the dynamic path.
createStrategy - the strategy used if no web resource exists in persistence for the given dynamic path.
Returns:
the web resource.
Throws:
PortalObjectNotFoundException - if no web resource for the given dynamic path exists, and createStrategy is NEVER.
PortalException

getWebResourceByDynamicPath

public WebResource getWebResourceByDynamicPath(String dynamicPath,
                                               IURLManager.CreateStrategy createStrategy,
                                               Locale locale)
                                        throws PortalException
Description copied from interface: IURLManager
Returns a web resource for the given dynamic path.

If the corresponding web resource already exists in the persistence, that instance is returned. Otherwise, createStrategy defines the behavior:

This method uses its own transactions.

Specified by:
getWebResourceByDynamicPath in interface IURLManager
Parameters:
dynamicPath - the dynamic path.
createStrategy - the strategy used if no web resource exists in persistence for the given dynamic path.
locale - the web resource's locale.
Returns:
the web resource.
Throws:
PortalObjectNotFoundException - if no web resource for the given dynamic path exists, and createStrategy is NEVER.
PortalException

convertHTMLPathsToDynamicPaths

public String convertHTMLPathsToDynamicPaths(String html)
                                      throws PortalException
Description copied from interface: IURLManager
Replaces, in an HTML code, paths to web resources by the corresponding dynamic path.

Specified by:
convertHTMLPathsToDynamicPaths in interface IURLManager
Returns:
the converted HTML code.
Throws:
PortalException

processHTMLDynamicPathReferences

public String processHTMLDynamicPathReferences(String html)
                                        throws PortalException
Description copied from interface: IURLManager
Processes references to dynamic paths in a given HTML code. Generates and persists corresponding web resources information, if necessary, and replaces the dynamic paths by the proper web resource paths.

Specified by:
processHTMLDynamicPathReferences in interface IURLManager
Parameters:
html - the HTML code.
Returns:
the HTML code, with the references replaced.
Throws:
PortalException

processHTMLDynamicPathReferences

public String processHTMLDynamicPathReferences(String htmlContent,
                                               Locale locale,
                                               boolean convertGuestOnlyCaches)
                                        throws PortalException
Description copied from interface: IURLManager
Processes references to dynamic paths in a given HTML code. Generates and persists corresponding web resources information, if necessary, and replaces the dynamic paths by the proper web resource paths.

Specified by:
processHTMLDynamicPathReferences in interface IURLManager
locale - the locale.
convertGuestOnlyCaches - if true, pages with cache enabled only for guest will also have their dynamic paths converted.
Returns:
the HTML code, with the references replaced.
Throws:
PortalException

setWebResourcesMissingData

public void setWebResourcesMissingData(IWebResourceFactory webResourceFactory,
                                       Collection<WebResource> webResources,
                                       boolean cacheEnabled,
                                       boolean friendlyURLEnabled)
                                throws PortalException
Description copied from interface: IURLManager
Sets missing data in the given web resources.

Specified by:
setWebResourcesMissingData in interface IURLManager
Parameters:
webResourceFactory - the web resource factory of the given web resources.
webResources - the web resources.
cacheEnabled - indicates that cache is enabled.
friendlyURLEnabled - indicates that friendly URL is enabled.
Throws:
PortalException

fixReferencesAccordingToPath

public String fixReferencesAccordingToPath(String html,
                                           String path)
                                    throws PortalException
Description copied from interface: IURLManager
Fixes references within an HTML according to the given path.

The HTML passed in to this method should be appropriate for the context root of the solution. This method changes path references in the HTML such that the references are relative to the specified path. The path must begin with the "/" character and be relative to the web application root.

Specified by:
fixReferencesAccordingToPath in interface IURLManager
Parameters:
html - the HTML content to be fixed.
path - the path.
Returns:
the original HTML with adjusted references.
Throws:
PortalException

clearPageCacheReference

public void clearPageCacheReference(WebResource webResource)
Clears the page cache reference in a web resource.

Parameters:
webResource - the web resource.
Since:
5.0.0
See Also:
WebResource.pageCache


Lumisportal  5.5.0.091130 - Copyright © 2001-2007, Lumis. All Rights Reserved.