lumis.portal.url
Interface IURLManager

All Known Implementing Classes:

URLManager

public interface IURLManager

Provides URL resolution and mapping management.

Since:

5.0.0

Nested Class Summary

static class

IURLManager.CreateStrategy Contains creation strategy options.

Field Summary

static String	FRIENDLY_URL_ENABLE_PROPERTY_NAME The name of the property that indicates where friendly URL is enabled.
static String	FRIENDLY_URL_PATTERN_PROPERTY_NAME The name of a default property that contains a pattern for the IURLResolver.
static String	URL_RESOLVER_PROPERTY_NAME The name of the property where the class name of the IURLResolver implementation is stored.
static String	WEBSITE_PROPERTY_NAME

Method Summary

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 htmlModifiedContent, 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.

Field Detail

URL_RESOLVER_PROPERTY_NAME

static final String URL_RESOLVER_PROPERTY_NAME

The name of the property where the class name of the IURLResolver implementation is stored.

Since:

5.0.0

See Also:

Constant Field Values

WEBSITE_PROPERTY_NAME

static final String WEBSITE_PROPERTY_NAME

See Also:

Constant Field Values

FRIENDLY_URL_ENABLE_PROPERTY_NAME

static final String FRIENDLY_URL_ENABLE_PROPERTY_NAME

The name of the property that indicates where friendly URL is enabled.

Since:

5.0.0

See Also:

Constant Field Values

FRIENDLY_URL_PATTERN_PROPERTY_NAME

static final String FRIENDLY_URL_PATTERN_PROPERTY_NAME

The name of a default property that contains a pattern for the IURLResolver.

Since:

5.0.0

See Also:

Constant Field Values

Method Detail

getWebResourceByDynamicPath

WebResource getWebResourceByDynamicPath(String dynamicPath,
                                        IURLManager.CreateStrategy createStrategy)
                                        throws PortalException

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:

• NEVER: throws PortalObjectNotFoundException.
• TRANSIENT: creates and returns a transient web resource.
• AUTO: if the web resource does not have friendly path or cache, behaves as TRANSIENT, otherwise also persists the web resource.

This method uses its own transactions.

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.

IllegalArgumentException - if the specified dynamic path could not be resolved into a web resource.

PortalException

Since:

5.0.0

getWebResourceByDynamicPath

WebResource getWebResourceByDynamicPath(String dynamicPath,
                                        IURLManager.CreateStrategy createStrategy,
                                        Locale locale)
                                        throws PortalException

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:

• NEVER: throws PortalObjectNotFoundException.
• TRANSIENT: creates and returns a transient web resource.
• AUTO: if the web resource does not have friendly path or cache, behaves as TRANSIENT, otherwise also persists the web resource.

This method uses its own transactions.

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.

IllegalArgumentException - if the specified dynamic path could not be resolved into a web resource.

PortalException

Since:

5.0.0

processHTMLDynamicPathReferences

String processHTMLDynamicPathReferences(String html)
                                        throws PortalException

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.

Parameters:

html - the HTML code.

Returns:

the HTML code, with the references replaced.

Throws:

PortalException

Since:

5.0.0

convertHTMLPathsToDynamicPaths

String convertHTMLPathsToDynamicPaths(String html)
                                      throws PortalException

Replaces, in an HTML code, paths to web resources by the corresponding dynamic path.

Parameters:

htmlContent - the HTML code.

Returns:

the converted HTML code.

Throws:

PortalException

Since:

5.0.0

processHTMLDynamicPathReferences

String processHTMLDynamicPathReferences(String htmlModifiedContent,
                                        Locale locale,
                                        boolean convertGuestOnlyCaches)
                                        throws PortalException

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.

Parameters:

htmlContent - the HTML code.

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

Since:

5.0.0

setWebResourcesMissingData

void setWebResourcesMissingData(IWebResourceFactory webResourceFactory,
                                Collection<WebResource> webResources,
                                boolean cacheEnabled,
                                boolean friendlyURLEnabled)
                                throws PortalException

Sets missing data in the given web resources.

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

Since:

5.0.0

fixReferencesAccordingToPath

String fixReferencesAccordingToPath(String html,
                                    String path)
                                    throws PortalException

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.

Parameters:

html - the HTML content to be fixed.

path - the path.

Returns:

the original HTML with adjusted references.

Throws:

PortalException

Since:

5.0.0