com.endeca.soleng.urlformatter.combined

Class CombinedUrlFormatter

java.lang.Object

com.endeca.soleng.urlformatter.combined.CombinedUrlFormatter

All Implemented Interfaces:

UrlFormatter

public class CombinedUrlFormatter
extends Object
implements UrlFormatter

An UrlFormatter that formats either traditional or SEO optimized URL, based on the URL pattern. instances of this class are not reentrant -- and they must be instantiated separately for each incoming request (i.e. they must be request-scoped, not session or global scope).

Property Summary
Property	Type	Default Value
basicUrlFormatter	UrlFormatter	null
seoUrlPatterns	SeoUrlPatterns	null
seoUrlFormatter	UrlFormatter	null

Constructor Summary

Constructors

Constructor and Description
CombinedUrlFormatter()

Method Summary

Modifier and Type	Method and Description
AggrERecUrlParam	createAggrERecUrlParam(UrlState pUrlState, com.endeca.navigation.AggrERec pAggrERec) Creates an URL parameter containing an AggrERec.
ERecUrlParam	createERecUrlParam(UrlState pUrlState, com.endeca.navigation.ERec pERec) Creates an URL parameter containing an ERec.
NavStateUrlParam	createNavStateUrlParam(UrlState pUrlState) Creates an URL parameter containing an empty NavState.
UrlParam	createUrlParam(UrlState pUrlState, String pKey, String pValue) Creates an URL parameter for the specified UrlState.
String	formatCanonicalUrl(UrlState pUrlState) Formats a canonical url.
String	formatSeoUrl(UrlState pUrlState)
String	formatUrl(UrlState pUrlState) Formats the specified UrlState into an URL string.
String	getAggrERecParamKey() The parameter key used for aggregate record detail links - typically "A".
UrlFormatter	getBasicUrlFormatter()
String	getDefaultEncoding() Returns the default character encoding that should be used when transforming URLs to and from various string forms.
String	getERecParamKey() The parameter key used for record detail links - typically "R".
String	getNavStateParamKey() The parameter key used for navigation state - typically "N".
UrlFormatter	getSeoUrlFormatter()
SeoUrlPatterns	getSeoUrlPatterns()
UrlFormatter	getUrlFormatterInAction()
boolean	isSeoUrl(String pPathInfo) Determine if an inbound URL should be treated as an SEO URL.
UrlState	parseRequest(javax.servlet.http.HttpServletRequest pRequest) Parses the specified request into an UrlState.
UrlState	parseRequest(String pQueryString, String pPathInfo, String pCharacterEncoding)
UrlState	parseRequest(String pQueryString, String pPathInfo, String pCharacterEncoding, Boolean useSeoUrlFormatter)
void	setBasicUrlFormatter(UrlFormatter pBasicUrlFormatter) Specifies the UrlFormatter for handling traditional Endeca URL.
void	setSeoUrlFormatter(UrlFormatter pSeoUrlFormatter) Specifies the UrlFormatter for handling SEO optimized URL.
void	setSeoUrlPatterns(SeoUrlPatterns pSeoUrlPatterns) Register SEO URL patterns.

Methods inherited from class java.lang.Object

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

Constructor Detail

CombinedUrlFormatter

public CombinedUrlFormatter()

Method Detail

getSeoUrlPatterns

public SeoUrlPatterns getSeoUrlPatterns()

Returns:

the registered SEO URL patterns.

setSeoUrlPatterns

public void setSeoUrlPatterns(SeoUrlPatterns pSeoUrlPatterns)

Register SEO URL patterns. Inbound URLs with any of these patterns will be treated as SEO optimized URLs, while the rest will be treated as traditional Endeca URLs. For example, given pattern "/assembler/pages(/.*)?", URLs like "/assembler/pages" and "/assembler/pages/foo/bar" will be treated as SEO URLs, while "assembler", "/assembler/pagesss" and "/search" will be treated as traditional Endeca URLs.

Parameters:

pSeoUrlPatterns - the URL patterns for SEO URLs.

isSeoUrl

public boolean isSeoUrl(String pPathInfo)

Determine if an inbound URL should be treated as an SEO URL.

Returns:

TRUE if the inbound URL should be treated as an SEO URL.

getBasicUrlFormatter

public UrlFormatter getBasicUrlFormatter()

Returns:

the UrlFormatter for handling traditional Endeca URL.

setBasicUrlFormatter

public void setBasicUrlFormatter(UrlFormatter pBasicUrlFormatter)

Specifies the UrlFormatter for handling traditional Endeca URL.

Parameters:

pBasicUrlFormatter - the UrlFormatter class for handling traditional Endeca URL.

getSeoUrlFormatter

public UrlFormatter getSeoUrlFormatter()

Returns:

the UrlFormatter for handling SEO optimized URL.

setSeoUrlFormatter

public void setSeoUrlFormatter(UrlFormatter pSeoUrlFormatter)

Specifies the UrlFormatter for handling SEO optimized URL.

Parameters:

pSeoUrlFormatter - the UrlFormatter class for handling SEO optimized URL.

getUrlFormatterInAction

public UrlFormatter getUrlFormatterInAction()

Returns:

the UrlFormatter used for handling the current URL.

parseRequest

public UrlState parseRequest(javax.servlet.http.HttpServletRequest pRequest)
                      throws UrlFormatException

Description copied from interface: UrlFormatter

Parses the specified request into an UrlState.

Specified by:

