vodserver.parambuilder

Class WebContentParamBuilder

java.lang.Object

vodserver.util.BaseBeanNameAware

vodserver.parambuilder.AbstractParamBuilder

vodserver.parambuilder.WebContentParamBuilder

All Implemented Interfaces:

Comparable<ParamBuilder>, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.InitializingBean, org.springframework.core.Ordered, ParamBuilder

public class WebContentParamBuilder
extends AbstractParamBuilder

This ParamBuilder implementation will retrieve the contents for some configured URL, and store the content as a parameter value. The parameter name under which the content is stored, as well as the HTTP headers used to execute the request, are also configurable.

Author:

Ruud Senden

Field Summary

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
WebContentParamBuilder()

Method Summary

Methods

Modifier and Type	Method and Description
void	buildParams(Map<String,String> params, javax.servlet.http.HttpServletRequest request) Execute the request, and store the result using the configured content output parameter name.
String	getContentOutputParam() Get the configured content output parameter name.
String	getContentUrlParam() Get the configured content URL parameter name.
String	getHeaderParamPrefix() Get the configured header parameter name prefix.
void	setContentOutputParam(String contentOutputParam) Set the name of the parameter to which the content will be stored.
void	setContentUrlParam(String contentUrlParam) Set the name of the parameter that contains the URL to retrieve the content from.
void	setHeaderParamPrefix(String headerParamPrefix) Set the parameter name prefix for a group of parameters containing request header names and values.
String	toString() Provide a useful string representation of this ParamBuilder, showing the content URL parameter name, the content output parameter name, and the header parameter name prefix.

Methods inherited from class vodserver.parambuilder.AbstractParamBuilder

afterPropertiesSet, compareTo, extraAfterPropertiesSet, getOrder, setOrder

Methods inherited from class vodserver.util.BaseBeanNameAware

getBeanName, setBeanName

Methods inherited from class java.lang.Object

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

Constructor Detail

WebContentParamBuilder

public WebContentParamBuilder()

Method Detail

buildParams

public void buildParams(Map<String,String> params,
               javax.servlet.http.HttpServletRequest request)

Execute the request, and store the result using the configured content output parameter name.

Parameters:

params - The parameters map to which parameters can be added or existing parameters can be retrieved.

request - The original request, useful to retrieve request parameters for example.

getContentUrlParam

public String getContentUrlParam()

Get the configured content URL parameter name.

Returns:

setContentUrlParam

public void setContentUrlParam(String contentUrlParam)

Set the name of the parameter that contains the URL to retrieve the content from. Default is 'url'.

Parameters:

contentUrlParam -

getContentOutputParam

public String getContentOutputParam()

Get the configured content output parameter name.

Returns:

setContentOutputParam

public void setContentOutputParam(String contentOutputParam)

Set the name of the parameter to which the content will be stored. Default is 'content'.

Parameters:

contentOutputParam -

getHeaderParamPrefix

public String getHeaderParamPrefix()

Get the configured header parameter name prefix.

Returns:

setHeaderParamPrefix

public void setHeaderParamPrefix(String headerParamPrefix)

Set the parameter name prefix for a group of parameters containing request header names and values. All parameters using this prefix will be used to determine the request headers. For example, suppose the header parameter prefix is set to 'header' (default), and the following parameters were previously defined:

• Parameter header.Referer with value http://somehost/page
• Parameter header.User-Agent with value Mozilla/5.0 (Windows NT 6.1; WOW64) ...
  Then the following request headers would be used for the request:
  • Referer: http://somehost/page
  • User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) ...

Parameters:

headerParamPrefix -

toString

public String toString()

Provide a useful string representation of this ParamBuilder, showing the content URL parameter name, the content output parameter name, and the header parameter name prefix.

Overrides:

toString in class Object