com.neurosys.content.service

Class DefaultContentPathConstructor

java.lang.Object

com.neurosys.content.service.DefaultContentPathConstructor

All Implemented Interfaces:

ContentPathConstructor, IPageParams

public class DefaultContentPathConstructor
extends Object
implements ContentPathConstructor

Default implementation for ContentPathConstructor

Author:

Arjun Dhar

See Also:

pageNameConstruct(Template, PageIdentifier, boolean)

Field Summary

Fields

Modifier and Type	Field and Description
static Map<String,String>	aliasMap Map of the alias path to the ContentNameId
static String	CLEAN_VARIABLES_PATH_PARAMS_REGEX If there are variables defined in a URL in the format /abc/$[a.b.c]/oo%45 o123&/$[zzzz.zzzzz] Then this will help eliminate the Path param pairs with variables including any leading "/" from the String
static String	CLEAN_VARIABLES_QUERY_PARAMS_REGEX If there are variables defined in a URL in the format param1=abc¶m2=$[a.b.c]¶m3=oo%45 o123¶m4=$[zzzz.zzzzz] Then this will help eliminate the Query param pairs with variables including any leading "&" from the String
static String	CONTENT_PATH_PARAMS A String of Path params (prefixed to the last path location) Example: /a/b/c.html + PATH_PARAMS = "d/e ~~~~~~ results in ~~~~~> /a/b/d/e/c.html represent the value of this parameter.
static String	CONTENT_QUERY_PARAMS A String of Query params represent the value of this parameter.
static String	PREVIEW_BASE_URL A String or a Transformer that accepts PageIdentifier to generate a URL

Fields inherited from interface com.neurosys.module.model.IPageParams

ALL_RECS, CAMPAIGN_ID, LANG, PAGE_ID, PAGE_MODE_MOBILE, PAGE_MODE_POPUP, PAGE_NAME, PAGE_NUM, PAGE_PARAM, PAGE_PARENT, PAGE_PARENT_ID, PAGE_REFERRER, PAGE_TYPE, PREVIEW

Constructor Summary

Constructors

Constructor and Description
DefaultContentPathConstructor()

Method Summary

Modifier and Type	Method and Description
String	decodeUrlSafeName(String name) Transform the safe url-name back to original.
String	encodeUrlSafeName(String name) Transform the intended name to a URL safe name; converting special characters etc The transformation should be reversible.
String	filterActualPageName(String rawName) The page name is constructed using this#pageNameConstruct(PageIdentifier, boolean).
protected String	getExtension() AppSettings.get().APPLICATION_EXTENSION depends on a Wicket Request Cycle. A lot of Feeds may needs URL generation also, so cannot depend on Request cycle; directly use appConfiguration."site.ext"
String	getPageName(PageIdentifier page) For Override
String	getPageNameFromURL(String url) The page name is constructed using this#pageNameConstruct(PageIdentifier, boolean).
String	pageNameConstruct(Template associatedTemplate, PageIdentifier page) Get mount path location/name
String	pageNameConstruct(Template associatedTemplate, PageIdentifier page, boolean preview) Get mount path location/name Paths constructed here should be compatible with MountPathReLoader#getStaus(java.util.Map) This method accepts the following constants from Template.getAttributes() PREVIEW_BASE_URL CONTENT_QUERY_PARAMS CONTENT_PATH_PARAMS CLEAN_VARIABLES_PATH_PARAMS_REGEX CLEAN_VARIABLES_QUERY_PARAMS_REGEX
protected String	replaceVariables(PageIdentifier page, String paramTemplateString) Replaces the variables in the String tempalte ($[var name]) by the values.
void	setPageNameForURL(String url, String name) Allow the ability to tell the path constructor a name of Page/content for a given relative URL

Methods inherited from class java.lang.Object

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

Field Detail

PREVIEW_BASE_URL

public static final String PREVIEW_BASE_URL

A String or a Transformer that accepts PageIdentifier to generate a URL

See Also:

Constant Field Values

CLEAN_VARIABLES_QUERY_PARAMS_REGEX

public static final String CLEAN_VARIABLES_QUERY_PARAMS_REGEX

If there are variables defined in a URL in the format param1=abc¶m2=$[a.b.c]¶m3=oo%45 o123¶m4=$[zzzz.zzzzz]
Then this will help eliminate the Query param pairs with variables including any leading "&" from the String

See Also:

Constant Field Values

CLEAN_VARIABLES_PATH_PARAMS_REGEX

public static final String CLEAN_VARIABLES_PATH_PARAMS_REGEX

If there are variables defined in a URL in the format /abc/$[a.b.c]/oo%45 o123&/$[zzzz.zzzzz]
Then this will help eliminate the Path param pairs with variables including any leading "/" from the String

See Also:

Constant Field Values

CONTENT_QUERY_PARAMS

public static final String CONTENT_QUERY_PARAMS

