com.neurosys.modules.etl

Class WicketURLGeneratorTransformer

java.lang.Object

com.neurosys.etl.common.transformers.JoinTransformer<String>

com.neurosys.etl.common.transformers.StringConcatTransformer

com.neurosys.etl.common.transformers.URLGeneratorTransformer

com.neurosys.modules.etl.WicketURLGeneratorTransformer

All Implemented Interfaces:

FunctionTransformer, UsesRequestCycle, Serializable, Function, org.apache.commons.collections.Transformer

Direct Known Subclasses:

OrderURLGeneratorTransformer, ProductURLGeneratorTransformer

public class WicketURLGeneratorTransformer
extends URLGeneratorTransformer
implements UsesRequestCycle, Serializable

A URLGeneratorTransformer where the base path can be generated using the Wicket Page Class name.

Since this relies on a RequestCycle to generate the baseUrlStr; for situations where there is no RequestCycle available as a hack, utilize UsesRequestCycle.initWithRequestCycle(RequestCycle)
FIXME : A better solution though would be to derive the URL without the need of a RequestCycle (Wicket 5+ may have the answer). Look for it in the upgrade!

Note: Various URL parts maybe explicitly need to be URL encoded; the default implementation does not encode. Check the derived implementation if any particular parts of the URL are encoded. TODO: Add Unit test case

Author:

Arjun Dhar

See Also:

UsesRequestCycle, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	secureURLUsingSalt Appends a parameter called salt.

Fields inherited from class com.neurosys.etl.common.transformers.URLGeneratorTransformer

paramsAdded, usePathAsParams

Fields inherited from class com.neurosys.etl.common.transformers.JoinTransformer

filter, processors

Constructor Summary

Constructors

Constructor and Description
WicketURLGeneratorTransformer()
WicketURLGeneratorTransformer(Class<org.apache.wicket.Page> base)
WicketURLGeneratorTransformer(Class<org.apache.wicket.Page> base, Object params)
WicketURLGeneratorTransformer(List processors)
WicketURLGeneratorTransformer(Object base, Object params)

Method Summary

Modifier and Type	Method and Description
String	getBaseUrlStr() Base string for URL.
String	getProtocolStrict() If specified will ensure it uses this protocol (replaces default) for the generated URL.
String	getUrlFormat() Whatever is set via the base wrap and format that using Formatter
Boolean	getWwwStrict() If specified true, will ensure it uses "www" convention is used for the link
void	initWithRequestCycle(org.apache.wicket.RequestCycle requestCycle) If base is defines and we want to derive baseUrlStr then providing an opportunity for the Calling API with the RequestCycle ThreadLocal to initialize this instance with the correct equivalent path.
boolean	isAbsolute()
boolean	isSecureURLUsingSalt() Appends a parameter called salt.
protected String	secureURL(Object input, String url) Override to secure url params
void	setAbsolute(boolean absolute)
void	setBaseUrlStr(String baseUrlStr) Base string for URL.
void	setProtocolStrict(String protocolStrict) If specified will ensure it uses this protocol (replaces default) for the generated URL.
void	setSecureURLUsingSalt(boolean secureURLUsingSalt) Appends a parameter called salt.
void	setUrlFormat(String urlFormat) Whatever is set via the base wrap and format that using Formatter
void	setWwwStrict(Boolean wwwStrict) If specified true, will ensure it uses "www" convention is used for the link
Object	transform(Object input) Call URLGeneratorTransformer.secureURL(Object, String) then URLGeneratorTransformer.decorateURL(Object, String) and then URLGeneratorTransformer.addAnalyticsParams(Object, String)

Methods inherited from class com.neurosys.etl.common.transformers.URLGeneratorTransformer

addAnalyticsParams, decorateURL, isParamsAdded, isUsePathAsParams, joinDelimet, setParamsAdded, setProcessors, setUsePathAsParams

Methods inherited from class com.neurosys.etl.common.transformers.StringConcatTransformer

cleanDangligngDelimets, getDanglingDelimRegEx, getDelimiter, join, setDanglingDelimRegEx, setDelimiter