parseRequest in interface UrlFormatter

Parameters:

pRequest - the request to parse.

Throws:

UrlFormatException - if the request cannot be parsed.

parseRequest

public UrlState parseRequest(String pQueryString,
                             String pPathInfo,
                             String pCharacterEncoding)
                      throws UrlFormatException

Specified by:

parseRequest in interface UrlFormatter

Throws:

UrlFormatException

parseRequest

public UrlState parseRequest(String pQueryString,
                             String pPathInfo,
                             String pCharacterEncoding,
                             Boolean useSeoUrlFormatter)
                      throws UrlFormatException

Throws:

UrlFormatException

formatUrl

public String formatUrl(UrlState pUrlState)
                 throws UrlFormatException

Description copied from interface: UrlFormatter

Formats the specified UrlState into an URL string.

Specified by:

formatUrl in interface UrlFormatter

Parameters:

pUrlState - the UrlState to format.

Throws:

UrlFormatException - if the UrlState cannot be formatted.

formatSeoUrl

public String formatSeoUrl(UrlState pUrlState)
                    throws UrlFormatException

Returns:

SEO URL.

Throws:

UrlFormatException

formatCanonicalUrl

public String formatCanonicalUrl(UrlState pUrlState)
                          throws UrlFormatException

Description copied from interface: UrlFormatter

Formats a canonical url. Same functionality as the UrlFormatter#formatUrl method, but ensures canonicalizers associated with the formatter are not disabled, to ensure the url given is consistent.

Specified by:

formatCanonicalUrl in interface UrlFormatter

Parameters:

pUrlState - The URL State to use to format the URL.

Returns:

The String representation of the URL State, formatted.

Throws:

UrlFormatException - Throws formatting exception.

getDefaultEncoding

public String getDefaultEncoding()

Description copied from interface: UrlFormatter

Returns the default character encoding that should be used when transforming URLs to and from various string forms. This value is overridden by any character encoding specified explicitly when constructing an UrlState.

Specified by:

getDefaultEncoding in interface UrlFormatter

Returns:

the default encoding for this URL formatter.

See Also:

UrlState.UrlState(UrlFormatter,String)

createUrlParam

public UrlParam createUrlParam(UrlState pUrlState,
                               String pKey,
                               String pValue)

Description copied from interface: UrlFormatter

Creates an URL parameter for the specified UrlState. This is an internal method used by an UrlState. You shouldn't need to use this method unless you are implementing a custom UrlFormatter.

Specified by:

createUrlParam in interface UrlFormatter

Parameters:

pUrlState - the UrlState that will contain the parameter.

pKey - the parameter key.

pValue - the parameter string value (fully decoded).

Returns:

the newly created URL parameter.

createERecUrlParam

public ERecUrlParam createERecUrlParam(UrlState pUrlState,
                                       com.endeca.navigation.ERec pERec)

Description copied from interface: UrlFormatter

Creates an URL parameter containing an ERec. This is an internal method used by an UrlState. You shouldn't need to use this method unless you are implementing a custom UrlFormatter.

Specified by:

createERecUrlParam in interface UrlFormatter

Parameters:

pUrlState - the UrlState that will contain the parameter.

pERec - the ERec to be contained in the UrlState.

Returns:

the newly created URL parameter.

See Also:

UrlFormatter.getERecParamKey()

createAggrERecUrlParam

public AggrERecUrlParam createAggrERecUrlParam(UrlState pUrlState,
                                               com.endeca.navigation.AggrERec pAggrERec)

Description copied from interface: UrlFormatter

Creates an URL parameter containing an AggrERec. This is an internal method used by an UrlState. You shouldn't need to use this method unless you are implementing a custom UrlFormatter.

Specified by:

createAggrERecUrlParam in interface UrlFormatter

Parameters:

pUrlState - the UrlState that will contain the parameter.

pAggrERec - the AggrERec to be contained in the UrlState.

Returns:

the newly created URL parameter.

See Also:

UrlFormatter.getAggrERecParamKey()

createNavStateUrlParam

public NavStateUrlParam createNavStateUrlParam(UrlState pUrlState)

Description copied from interface: UrlFormatter

Creates an URL parameter containing an empty NavState. This is an internal method used by an UrlState. You shouldn't need to use this method unless you are implementing a custom UrlFormatter.

Specified by:

createNavStateUrlParam in interface UrlFormatter

Parameters:

pUrlState - the UrlState that will contain the parameter.

Returns:

the newly created URL parameter.

See Also:

UrlFormatter.getNavStateParamKey()

getNavStateParamKey

public String getNavStateParamKey()

Description copied from interface: UrlFormatter

The parameter key used for navigation state - typically "N".

Specified by:

getNavStateParamKey in interface UrlFormatter

See Also:

UrlFormatter.createNavStateUrlParam(UrlState)

getERecParamKey

public String getERecParamKey()

Description copied from interface: UrlFormatter

The parameter key used for record detail links - typically "R".

Specified by:

getERecParamKey in interface UrlFormatter

See Also:

UrlFormatter.createERecUrlParam(UrlState,com.endeca.navigation.ERec)

getAggrERecParamKey

public String getAggrERecParamKey()

Description copied from interface: UrlFormatter

The parameter key used for aggregate record detail links - typically "A".

Specified by:

getAggrERecParamKey in interface UrlFormatter

See Also:

UrlFormatter.createAggrERecUrlParam(UrlState,com.endeca.navigation.AggrERec)