A String of Query params represent the value of this parameter. The String can contain the following :

• $[content.name] = PageIdentifier.getName()
• $[locale.country] = PageIdentifier#getLocale().country
• $locale.language] = PageIdentifier#getLocale().language
• $[locale.ISO3Country] = PageIdentifier#getLocale().ISO3Country
• $[locale.ISO3Language] = PageIdentifier#getLocale().ISO3Language
• ... and any PageIdentifier.getAttributeNames()

Note: names and attributes are encoded using encodeUrlSafeName(String)

See Also:

Constant Field Values

CONTENT_PATH_PARAMS

public static final String CONTENT_PATH_PARAMS

A String of Path params (prefixed to the last path location)
Example: /a/b/c.html + PATH_PARAMS = "d/e ~~~~~~ results in ~~~~~> /a/b/d/e/c.html represent the value of this parameter. The String can contain the following :

• $[content.name] = PageIdentifier.getName()
• $[locale.country] = PageIdentifier#getLocale().country
• $locale.language] = PageIdentifier#getLocale().language
• $[locale.ISO3Country] = PageIdentifier#getLocale().ISO3Country
• $[locale.ISO3Language] = PageIdentifier#getLocale().ISO3Language
• ... and any PageIdentifier.getAttributeNames()

Note: names and attributes are encoded using encodeUrlSafeName(String)

See Also:

Constant Field Values

aliasMap

public static final Map<String,String> aliasMap

Map of the alias path to the ContentNameId

Constructor Detail

DefaultContentPathConstructor

public DefaultContentPathConstructor()

Method Detail

getExtension

protected String getExtension()

AppSettings.get().APPLICATION_EXTENSION depends on a Wicket Request Cycle.
A lot of Feeds may needs URL generation also, so cannot depend on Request cycle; directly use appConfiguration."site.ext"

Returns:

String

pageNameConstruct

public final String pageNameConstruct(Template associatedTemplate,
                                      PageIdentifier page)

Get mount path location/name

Specified by:

pageNameConstruct in interface ContentPathConstructor

Parameters:

page -

Returns:

replaceVariables

protected String replaceVariables(PageIdentifier page,
                                  String paramTemplateString)

Replaces the variables in the String tempalte ($[var name]) by the values.

Parameters:

page -

paramTemplateString -

Returns:

getPageName

public String getPageName(PageIdentifier page)

For Override

Specified by:

getPageName in interface ContentPathConstructor

Parameters:

page - as PageIdentifier

Returns:

String as page name for URL

Default value:

PageIdentifier.getName()

pageNameConstruct

public final String pageNameConstruct(Template associatedTemplate,
                                      PageIdentifier page,
                                      boolean preview)

Get mount path location/name
Paths constructed here should be compatible with MountPathReLoader#getStaus(java.util.Map)
This method accepts the following constants from Template.getAttributes()

• PREVIEW_BASE_URL
• CONTENT_QUERY_PARAMS
• CONTENT_PATH_PARAMS
• CLEAN_VARIABLES_PATH_PARAMS_REGEX
• CLEAN_VARIABLES_QUERY_PARAMS_REGEX

Specified by:

pageNameConstruct in interface ContentPathConstructor

Parameters:

page -

preview - (true means Status.DRAFT else Status.PUBLISH

Returns:

encodeUrlSafeName

public String encodeUrlSafeName(String name)

Description copied from interface: ContentPathConstructor

Transform the intended name to a URL safe name; converting special characters etc
The transformation should be reversible. See #getNameFromSafeUrl(String)
Note: This only concerns the name not the full path

Specified by:

encodeUrlSafeName in interface ContentPathConstructor

Returns:

as String

decodeUrlSafeName

public String decodeUrlSafeName(String name)

Description copied from interface: ContentPathConstructor

Transform the safe url-name back to original. See ContentPathConstructor.encodeUrlSafeName(String)
Note: This only concerns the name not the full path

Specified by:

decodeUrlSafeName in interface ContentPathConstructor

Returns:

getPageNameFromURL

public String getPageNameFromURL(String url)

The page name is constructed using this#pageNameConstruct(PageIdentifier, boolean). This can introduce some conventions. Filter them to extract the actual name if required.

Specified by:

getPageNameFromURL in interface ContentPathConstructor

Parameters:

url - as String

Returns:

String

setPageNameForURL

public void setPageNameForURL(String url,
                              String name)

Description copied from interface: ContentPathConstructor

Allow the ability to tell the path constructor a name of Page/content for a given relative URL

Specified by:

setPageNameForURL in interface ContentPathConstructor

filterActualPageName

public final String filterActualPageName(String rawName)

The page name is constructed using this#pageNameConstruct(PageIdentifier, boolean). This can introduce some conventions. Filter them to extract the actual name if required.

Specified by:

filterActualPageName in interface ContentPathConstructor

Returns:

String