Parameter (Ibis AdapterFramework parent 7.9-20230130.195340 API)

java.lang.Object
- nl.nn.adapterframework.parameters.Parameter

All Implemented Interfaces:

IConfigurable, IConfigurationAware, INamedObject, IScopeProvider, IWithParameters, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware
```
public class Parameter
extends Object
implements IConfigurable, IWithParameters
```
Generic parameter definition. A parameter resembles an attribute. However, while attributes get their value at configuration-time, parameters get their value at the time of processing the message. Value can be retrieved from the message itself, a fixed value, or from the pipelineSession. If this does not result in a value (or if neither of these is specified), a default value can be specified. If an XPathExpression or stylesheet is specified, it will be applied to the message, the value retrieved from the pipelineSession or the fixed value specified. If the transformation produces no output, the default value of the parameter is taken if provided.

Examples:
```
 stored under SessionKey 'TransportInfo':
  <transportinfo>
   <to>***@zonnet.nl</to>
   <to>***@zonnet.nl</to>
   <cc>***@zonnet.nl</cc>
  </transportinfo>

 to obtain all 'to' addressees as a parameter:
 sessionKey="TransportInfo"
 xpathExpression="transportinfo/to"
 type="xml"

 Result:
   <to>***@zonnet.nl</to>
   <to>***@zonnet.nl</to>
 
```
N.B. to obtain a fixed value: a non-existing 'dummy' sessionKey in combination with the fixed value in defaultValue is used traditionally. The current version of parameter supports the 'value' attribute, that is sufficient to set a fixed value.
Author:

Gerrit van Brakel

Parameters

Parameters themselves can have parameters too, for instance if a XSLT transformation is used, that transformation can have parameters.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Parameter.DefaultValueMethods

static class Parameter.ParameterType

Nested Classes
Modifier and Type	Class and Description
`static class`	`Parameter.DefaultValueMethods`
`static class`	`Parameter.ParameterType`

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`FIXEDHOSTNAME`
`static String`	`FIXEDUID`
`protected org.apache.logging.log4j.Logger`	`log`
`protected ParameterList`	`paramList`
`static String`	`TYPE_DATE_PATTERN`
`static String`	`TYPE_DATETIME_PATTERN`
`static String`	`TYPE_TIME_PATTERN`
`static String`	`TYPE_TIMESTAMP_PATTERN`

Constructor Summary

Constructors
Constructor and Description

Parameter()

Parameter(String name, String value)
utility constructor, useful for unit testing

