com.neurosys.collection.transformers

Class CollectionURLGeneratorTransformer<C extends Product>

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

com.neurosys.modules.etl.ProductURLGeneratorTransformer<C>

com.neurosys.collection.transformers.CollectionURLGeneratorTransformer<C>

All Implemented Interfaces:

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

public class CollectionURLGeneratorTransformer<C extends Product>
extends ProductURLGeneratorTransformer<C>

A Transformer that accepts collection Id/sku or any identifier that #collectionFetch accepts or Collection as Product and produces a Link for it. In addition to basic URL construction it also allows secureURL(Object, String) to add a SALT.
It also updates the Collection (Submit Mode) with any security details,params etc derived during the process. In secureURL(Object, String) in the submit process, it can validate the URL SALT.

Relies on CollectionAttributes.ATTRIB_COLLECTION_META_JSON TODO: Add Unit test case

Author:

Arjun Dhar

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_NAME The Salat parameter name

Fields inherited from class com.neurosys.modules.etl.ProductURLGeneratorTransformer

idFieldName, idParamName, productFetch, productService

Fields inherited from class com.neurosys.modules.etl.WicketURLGeneratorTransformer

secureURLUsingSalt

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
CollectionURLGeneratorTransformer()
CollectionURLGeneratorTransformer(Class<org.apache.wicket.Page> base)
CollectionURLGeneratorTransformer(CollectionURLGeneratorTransformer t, ProductService<C> productService) Allow to create a submit transformer from a ReadOnly version or visa versa based on if productService is null.

Method Summary

Modifier and Type	Method and Description
protected String	addAnalyticsParams(Object input, String url) Add analytic params (not affected by URLGeneratorTransformer.secureURL(Object, String))
protected String	cleanAndValidate(String url)
protected void	encryptParameter(Map.Entry<String,String> keyVaue, Key key) Encrypts a parameter key value pair.
String	getCampaignPropertyName()
String	getMedium() If the medium of sending the link is email, newsletter etc.
int	getSaltLength()
boolean	isUpdateMode() If true will not modify and persist the collection, will rather read from the collection.
protected String	secureURL(Object input, String url) Adds the CollectionAttributes#ATTRIB_COLLECTION_ACCESS_SALT as salt param and collectionId param.
void	setCampaignPropertyName(String campaignPropertyName)
void	setMedium(String medium) If the medium of sending the link is email, newsletter etc.
void	setSaltLength(int saltLength)
void	setUpdateMode(boolean updateMode) If true will not modify and persist the collection, will rather read from the collection.
Object	transform(Object colRef) Call URLGeneratorTransformer.secureURL(Object, String) then URLGeneratorTransformer.decorateURL(Object, String) and then URLGeneratorTransformer.addAnalyticsParams(Object, String)

Methods inherited from class com.neurosys.modules.etl.ProductURLGeneratorTransformer

decorateURL, getCollectionFetch, getIdFieldName, getIdParamName, getProductService, setCollectionFetch, setIdFieldName, setIdParamName, setProductService

Methods inherited from class com.neurosys.modules.etl.WicketURLGeneratorTransformer

getBaseUrlStr, getProtocolStrict, getUrlFormat, getWwwStrict, initWithRequestCycle, isAbsolute, isSecureURLUsingSalt, setAbsolute, setBaseUrlStr, setProtocolStrict, setSecureURLUsingSalt, setUrlFormat, setWwwStrict

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

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

KEY_NAME

public static final String KEY_NAME

The Salat parameter name

See Also:

Constant Field Values

Constructor Detail

CollectionURLGeneratorTransformer

public CollectionURLGeneratorTransformer()

CollectionURLGeneratorTransformer

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

CollectionURLGeneratorTransformer

public CollectionURLGeneratorTransformer(CollectionURLGeneratorTransformer t,
                                         ProductService<C> productService)
                                  throws Exception

Allow to create a submit transformer from a ReadOnly version or visa versa based on if productService is null.

Throws:

Exception

Method Detail

encryptParameter

protected void encryptParameter(Map.Entry<String,String> keyVaue,
                                Key key)
                         throws Exception

Encrypts a parameter key value pair.

Parameters:

keyVaue - as Map.Entry

key - as Key

Throws:

Exception

addAnalyticsParams

protected String addAnalyticsParams(Object input,
                                    String url)
                             throws Exception

Description copied from class: URLGeneratorTransformer

Add analytic params (not affected by URLGeneratorTransformer.secureURL(Object, String))

Overrides:

addAnalyticsParams in class URLGeneratorTransformer

Parameters:

input - as Object

url - as String

Returns:

Throws:

Exception

cleanAndValidate

protected String cleanAndValidate(String url)

Overrides:

cleanAndValidate in class ProductURLGeneratorTransformer<C extends Product>

secureURL

protected String secureURL(Object input,
                           String url)

Adds the CollectionAttributes#ATTRIB_COLLECTION_ACCESS_SALT as salt param and collectionId param.

Overrides:

secureURL in class WicketURLGeneratorTransformer

transform

public Object transform(Object colRef)

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 ProductURLGeneratorTransformer<C extends Product>

isUpdateMode

public boolean isUpdateMode()

If true will not modify and persist the collection, will rather read from the collection.
Data like SALT used etc can be saved.

Default value:

false

setUpdateMode

public void setUpdateMode(boolean updateMode)

If true will not modify and persist the collection, will rather read from the collection.
Data like SALT used etc can be saved.

Default value:

false

getMedium

public String getMedium()

If the medium of sending the link is email, newsletter etc. This is used in analytics UTM codes

Default value:

email.

setMedium

public void setMedium(String medium)

If the medium of sending the link is email, newsletter etc. This is used in analytics UTM codes

Default value:

email.

getSaltLength

public int getSaltLength()

setSaltLength

public void setSaltLength(int saltLength)

getCampaignPropertyName

public String getCampaignPropertyName()

setCampaignPropertyName

public void setCampaignPropertyName(String campaignPropertyName)