Package vodserver.parambuilder

This package contains ParamBuilder implementations.

See: Description

Interface Summary

Interface	Description
ParamBuilder	This interface describes the contract for ParamBuilder implementations.

Class Summary

Class	Description
AbstractContentRegExParamBuilder	This is an abstract base class for ParamBuilder implementations that use regular expressions to extract parameters from some content.
AbstractParamBuilder	This is an abstract base class for ParamBuilder implementations.
ContentDynamicRegExParamBuilder	This ParamBuilder will extract parameters from some content by using regular expressions.
ContentRegExParamBuilder	This ParamBuilder will extract parameters from some content by using regular expressions.
RequestParamBuilder	This ParamBuilder implementation simply copies all request parameters to the parameter map.
ScriptedParamBuilder	This ParamBuilder implementation can execute arbitrary scripts to build one or more parameters.
ScriptedParamBuilder.ScriptUtil	An instance of this utility class is available in the script context under the name 'util'.
StaticParamBuilder	This ParamBuilder implementation is configured with a map of parameter names and values.
WebContentParamBuilder	This ParamBuilder implementation will retrieve the contents for some configured URL, and store the content as a parameter value.

Package vodserver.parambuilder Description

This package contains ParamBuilder implementations. ParamBuilders are used to add arbitrary parameters to a parameter map. ParamBuilders usually execute in a chain, where each ParamBuilder can access parameters added by other ParamBuilders earlier in the chain. The output of the chain of ParamBuilders can be used by the caller, usually a Service implementation.

The following ParamBuilder implementations are currently available:

• StaticParamBuilder
  This ParamBuilder implementation is configured with a map of parameter names and values. It will simply add all of the configured parameters to the parameter map.
• RequestParamBuilder
  This ParamBuilder implementation simply copies all request parameters to the parameter map.
• ScriptedParamBuilder
  This ParamBuilder implementation can execute arbitrary scripts to build one or more parameters. This allows for very flexible and powerful ParamBuilder instances. All functionality provided by other ParamBuilders can also be accomplished with a ScriptedParamBuilder.
• WebContentParamBuilder
  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.
• ContentRegExParamBuilder
  This ParamBuilder implementation will search some content (as contained in a configurable parameter) using the configured regular expressions.
• ContentDynamicRegExParamBuilder
  This ParamBuilder implementation is similar to ContentRegExParamBuilder. The only difference is that the regular expression patterns can contain expressions as described by ExpressionUtil; these expressions will be evaluated before the regular expression is used to extract parameters from the content. This allows the use of earlier defined parameters inside a regular expression.

Apart from the concrete ParamBuilder implementations, this package contains some other classes and interfaces:

• ParamBuilder
  This interface specifies the method(s) that ParamBuilder implementations are required to implement.
• vodserver.parambuilder.AbstractParamBuilder
  This is an abstract base class for ParamBuilder implementations. It provides methods for setting the order property, used to determine in which order a chain of ParamBuilders will execute.
• {@link vodserver.parambuilder.AbstractContentRegExParamBuilder}
  This is an abstract base class for ParamBuilder implementations that use regular expressions to extract parameters from some content. The content needs to be defined by an earlier ParamBuilder.