Constructors
Constructor and Description
`Parameter()`
`Parameter(String name, String value)` utility constructor, useful for unit testing

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addParameter(Parameter p)`
`void`	`configure()`
`boolean`	`consumesSessionVariable(String sessionKey)`
`String`	`getName()`
`ParameterList`	`getParameterList()`
`Object`	`getValue(ParameterValueList alreadyResolvedParameters, Message message, PipeLineSession session, boolean namespaceAware)` determines the raw value
`boolean`	`requiresInputValueForResolution()` if this returns true, then the input value must be repeatable, as it might be used multiple times.
`boolean`	`requiresInputValueOrContextForResolution()`
`void`	`setAuthAlias(String string)` Alias used to obtain username and password, used when a `pattern` containing {username} or {password} is specified
`void`	`setContextKey(String string)` key of message context variable to use as source, instead of the message found from input message or sessionKey itself
`void`	`setDecimalSeparator(String string)` Used in combination with type `NUMBER`
`void`	`setDefaultValue(String string)` If the result of sessionKey, xpathExpression and/or stylesheet returns null or an empty string, this value is returned
`void`	`setDefaultValueMethods(String string)` Comma separated list of methods (`defaultValue`, `sessionKey`, `pattern`, `value` or `input`) to use as default value.
`void`	`setFormatString(String string)` Used in combination with types `DATE`, `TIME`, `DATETIME` and `TIMESTAMP` to parse the raw parameter string data into an object of the respective type
`void`	`setGroupingSeparator(String string)` Used in combination with type `NUMBER`
`void`	`setHidden(boolean b)` If set to `true`, the value of the parameter will not be shown in the log (replaced by asterisks)
`void`	`setIgnoreUnresolvablePatternElements(boolean b)` If set `true` pattern elements that cannot be resolved to a parameter or sessionKey are silently resolved to an empty string
`void`	`setMaxInclusive(String string)` Used in combination with type `number`; if set and the value of the parameter exceeds this maximum value, this maximum value is taken
`void`	`setMaxLength(int i)` If set (>=0) and the length of the value of the parameter exceeds this maximum length, the length is trimmed to this maximum length
`void`	`setMinInclusive(String string)` Used in combination with type `number`; if set and the value of the parameter falls short of this minimum value, this minimum value is taken
`void`	`setMinLength(int i)` If set (>=0) and the length of the value of the parameter falls short of this minimum length, the value is padded
`void`	`setName(String parameterName)` Name of the parameter
`void`	`setNamespaceDefs(String namespaceDefs)` Namespace defintions for xpathExpression.
`void`	`setPassword(String string)` Default password that is used when a `pattern` containing {password} is specified
`void`	`setPattern(String string)` Value of parameter is determined using substitution and formatting, following MessageFormat syntax with named parameters.
`void`	`setRemoveNamespaces(boolean b)` When set `true` namespaces (and prefixes) in the input message are removed before the stylesheet/xpathExpression is executed
`void`	`setSessionKey(String string)` Key of a PipelineSession-variable.
`void`	`setSessionKeyXPath(String string)` Instead of a fixed `sessionKey` it's also possible to use a XPath expression applied to the input message to extract the name of the session-variable.
`void`	`setStyleSheetName(String stylesheetName)` URL to a stylesheet that wil be applied to the contents of the message or the value of the session-variable.
`void`	`setType(Parameter.ParameterType type)` The target data type of the parameter, related to the database or XSLT stylesheet to which the parameter is applied.
`void`	`setUsername(String string)` Default username that is used when a `pattern` containing {username} is specified
`void`	`setUserName(String username)` Deprecated.
`void`	`setValue(String value)` The value of the parameter, or the base for transformation using xpathExpression or stylesheet, or formatting.
`void`	`setXpathExpression(String xpathExpression)` the XPath expression to extract the parameter value from the (xml formatted) input or session-variable.
`void`	`setXslt2(boolean b)` Deprecated.
`void`	`setXsltVersion(int xsltVersion)` when set to `2` xslt processor 2.0 (net.sf.saxon) will be used, otherwise xslt processor 1.0 (org.apache.xalan).
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface nl.nn.adapterframework.core.IConfigurationAware
getApplicationContext

Methods inherited from interface nl.nn.adapterframework.core.IScopeProvider
getConfigurationClassLoader

Methods inherited from interface org.springframework.context.ApplicationContextAware
setApplicationContext

- Field Detail
  - log
```
protected org.apache.logging.log4j.Logger log
```
  - TYPE_DATE_PATTERN
```
public static final String TYPE_DATE_PATTERN
```
    See Also:
    
    Constant Field Values
  - TYPE_TIME_PATTERN
```
public static final String TYPE_TIME_PATTERN
```
    See Also:
    
    Constant Field Values
  - TYPE_DATETIME_PATTERN
```
public static final String TYPE_DATETIME_PATTERN
```
    See Also:
    
    Constant Field Values
  - TYPE_TIMESTAMP_PATTERN
```
public static final String TYPE_TIMESTAMP_PATTERN
```
    See Also:
    
    Constant Field Values
  - FIXEDUID
```
public static final String FIXEDUID
```
    See Also:
    
    Constant Field Values
  - FIXEDHOSTNAME
```
public static final String FIXEDHOSTNAME
```
    See Also:
    
    Constant Field Values
  - paramList
```
protected ParameterList paramList
```
- Constructor Detail
  - Parameter
```
public Parameter()
```
  - Parameter
```
public Parameter(String name,
                 String value)
```
    utility constructor, useful for unit testing
- Method Detail
  - addParameter
```
public void addParameter(Parameter p)
```
    Specified by:
    
    addParameter in interface IWithParameters
  - getParameterList
```
public ParameterList getParameterList()
```
    Specified by:
    
    getParameterList in interface IWithParameters
  - configure
```
public void configure()
               throws ConfigurationException