Methods inherited from class com.neurosys.etl.common.transformers.JoinTransformer

getFilter, getProcessors, setFilter

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.neurosys.etl.common.transformers.FunctionTransformer

apply

Methods inherited from interface java.util.function.Function

andThen, compose, identity

Field Detail

secureURLUsingSalt

protected boolean secureURLUsingSalt

Appends a parameter called salt. If #secureURLUsingKey is true then the value of this will also be encrypted.

Constructor Detail

WicketURLGeneratorTransformer

public WicketURLGeneratorTransformer()

WicketURLGeneratorTransformer

public WicketURLGeneratorTransformer(List processors)

WicketURLGeneratorTransformer

public WicketURLGeneratorTransformer(Object base,
                                     Object params)

WicketURLGeneratorTransformer

public WicketURLGeneratorTransformer(Class<org.apache.wicket.Page> base,
                                     Object params)

WicketURLGeneratorTransformer

public WicketURLGeneratorTransformer(Class<org.apache.wicket.Page> base)

Method Detail

secureURL

protected String secureURL(Object input,
                           String url)

Description copied from class: URLGeneratorTransformer

Override to secure url params

Overrides:

secureURL in class URLGeneratorTransformer

initWithRequestCycle

public void initWithRequestCycle(org.apache.wicket.RequestCycle requestCycle)

If base is defines and we want to derive baseUrlStr then providing an opportunity for the Calling API with the RequestCycle ThreadLocal to initialize this instance with the correct equivalent path.

Specified by:

initWithRequestCycle in interface UsesRequestCycle

Parameters:

requestCycle - as RequestCycle

transform

public Object transform(Object input)

Description copied from class: URLGeneratorTransformer

Call URLGeneratorTransformer.secureURL(Object, String) then URLGeneratorTransformer.decorateURL(Object, String) and then URLGeneratorTransformer.addAnalyticsParams(Object, String)

Specified by:

transform in interface org.apache.commons.collections.Transformer

Overrides:

transform in class URLGeneratorTransformer

isAbsolute

public boolean isAbsolute()

setAbsolute

public void setAbsolute(boolean absolute)

isSecureURLUsingSalt

public boolean isSecureURLUsingSalt()

Appends a parameter called salt. If #secureURLUsingKey is true then the value of this will also be encrypted.

setSecureURLUsingSalt

public void setSecureURLUsingSalt(boolean secureURLUsingSalt)

Appends a parameter called salt. If #secureURLUsingKey is true then the value of this will also be encrypted.

getBaseUrlStr

public String getBaseUrlStr()

Base string for URL. If this is specified base is useless

setBaseUrlStr

public void setBaseUrlStr(String baseUrlStr)

Base string for URL. If this is specified base is useless

getUrlFormat

public String getUrlFormat()

Whatever is set via the base wrap and format that using Formatter

Default value:

%s . is the base URL

setUrlFormat

public void setUrlFormat(String urlFormat)

Whatever is set via the base wrap and format that using Formatter

Default value:

%s . is the base URL

getProtocolStrict

public String getProtocolStrict()

If specified will ensure it uses this protocol (replaces default) for the generated URL. Works only if absolute is true.

A use case is that when generating the link, the page generating the link is on https, however we wish the final to be http. The default will be https hence to make it strictly http we can use this attribute.

Can be null:

true will get default

setProtocolStrict

public void setProtocolStrict(String protocolStrict)

If specified will ensure it uses this protocol (replaces default) for the generated URL. Works only if absolute is true.

A use case is that when generating the link, the page generating the link is on https, however we wish the final to be http. The default will be https hence to make it strictly http we can use this attribute.

Can be null:

true will get default

getWwwStrict

public Boolean getWwwStrict()

If specified true, will ensure it uses "www" convention is used for the link

Can be null:

true, will get default

setWwwStrict

public void setWwwStrict(Boolean wwwStrict)

If specified true, will ensure it uses "www" convention is used for the link

Can be null:

true, will get default