Difference between revisions of "ExtendedInboundParamHandlerFormatter"

From GreenVulcano Wiki
Jump to: navigation, search
Line 1: Line 1:
 
==Description==
 
==Description==
 
This sub-element formatter is used into the decoding of client request's parameters in order to create the input for a {{GVESB}} service and to convert the service's output into a HTTP response.  
 
This sub-element formatter is used into the decoding of client request's parameters in order to create the input for a {{GVESB}} service and to convert the service's output into a HTTP response.  
−
 
−
 
−
DA COMPLETARE
 
  
  
Line 13: Line 10:
 
! Attribute !! Type !! Description
 
! Attribute !! Type !! Description
 
|-
 
|-
−
| type || fixed || This attribute must keep the value '''FormatterPlugin'''.
+
| type || fixed || Set to '''FormatterPlugin'''.
 
|-
 
|-
 
| class|| fixed || Set to '''it.greenvulcano.gvesb.adapter.http.formatters.handlers.ExtendedInboundParamHandlerFormatter'''.
 
| class|| fixed || Set to '''it.greenvulcano.gvesb.adapter.http.formatters.handlers.ExtendedInboundParamHandlerFormatter'''.
Line 32: Line 29:
 
|}
 
|}
  
−
Contains the sub-elements [[#GVBufferFieldDefaultValue|GVBufferFieldDefaultValue]] and [[#GVBufferPropertyDefaultValue|GVBufferPropertyDefaultValue]].
+
Contains the sub-elements:
−
 
+
* [[#RequestParams|RequestParams]]
−
Contains the sub-elements
+
* [[#RequestContent|RequestContent]]
−
[[#GVBufferField|GVBufferField]].
+
* [[#GVBufferDefaultValues|GVBufferDefaultValues]]
−
 
+
* [[#OpTypeDefaultValue|OpTypeDefaultValue]]
−
==GVBufferFieldDefaultValue==
+
* [[#ResponseParams|ResponseParams]]
−
A configured default value for a field of a [[GVBuffer]] object.
+
* [[Description]]
−
The following table shows the '''GVBufferFieldDefaultValue''' attributes:
 
−
{|class="gvtable"
 
−
! Attribute !! Type !! Description
 
−
|-
 
−
| FieldName || required || The [[GVBuffer]] field name.
 
−
The possible values are:
 
−
* GVBuffer.system
 
−
* GVBuffer.service
 
−
* GVBuffer.id
 
−
* GVBuffer.retCode
 
−
* GVBuffer.object
 
−
|-
 
−
| FieldValue || required || The configured default value of a [[GVBuffer]] field.
 
−
|}
 
−
 
 
−
==GVBufferPropertyDefaultValue==
 
−
A configured default value for a property of a [[GVBuffer]] object.
 
−
The following table shows the '''GVBufferPropertyDefaultValue''' attributes:
 
−
{|class="gvtable"
 
−
! Attribute !! Type !! Description
 
−
|-
 
−
| FieldName || required || The [[GVBuffer]] property name.
 
−
|-
 
−
| FieldValue || required || A configured default value for a property field of a [[GVBuffer]] object.
 
−
|}
 
−
 
 
−
==GVBufferField==
 
−
This element represents a mapping target from/to a field of a [[GVBuffer]] object.
 
−
The following table shows the '''GVBufferField''' attributes:
 
−
{|class="gvtable"
 
−
! Attribute !! Type !! Description
 
−
|-
 
−
| FieldName || required || The [[GVBuffer]] field name.
 
−
The possible values are:
 
−
* GVBuffer.system
 
−
* GVBuffer.service
 
−
* GVBuffer.id
 
−
* GVBuffer.retCode
 
−
* GVBuffer.object
 
−
|}
 
−
 
 
−
==GVBufferProperty==
 
−
This element represents a mapping target from/to a property of a [[GVBuffer]] object.
 
−
The following table shows the '''GVBufferProperty''' attributes:
 
−
{|class="gvtable"
 
−
! Attribute !! Type !! Description
 
−
|-
 
−
| FieldName || required || The [[GVBuffer]] property name.
 
−
|}
 
−
 
 
−
==GVBufferPropertyList==
 
−
This element represents a mapping target from/to a list of properties of a [[GVBuffer]] object.
 
−
The following table shows the '''GVBufferPropertyList''' attributes:
 
−
{|class="gvtable"
 
−
! Attribute !! Type !! Description
 
−
|-
 
−
| URLEncoding|| required|| True if outbound request parameters must be URLEncoded, false otherwise.
 
−
Possible values are :
 
−
* True
 
−
* False
 
−
|-
 
−
| FieldNameValueSeparator || optional || Parameters name-value separator string. Default is '='
 
−
|-
 
−
| FieldEntrySeparator || optional || Parameters entry separator string within list. Default is ';'
 
−
|-
 
−
| ExcludeFields || optional || The comma separated list of property names to ignore.
 
−
|}
 
−
 
 
−
 
 
−
==DefaultValue==
 
−
This element represents a plain text value to be assigned as source/target of an handler mapping.
 
  
  
Line 129: Line 55:
  
 
==RequestContent==
 
==RequestContent==
−
This element contains configuration informations about conversion of the content of an inbound http request into a valid GVBuffer object and determination of the communication paradigm to be used by GreenVulcano.
+
This element contains configuration informations about conversion of the content of an inbound http request into a valid [[GVBuffer]] object and determination of the communication paradigm to be used by GreenVulcano.
  
 
Contains the sub-elements:
 
Contains the sub-elements:
Line 138: Line 64:
  
 
==RequestParam==
 
==RequestParam==
−
This element specifies the rules to follow to convert a single parameter of an inbound http request into a partially populated GVBuffer object.
+
This element specifies the rules to follow to convert a single parameter of an inbound http request into a partially populated [[GVBuffer]] object.
 
The following table shows the '''RequestParam''' attributes:
 
The following table shows the '''RequestParam''' attributes:
 
{|class="gvtable"
 
{|class="gvtable"
 
! Attribute !! Type !! Description
 
! Attribute !! Type !! Description
 
|-
 
|-
−
| Name|| required|| If true the request parameter is mandatory. Possible values are : '''True''', '''False'''. Default is '''True'''.
+
| Name|| required|| The name of an inbound request parameter.
 +
|-
 +
| Required|| optional|| If true the request parameter is mandatory. Default is '''True'''.
 
|-
 
|-
 
| Type|| optional || '''Not used'''
 
| Type|| optional || '''Not used'''
Line 150: Line 78:
  
 
==RequestXMLParamHandler==
 
==RequestXMLParamHandler==
−
This element contains configuration informations about an inbound request XML parameter <b>Handler</b>: a Java object used to extract informations from a single parameter of an inbound http request (in the case that this parameter contains an XML string) and use them to populate one or more fields of an GVBuffer request object to be sent to GreenVulcano.
+
This element contains configuration informations about an inbound request XML parameter <b>Handler</b>: a Java object used to extract informations from a single parameter of an inbound http request (in the case that this parameter contains an XML string) and use them to populate one or more fields of a [[GVBuffer]] request object to be sent to GreenVulcano.
  
 
Contains the sub-elements:
 
Contains the sub-elements:
Line 159: Line 87:
 
! Attribute !! Type !! Description
 
! Attribute !! Type !! Description
 
|-
 
|-
−
| ItemType || fixed|| Element type.
+
| ItemType || fixed|| Set to '''Handler'''.
 
|-
 
|-
 
| Class || fixed || Set to '''it.greenvulcano.gvesb.adapter.http.formatters.handlers.XMLParameterHandler'''.
 
| Class || fixed || Set to '''it.greenvulcano.gvesb.adapter.http.formatters.handlers.XMLParameterHandler'''.
 
|-
 
|-
−
| OutputType || required|| The output type of this inbound request parameter handler (GVBuffer object or communication paradigm string).
+
| OutputType || required|| The output type of this inbound request parameter handler ([[GVBuffer]] object or communication paradigm string).
 
Possible values are:
 
Possible values are:
 
* GVBuffer
 
* GVBuffer
Line 171: Line 99:
  
 
==RequestXMLParamMapping==
 
==RequestXMLParamMapping==
−
This element contains a mapping between a value extracted by an element or attribute (within XML content of an inbound request parameter) matching a given XPath, and a field of a request GVBuffer object. If mapping target is indicated with the "OpType" keyword, the value is a string indicating the requested communication paradigm (RequestReply, Request, SendReply, GetRequest, GetReply)
+
This element contains a mapping between a value extracted by an element or attribute (within XML content of an inbound request parameter) matching a given XPath, and a field of a request [[GVBuffer]] object. If mapping target is indicated with the "OpType" keyword, the value is a string indicating the requested communication paradigm (RequestReply, Request, SendReply, GetRequest, GetReply)
  
 
Contains the sub-elements:
 
Contains the sub-elements:
 
* [[#GVBufferField|GVBufferField]]
 
* [[#GVBufferField|GVBufferField]]
 
* [[#GVBufferProperty|GVBufferProperty]]
 
* [[#GVBufferProperty|GVBufferProperty]]
−
* [[#GVBufferPropertyList|GVBufferPropertyList]]
 
 
* [[#OpType|OpType]]
 
* [[#OpType|OpType]]
  
Line 183: Line 110:
 
! Attribute !! Type !! Description
 
! Attribute !! Type !! Description
 
|-
 
|-
−
| ItemType || fixed|| Element type.
+
| ItemType || fixed|| Set to '''Mapping'''.
 
|-
 
|-
 
| XPath || required || XPath of an element or attribute (within XML content of an inbound request parameter).
 
| XPath || required || XPath of an element or attribute (within XML content of an inbound request parameter).
Line 190: Line 117:
  
 
==RequestFlatParamHandler==
 
==RequestFlatParamHandler==
−
This element contains configuration informations about an inbound request Flat parameter <b>Handler</b>: a Java object used to extract informations from a single parameter of an inbound http request (in the case that this parameter contains a Flat string) and use them to populate one or more fields of an GVBuffer request object to be sent to GreenVulcano.
+
This element contains configuration informations about an inbound request Flat parameter <b>Handler</b>: a Java object used to extract informations from a single parameter of an inbound http request (in the case that this parameter contains a Flat string) and use them to populate one or more fields of a [[GVBuffer]] request object to be sent to GreenVulcano.
  
 
Contains the sub-elements:
 
Contains the sub-elements:
Line 199: Line 126:
 
! Attribute !! Type !! Description
 
! Attribute !! Type !! Description
 
|-
 
|-
−
| ItemType || fixed|| Element type.
+
| ItemType || fixed|| Set to '''Handler'''.
 
|-
 
|-
 
| Class || fixed|| Set to '''it.greenvulcano.gvesb.adapter.http.formatters.handlers.FlatParameterHandler'''
 
| Class || fixed|| Set to '''it.greenvulcano.gvesb.adapter.http.formatters.handlers.FlatParameterHandler'''
Line 213: Line 140:
  
 
==RequestFlatParamMapping==
 
==RequestFlatParamMapping==
−
This element contains a mapping between a value extracted from a flat string (the content of an inbound request parameter), and a field of a request GVBuffer object. If mapping target is indicated with the "OpType" keyword, the value is a string indicating the requested communication paradigm (RequestReply, Request, SendReply, GetRequest, GetReply).
+
This element contains a mapping between a value extracted from a flat string (the content of an inbound request parameter), and a field of a request [[GVBuffer]] object. If mapping target is indicated with the "OpType" keyword, the value is a string indicating the requested communication paradigm (RequestReply, Request, SendReply, GetRequest, GetReply).
  
 
Contains the sub-elements:
 
Contains the sub-elements:
Line 224: Line 151:
 
! Attribute !! Type !! Description
 
! Attribute !! Type !! Description
 
|-
 
|-
−
| ItemType || fixed || Element type.
+
| ItemType || fixed || Set to '''Mapping'''.
 
|-
 
|-
 
| Offset || required || The offset of a field within the flat string value of this inbound request parameter.
 
| Offset || required || The offset of a field within the flat string value of this inbound request parameter.
Line 240: Line 167:
  
 
==RequestStringParamHandler==
 
==RequestStringParamHandler==
−
This element contains configuration informations about an inbound request Flat parameter <b>Handler</b>: a Java object used to extract informations from a single parameter of an inbound http request (in the case that this parameter contains a plain text string) and use them to populate one or more fields of an GVBuffer request object to be sent to GreenVulcano.
+
This element contains configuration informations about an inbound request Flat parameter <b>Handler</b>: a Java object used to extract informations from a single parameter of an inbound http request (in the case that this parameter contains a plain text string) and use them to populate one or more fields of a [[GVBuffer]] request object to be sent to GreenVulcano.
  
 
Contains the sub-elements:
 
Contains the sub-elements:
Line 249: Line 176:
 
! Attribute !! Type !! Description
 
! Attribute !! Type !! Description
 
|-
 
|-
−
| ItemType || fixed || Inbound request parameter/content format.
+
| ItemType || fixed || Set to '''Handler'''.
 
|-
 
|-
−
| Class || fixed || The output type of this inbound request parameter handler (GVBuffer object or communication paradigm string).
+
| Class || fixed || Set to '''it.greenvulcano.gvesb.adapter.http.formatters.handlers.StringParameterHandler'''
 
|-
 
|-
−
| OutputType || required || This element contains a mapping between a value extracted from a plain text string (the value of an inbound request parameter), and a field of a request GVBuffer object. If mapping target is indicated with the "OpType" keyword, the value is a string indicating the requested communication paradigm (RequestReply, Request, SendReply, GetRequest, GetReply).
+
| OutputType || required || The output type of this inbound request parameter handler (GVBuffer object or communication paradigm string).
 +
Possible values are:
 +
* GVBuffer
 +
* OpType
 +
|}
  
 +
 +
===RequestStringParamMapping===
 +
This element contains a mapping between a value extracted from a plain text string (the value of an inbound request parameter), and a field of a request [[GVBuffer]] object. If mapping target is indicated with the "OpType" keyword, the value is a string indicating the requested communication paradigm (RequestReply, Request, SendReply, GetRequest, GetReply).
 +
 +
Contains the sub-elements:
 +
* [[#GVBufferField|GVBufferField]]
 +
* [[#GVBufferProperty|GVBufferProperty]]
 +
* [[#OpType|OpType]]
 +
 +
The following table shows the '''RequestStringParamMapping''' attributes:
 +
{|class="gvtable"
 +
! Attribute !! Type !! Description
 +
|-
 +
| ItemType || fixed || Set to '''Mapping'''.
 +
|}
 +
 +
 +
===GVBufferDefaultValues===
 +
This element contains the configuration of default values for some of all the fields of a inbound request [[GVBuffer]] object.
 +
 +
Contains the sub-elements:
 +
* [[#GVBufferFieldDefaultValue|GVBufferFieldDefaultValue]]
 +
* [[#GVBufferPropertyDefaultValue|GVBufferPropertyDefaultValue]]
 +
 +
 +
===OpTypeDefaultValue===
 +
A configured default value for the communication paradigm to be used.
 +
 +
The following table shows the '''OpTypeDefaultValue''' attributes:
 +
{|class="gvtable"
 +
! Attribute !! Type !! Description
 +
|-
 +
| Value || required || The configured default value for the communication paradigm.
 
Possible values are:
 
Possible values are:
−
'''GVBuffer''', '''OpType'''.
+
* RequestReply
 +
* Request
 +
* SendReply
 +
* GetRequest
 +
* GetReply
 +
|}
  
−
This is the template used:
+
 
−
<syntaxhighlight lang="XML">
+
==GVBufferFieldDefaultValue==
−
  <xsl:template match="RequestStringParamMapping">
+
A configured default value for a field of a [[GVBuffer]] object.
−
            <table cellpadding="0" cellspacing="0">
+
The following table shows the '''GVBufferFieldDefaultValue''' attributes:
−
            <xsl:choose>
+
{|class="gvtable"
−
                <xsl:when test="../../@Name">
+
! Attribute !! Type !! Description
−
                    <tr>
+
|-
−
                        <td>Inbound request parameter handled:</td>
+
| FieldName || required || The [[GVBuffer]] field name.
−
                        <td width="20"></td>
+
The possible values are:
−
                        <td><b><xsl:value-of select="../../@Name"/></b></td>
+
* GVBuffer.system
−
                    </tr>
+
* GVBuffer.service
−
                </xsl:when>
+
* GVBuffer.id
−
                <xsl:otherwise>
+
* GVBuffer.retCode
−
                    <tr>
+
* GVBuffer.object
−
                        <td>Inbound request content handler mapping.</td>
+
|-
−
                    </tr>
+
| FieldValue || required || The configured default value of a [[GVBuffer]] field.
−
                </xsl:otherwise>
+
|}
−
            </xsl:choose>
+
 
−
                <tr>
+
==GVBufferPropertyDefaultValue==
−
                    <td>Mapping target:
+
A configured default value for a property of a [[GVBuffer]] object.
−
                        <xsl:if test="GVBufferField">
+
The following table shows the '''GVBufferPropertyDefaultValue''' attributes:
−
                          field <b><xsl:value-of select="substring-after(GVBufferField/@FieldName, 'GVBuffer.')"/></b> of GVBuffer
+
{|class="gvtable"
−
                        </xsl:if>
+
! Attribute !! Type !! Description
−
                        <xsl:if test="GVBufferProperty">
+
|-
−
                            extended field <b><xsl:value-of select="GVBufferProperty/@FieldName"/></b> of GVBuffer
+
| FieldName || required || The [[GVBuffer]] property name.
−
                        </xsl:if>
+
|-
−
                        <xsl:if test="OpType">
+
| FieldValue || required || A configured default value for a property field of a [[GVBuffer]] object.
−
                            <i>OperationType</i> variable (GreenVulcano communication paradigm)
 
−
                        </xsl:if>
 
−
                    </td>
 
−
                </tr>
 
−
            </table>
 
−
        </xsl:template>
 
−
</syntaxhighlight>
 
 
|}
 
|}
 +
 +
==GVBufferField==
 +
This element represents a mapping target from/to a field of a [[GVBuffer]] object.
 +
The following table shows the '''GVBufferField''' attributes:
 +
{|class="gvtable"
 +
! Attribute !! Type !! Description
 +
|-
 +
| FieldName || required || The [[GVBuffer]] field name.
 +
The possible values are:
 +
* GVBuffer.system
 +
* GVBuffer.service
 +
* GVBuffer.id
 +
* GVBuffer.retCode
 +
* GVBuffer.object
 +
|}
 +
 +
==GVBufferProperty==
 +
This element represents a mapping target from/to a property of a [[GVBuffer]] object.
 +
The following table shows the '''GVBufferProperty''' attributes:
 +
{|class="gvtable"
 +
! Attribute !! Type !! Description
 +
|-
 +
| FieldName || required || The [[GVBuffer]] property name.
 +
|}
 +
 +
==GVBufferPropertyList==
 +
This element represents a mapping target from/to a list of properties of a [[GVBuffer]] object.
 +
The following table shows the '''GVBufferPropertyList''' attributes:
 +
{|class="gvtable"
 +
! Attribute !! Type !! Description
 +
|-
 +
| URLEncoding|| required|| True if outbound request parameters must be URLEncoded, false otherwise.
 +
Possible values are :
 +
* True
 +
* False
 +
|-
 +
| FieldNameValueSeparator || optional || Parameters name-value separator string. Default is '='
 +
|-
 +
| FieldEntrySeparator || optional || Parameters entry separator string within list. Default is ';'
 +
|-
 +
| ExcludeFields || optional || The comma separated list of property names to ignore.
 +
|}
 +
 +
 +
==DefaultValue==
 +
This element represents a plain text value to be assigned as source/target of an handler mapping.

Revision as of 09:56, 2 August 2013

Description

This sub-element formatter is used into the decoding of client request's parameters in order to create the input for a GreenVulcano® ESB service and to convert the service's output into a HTTP response.


GreenVulcano® ESB Configuration

The GVAdapterHttpConfiguration Element is used by: GVAdapters.

The following table shows the ExtendedInboundParamHandlerFormatter attributes:

Attribute Type Description
type fixed Set to FormatterPlugin.
class fixed Set to it.greenvulcano.gvesb.adapter.http.formatters.handlers.ExtendedInboundParamHandlerFormatter.
ID required Formatter identifier
read-request-header optional If 'true' reads the request HTTP headers and provide them with the request parameters. Default value is false.
ReqCharacterEncoding optional CharacterEncoding to be used to handle requests from external system. Default to UTF-8.
RespCharacterEncoding optional CharacterEncoding to handle responses to the external system. Default to UTF-8.
RespContentType optional ContentType to be declared while handling HTTP responses to the external system. Default to text/html.
HandlePostBodyAsParams optional If true force the POST body to be handled as application/x-www-form-urlencoded content type. Default is false.
ResponseOnError-HTTPCode optional If != -1 force the adapter to respond with the given http code on case of error. Default is -1 (disabled).

Contains the sub-elements:


RequestParams

This element contains configuration informations about conversion of the parameters of an inbound http request into a valid GVBuffer object and determination of the communication paradigm to be used by GreenVulcano.

Contains the sub-elements:

The following table shows the RequestParams attributes:

Attribute Type Description
ParamNameValueSeparator required Parameters name-value separator string within input querystring.
ParamEntrySeparator optional Parameters entry separator string within input querystring.


RequestContent

This element contains configuration informations about conversion of the content of an inbound http request into a valid GVBuffer object and determination of the communication paradigm to be used by GreenVulcano.

Contains the sub-elements:


RequestParam

This element specifies the rules to follow to convert a single parameter of an inbound http request into a partially populated GVBuffer object. The following table shows the RequestParam attributes:

Attribute Type Description
Name required The name of an inbound request parameter.
Required optional If true the request parameter is mandatory. Default is True.
Type optional Not used


RequestXMLParamHandler

This element contains configuration informations about an inbound request XML parameter Handler: a Java object used to extract informations from a single parameter of an inbound http request (in the case that this parameter contains an XML string) and use them to populate one or more fields of a GVBuffer request object to be sent to GreenVulcano.

Contains the sub-elements:

The following table shows the RequestXMLParamHandler attributes:

Attribute Type Description
ItemType fixed Set to Handler.
Class fixed Set to it.greenvulcano.gvesb.adapter.http.formatters.handlers.XMLParameterHandler.
OutputType required The output type of this inbound request parameter handler (GVBuffer object or communication paradigm string).

Possible values are:

  • GVBuffer
  • OpType


RequestXMLParamMapping

This element contains a mapping between a value extracted by an element or attribute (within XML content of an inbound request parameter) matching a given XPath, and a field of a request GVBuffer object. If mapping target is indicated with the "OpType" keyword, the value is a string indicating the requested communication paradigm (RequestReply, Request, SendReply, GetRequest, GetReply)

Contains the sub-elements:

The following table shows the RequestXMLParamMapping attributes:

Attribute Type Description
ItemType fixed Set to Mapping.
XPath required XPath of an element or attribute (within XML content of an inbound request parameter).


RequestFlatParamHandler

This element contains configuration informations about an inbound request Flat parameter Handler: a Java object used to extract informations from a single parameter of an inbound http request (in the case that this parameter contains a Flat string) and use them to populate one or more fields of a GVBuffer request object to be sent to GreenVulcano.

Contains the sub-elements:

The following table shows the RequestFlatParamHandler attributes:

Attribute Type Description
ItemType fixed Set to Handler.
Class fixed Set to it.greenvulcano.gvesb.adapter.http.formatters.handlers.FlatParameterHandler
OutputType required The output type of this inbound request parameter handler (GVBuffer object or communication paradigm string).

Possible values are:

  • GVBuffer
  • OpType
SeparatorChar optional The separator character between fields within the flat string value of this inbound request parameter.


RequestFlatParamMapping

This element contains a mapping between a value extracted from a flat string (the content of an inbound request parameter), and a field of a request GVBuffer object. If mapping target is indicated with the "OpType" keyword, the value is a string indicating the requested communication paradigm (RequestReply, Request, SendReply, GetRequest, GetReply).

Contains the sub-elements:

The following table shows the RequestFlatParamMapping attributes:

Attribute Type Description
ItemType fixed Set to Mapping.
Offset required The offset of a field within the flat string value of this inbound request parameter.
Length optional The length of a field within the flat string value of this inbound request parameter. Not needed if a field separator char has already been specified.
Trim optional The place where unneeded filling white spaces can be present.

Possible values are:

  • left, to trim leading white spaces
  • right, to trim trailing white spaces
  • both, to trim both leading and trailing spaces

If it is specified a value different from these above, no trimming will be performed


RequestStringParamHandler

This element contains configuration informations about an inbound request Flat parameter Handler: a Java object used to extract informations from a single parameter of an inbound http request (in the case that this parameter contains a plain text string) and use them to populate one or more fields of a GVBuffer request object to be sent to GreenVulcano.

Contains the sub-elements:

The following table shows the RequestStringParamHandler attributes:

Attribute Type Description
ItemType fixed Set to Handler.
Class fixed Set to it.greenvulcano.gvesb.adapter.http.formatters.handlers.StringParameterHandler
OutputType required The output type of this inbound request parameter handler (GVBuffer object or communication paradigm string).

Possible values are:

  • GVBuffer
  • OpType


RequestStringParamMapping

This element contains a mapping between a value extracted from a plain text string (the value of an inbound request parameter), and a field of a request GVBuffer object. If mapping target is indicated with the "OpType" keyword, the value is a string indicating the requested communication paradigm (RequestReply, Request, SendReply, GetRequest, GetReply).

Contains the sub-elements:

The following table shows the RequestStringParamMapping attributes:

Attribute Type Description
ItemType fixed Set to Mapping.


GVBufferDefaultValues

This element contains the configuration of default values for some of all the fields of a inbound request GVBuffer object.

Contains the sub-elements:


OpTypeDefaultValue

A configured default value for the communication paradigm to be used.

The following table shows the OpTypeDefaultValue attributes:

Attribute Type Description
Value required The configured default value for the communication paradigm.

Possible values are:

  • RequestReply
  • Request
  • SendReply
  • GetRequest
  • GetReply


GVBufferFieldDefaultValue

A configured default value for a field of a GVBuffer object. The following table shows the GVBufferFieldDefaultValue attributes:

Attribute Type Description
FieldName required The GVBuffer field name.

The possible values are:

  • GVBuffer.system
  • GVBuffer.service
  • GVBuffer.id
  • GVBuffer.retCode
  • GVBuffer.object
FieldValue required The configured default value of a GVBuffer field.

GVBufferPropertyDefaultValue

A configured default value for a property of a GVBuffer object. The following table shows the GVBufferPropertyDefaultValue attributes:

Attribute Type Description
FieldName required The GVBuffer property name.
FieldValue required A configured default value for a property field of a GVBuffer object.

GVBufferField

This element represents a mapping target from/to a field of a GVBuffer object. The following table shows the GVBufferField attributes:

Attribute Type Description
FieldName required The GVBuffer field name.

The possible values are:

  • GVBuffer.system
  • GVBuffer.service
  • GVBuffer.id
  • GVBuffer.retCode
  • GVBuffer.object

GVBufferProperty

This element represents a mapping target from/to a property of a GVBuffer object. The following table shows the GVBufferProperty attributes:

Attribute Type Description
FieldName required The GVBuffer property name.

GVBufferPropertyList

This element represents a mapping target from/to a list of properties of a GVBuffer object. The following table shows the GVBufferPropertyList attributes:

Attribute Type Description
URLEncoding required True if outbound request parameters must be URLEncoded, false otherwise.

Possible values are :

  • True
  • False
FieldNameValueSeparator optional Parameters name-value separator string. Default is '='
FieldEntrySeparator optional Parameters entry separator string within list. Default is ';'
ExcludeFields optional The comma separated list of property names to ignore.


DefaultValue

This element represents a plain text value to be assigned as source/target of an handler mapping.

Retrieved from "https://gvwiki.greenvulcano.com/gvwiki/index.php?title=ExtendedInboundParamHandlerFormatter&oldid=4104"