```
    Specified by:
    
    configure in interface IConfigurable
    
    Throws:
    
    ConfigurationException
  - requiresInputValueForResolution
```
public boolean requiresInputValueForResolution()
```
    if this returns true, then the input value must be repeatable, as it might be used multiple times.
  - requiresInputValueOrContextForResolution
```
public boolean requiresInputValueOrContextForResolution()
```
  - consumesSessionVariable
```
public boolean consumesSessionVariable(String sessionKey)
```
  - getValue
```
public Object getValue(ParameterValueList alreadyResolvedParameters,
                       Message message,
                       PipeLineSession session,
                       boolean namespaceAware)
                throws ParameterException
```
    determines the raw value
    
    Throws:
    
    ParameterException
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - setName
```
public void setName(String parameterName)
```
    Name of the parameter
    
    Specified by:
    
    setName in interface INamedObject
  - getName
```
public String getName()
```
    Specified by:
    
    getName in interface IConfigurationAware
    
    Specified by:
    
    getName in interface INamedObject
  - setType
```
public void setType(Parameter.ParameterType type)
```
    The target data type of the parameter, related to the database or XSLT stylesheet to which the parameter is applied.
  - setValue
```
public void setValue(String value)
```
    The value of the parameter, or the base for transformation using xpathExpression or stylesheet, or formatting.
  - setSessionKey
```
public void setSessionKey(String string)
```
    Key of a PipelineSession-variable.
    If specified, the value of the PipelineSession variable is used as input for the xpathExpression or stylesheet, instead of the current input message.
    If no xpathExpression or stylesheet are specified, the value itself is returned.
    If the value '*' is specified, all existing sessionkeys are added as parameter of which the name starts with the name of this parameter.
    If also the name of the parameter has the value '*' then all existing sessionkeys are added as parameter (except tsReceived)
  - setContextKey
```
public void setContextKey(String string)
```
    key of message context variable to use as source, instead of the message found from input message or sessionKey itself
  - setSessionKeyXPath
```
public void setSessionKeyXPath(String string)
```
    Instead of a fixed sessionKey it's also possible to use a XPath expression applied to the input message to extract the name of the session-variable.
  - setStyleSheetName
```
public void setStyleSheetName(String stylesheetName)
```
    URL to a stylesheet that wil be applied to the contents of the message or the value of the session-variable.
  - setXpathExpression
```
public void setXpathExpression(String xpathExpression)
```
    the XPath expression to extract the parameter value from the (xml formatted) input or session-variable.
  - setXsltVersion
```
public void setXsltVersion(int xsltVersion)
```
    when set to 2 xslt processor 2.0 (net.sf.saxon) will be used, otherwise xslt processor 1.0 (org.apache.xalan). 0 will auto detect
    
    Default value
    
    0
  - setXslt2
```
@Deprecated
 @ConfigurationWarning(value="Its value is now auto detected. If necessary, replace with a setting of xsltVersion")
public void setXslt2(boolean b)
```
    Deprecated.
  - setNamespaceDefs
```
public void setNamespaceDefs(String namespaceDefs)
```
    Namespace defintions for xpathExpression. Must be in the form of a comma or space separated list of prefix=namespaceuri-definitions. One entry can be without a prefix, that will define the default namespace.
  - setRemoveNamespaces
```
public void setRemoveNamespaces(boolean b)
```
    When set true namespaces (and prefixes) in the input message are removed before the stylesheet/xpathExpression is executed
    
    Default value
    
    false
  - setDefaultValue
```
public void setDefaultValue(String string)
```
    If the result of sessionKey, xpathExpression and/or stylesheet returns null or an empty string, this value is returned
  - setDefaultValueMethods
```
public void setDefaultValueMethods(String string)
```
    Comma separated list of methods (defaultValue, sessionKey, pattern, value or input) to use as default value. Used in the order they appear until a non-null value is found.
    
    Default value
    
    defaultValue
  - setPattern
```
public void setPattern(String string)
```
    Value of parameter is determined using substitution and formatting, following MessageFormat syntax with named parameters. The expression can contain references to session-variables or other parameters using {name-of-parameter} and is formatted using java.text.MessageFormat.
    If for instance fname is a parameter or session variable that resolves to eric, then the pattern 'hi {fname}, hoe gaat het?' resolves to 'hi eric, hoe gaat het?'.
    The following predefined reference can be used in the expression too:
    - {now}: the current system time
    - {uid}: an unique identifier, based on the IP address and java.rmi.server.UID
    - {uuid}: an unique identifier, based on the IP address and java.util.UUID
    - {hostname}: the name of the machine the application runs on
    - {username}: username from the credentials found using authAlias, or the username attribute
    - {password}: password from the credentials found using authAlias, or the password attribute
    - {fixeddate}: fake date, for testing only
    - {fixeduid}: fake uid, for testing only
    - {fixedhostname}: fake hostname, for testing only
    A guid can be generated using {hostname}_{uid}, see also http://java.sun.com/j2se/1.4.2/docs/api/java/rmi/server/uid.html for more information about (g)uid's or http://docs.oracle.com/javase/1.5.0/docs/api/java/util/uuid.html for more information about uuid's.
    When combining a date or time pattern like {now} or {fixeddate} with a DATE, TIME, DATETIME or TIMESTAMP type, the effective value of the attribute formatString must match the effective value of the formatString in the pattern.
  - setAuthAlias
```
public void setAuthAlias(String string)
```
    Alias used to obtain username and password, used when a pattern containing {username} or {password} is specified
  - setUsername
```
public void setUsername(String string)
```
    Default username that is used when a pattern containing {username} is specified
  - setUserName
```
@Deprecated
 @ConfigurationWarning(value="Please use attribute username instead")
