Document use-payload-as-parameter-source attribute
For reference see: https://jira.springsource.org/browse/INT-2314 * Updated 2.1 JDBC XML Schema * Updated Docbook Reference Manual
This commit is contained in:
Gunnar Hillert
committed by
Mark Fisher
Mark Fisher
parent
092fa44552
commit
3b7bd6e6dd
@@ -431,7 +431,9 @@
|
||||
this attribute specifies the function name.
|
||||
<emphasis>Required</emphasis>.
|
||||
</para>
|
||||
<para><emphasis role="bold">sql-parameter-source-factory</emphasis></para>
|
||||
<para><emphasis role="bold">sql-parameter-source-factory</emphasis>
|
||||
(Not available for the Stored Procedure Inbound Channel Adapter.)</para>
|
||||
|
||||
<para>
|
||||
Reference to a <interfacename>SqlParameterSourceFactory</interfacename>.
|
||||
|
||||
@@ -444,9 +446,36 @@
|
||||
This may be sufficient for basic use cases. For more
|
||||
sophisticated options, consider passing in one or more
|
||||
<classname>ProcedureParameter</classname>. Please also refer to
|
||||
<xref linkend="sp-defining-parameter-sources"/>
|
||||
<xref linkend="sp-defining-parameter-sources"/>.
|
||||
<emphasis>Optional</emphasis>.
|
||||
</para>
|
||||
|
||||
<para><emphasis role="bold">use-payload-as-parameter-source</emphasis>
|
||||
(Not available for the Stored Procedure Inbound Channel Adapter.)</para>
|
||||
|
||||
<para>
|
||||
If set to <code>true</code>, the payload of the Message
|
||||
will be used as a source for providing parameters.
|
||||
If false, however, the entire Message will be available as a
|
||||
source for parameters.
|
||||
</para>
|
||||
<para>
|
||||
If no Procedure Parameters are passed in, this property
|
||||
will default to <code>true</code>. This means that using a default
|
||||
<classname>BeanPropertySqlParameterSourceFactory</classname>
|
||||
the bean properties of the payload will be used as a
|
||||
source for parameter values for the to-be-executed
|
||||
Stored Procedure or Stored Function.
|
||||
</para>
|
||||
<para>
|
||||
However, if Procedure Parameters are passed in, then
|
||||
this property will by default evaluate to <code>false</code>.
|
||||
<classname>ProcedureParameter</classname> allow for
|
||||
SpEL Expressions to be provided and therefore it is
|
||||
highly beneficial to have access to the entire Message. The property
|
||||
is set on the underlying <classname>StoredProcExecutor</classname>.
|
||||
<emphasis>Optional</emphasis>.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
<section id="sp-common-config-subelements">
|
||||
@@ -726,7 +755,8 @@
|
||||
ignore-column-meta-data="false"
|
||||
order="" ]]><co id="sp-outbound-xml02-co" linkends="sp-outbound-xml02" /><![CDATA[
|
||||
return-value-required="false" ]]><co id="sp-outbound-xml03-co" linkends="sp-outbound-xml03" /><![CDATA[
|
||||
sql-parameter-source-factory="">
|
||||
sql-parameter-source-factory=""
|
||||
use-payload-as-parameter-source="">
|
||||
<int:poller fixed-rate=""/>
|
||||
<int-jdbc:sql-parameter-definition name=""/>
|
||||
<int-jdbc:parameter name=""/>
|
||||
@@ -775,7 +805,8 @@
|
||||
reply-timeout="" ]]><co id="sp-gateway-xml03-co" linkends="sp-gateway-xml03" /><![CDATA[
|
||||
return-value-required="false" ]]><co id="sp-gateway-xml04-co" linkends="sp-gateway-xml04" /><![CDATA[
|
||||
skip-undeclared-results="" ]]><co id="sp-gateway-xml05-co" linkends="sp-gateway-xml05" /><![CDATA[
|
||||
sql-parameter-source-factory="">
|
||||
sql-parameter-source-factory=""
|
||||
use-payload-as-parameter-source="">
|
||||
<int-jdbc:sql-parameter-definition name="" direction="IN"
|
||||
type=""
|
||||
scale="10"/>
|
||||
@@ -841,7 +872,7 @@
|
||||
update counts, thus the value defaults to <code>true</code>.
|
||||
<emphasis>Optional</emphasis>.
|
||||
</para>
|
||||
</callout>
|
||||
</callout>
|
||||
</calloutlist>
|
||||
</para>
|
||||
</section>
|
||||
|
||||
@@ -644,26 +644,24 @@
|
||||
<xsd:attributeGroup ref="coreStoredProcComponentAttributes"/>
|
||||
<xsd:attribute name="use-payload-as-parameter-source">
|
||||
<xsd:annotation>
|
||||
<xsd:appinfo>
|
||||
<xsd:documentation>
|
||||
<![CDATA[
|
||||
If set to 'true', the payload of the Message will be used
|
||||
as a source for providing parameters. If false the entire
|
||||
Message will be available as a source for parameters.
|
||||
|
||||
If no Procedure Parameters are passed in, this property
|
||||
will default to 'true'. This means that using a default
|
||||
BeanPropertySqlParameterSourceFactory the bean properties
|
||||
of the payload will be used as a source for parameter
|
||||
values for the to-be-executed Stored Procedure or Function.
|
||||
|
||||
However, if Procedure Parameters are passed in, then this
|
||||
property will by default evaluate to 'false'. ProcedureParameter
|
||||
allow for SpEl Expressions to be provided and therefore
|
||||
it is highly beneficial to have access to the entire Message.
|
||||
]]>
|
||||
</xsd:documentation>
|
||||
</xsd:appinfo>
|
||||
<xsd:documentation>
|
||||
<![CDATA[
|
||||
If set to 'true', the payload of the Message will be used
|
||||
as a source for providing parameters. If false the entire
|
||||
Message will be available as a source for parameters.
|
||||
|
||||
If no Procedure Parameters are passed in, this property
|
||||
will default to 'true'. This means that using a default
|
||||
BeanPropertySqlParameterSourceFactory the bean properties
|
||||
of the payload will be used as a source for parameter
|
||||
values for the to-be-executed Stored Procedure or Function.
|
||||
|
||||
However, if Procedure Parameters are passed in, then this
|
||||
property will by default evaluate to 'false'. ProcedureParameter
|
||||
allow for SpEL Expressions to be provided and therefore
|
||||
it is highly beneficial to have access to the entire Message.
|
||||
]]>
|
||||
</xsd:documentation>
|
||||
</xsd:annotation>
|
||||
<xsd:simpleType>
|
||||
<xsd:union memberTypes="xsd:boolean xsd:string" />
|
||||
@@ -796,26 +794,24 @@
|
||||
<xsd:attributeGroup ref="coreStoredProcComponentAttributes"/>
|
||||
<xsd:attribute name="use-payload-as-parameter-source">
|
||||
<xsd:annotation>
|
||||
<xsd:appinfo>
|
||||
<xsd:documentation>
|
||||
<![CDATA[
|
||||
If set to 'true', the payload of the Message will be used
|
||||
as a source for providing parameters. If false the entire
|
||||
Message will be available as a source for parameters.
|
||||
|
||||
If no Procedure Parameters are passed in, this property
|
||||
will default to 'true'. This means that using a default
|
||||
BeanPropertySqlParameterSourceFactory the bean properties
|
||||
of the payload will be used as a source for parameter
|
||||
values for the to-be-executed Stored Procedure or Function.
|
||||
|
||||
However, if Procedure Parameters are passed in, then this
|
||||
property will by default evaluate to 'false'. ProcedureParameter
|
||||
allow for SpEl Expressions to be provided and therefore
|
||||
it is highly beneficial to have access to the entire Message.
|
||||
]]>
|
||||
</xsd:documentation>
|
||||
</xsd:appinfo>
|
||||
<xsd:documentation>
|
||||
<![CDATA[
|
||||
If set to 'true', the payload of the Message will be used
|
||||
as a source for providing parameters. If false the entire
|
||||
Message will be available as a source for parameters.
|
||||
|
||||
If no Procedure Parameters are passed in, this property
|
||||
will default to 'true'. This means that using a default
|
||||
BeanPropertySqlParameterSourceFactory the bean properties
|
||||
of the payload will be used as a source for parameter
|
||||
values for the to-be-executed Stored Procedure or Function.
|
||||
|
||||
However, if Procedure Parameters are passed in, then this
|
||||
property will by default evaluate to 'false'. ProcedureParameter
|
||||
allow for SpEL Expressions to be provided and therefore
|
||||
it is highly beneficial to have access to the entire Message.
|
||||
]]>
|
||||
</xsd:documentation>
|
||||
</xsd:annotation>
|
||||
<xsd:simpleType>
|
||||
<xsd:union memberTypes="xsd:boolean xsd:string" />
|
||||
|
||||
Reference in New Issue
Block a user