public void setUserName(String username)
```
    Deprecated.
  - setPassword
```
public void setPassword(String string)
```
    Default password that is used when a pattern containing {password} is specified
  - setIgnoreUnresolvablePatternElements
```
public void setIgnoreUnresolvablePatternElements(boolean b)
```
    If set true pattern elements that cannot be resolved to a parameter or sessionKey are silently resolved to an empty string
  - setFormatString
```
public void setFormatString(String string)
```
    Used in combination with types DATE, TIME, DATETIME and TIMESTAMP to parse the raw parameter string data into an object of the respective type
    
    Default value
    
    depends on type
  - setDecimalSeparator
```
public void setDecimalSeparator(String string)
```
    Used in combination with type NUMBER
    
    Default value
    
    system default
  - setGroupingSeparator
```
public void setGroupingSeparator(String string)
```
    Used in combination with type NUMBER
    
    Default value
    
    system default
  - setMinLength
```
public void setMinLength(int i)
```
    If set (>=0) and the length of the value of the parameter falls short of this minimum length, the value is padded
    
    Default value
    
    -1
  - setMaxLength
```
public void setMaxLength(int i)
```
    If set (>=0) and the length of the value of the parameter exceeds this maximum length, the length is trimmed to this maximum length
    
    Default value
    
    -1
  - setMaxInclusive
```
public void setMaxInclusive(String string)
```
    Used in combination with type number; if set and the value of the parameter exceeds this maximum value, this maximum value is taken
  - setMinInclusive
```
public void setMinInclusive(String string)
```
    Used in combination with type number; if set and the value of the parameter falls short of this minimum value, this minimum value is taken
  - setHidden
```
public void setHidden(boolean b)
```
    If set to true, the value of the parameter will not be shown in the log (replaced by asterisks)
    
    Default value
    
    false

Class Parameter

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface nl.nn.adapterframework.core.IConfigurationAware

Methods inherited from interface nl.nn.adapterframework.core.IScopeProvider

Methods inherited from interface org.springframework.context.ApplicationContextAware

Field Detail

log

TYPE_DATE_PATTERN

TYPE_TIME_PATTERN

TYPE_DATETIME_PATTERN

TYPE_TIMESTAMP_PATTERN

FIXEDUID

FIXEDHOSTNAME

paramList

Constructor Detail

Parameter

Parameter

Method Detail

addParameter

getParameterList

configure

requiresInputValueForResolution

requiresInputValueOrContextForResolution

consumesSessionVariable

getValue

toString

setName

getName

setType

setValue

setSessionKey

setContextKey

setSessionKeyXPath

setStyleSheetName

setXpathExpression

setXsltVersion

setXslt2

setNamespaceDefs

setRemoveNamespaces

setDefaultValue

setDefaultValueMethods

setPattern

setAuthAlias

setUsername

setUserName

setPassword

setIgnoreUnresolvablePatternElements

setFormatString

setDecimalSeparator

setGroupingSeparator

setMinLength

setMaxLength

setMaxInclusive

setMinInclusive

setHidden