ExtendedInboundParamHandlerFormatter - Revision history

G.dimaio at 14:44, 2 August 2013

2013-08-02T14:44:22Z

G.dimaio at 14:32, 2 August 2013

2013-08-02T14:32:00Z

G.dimaio at 14:23, 2 August 2013

2013-08-02T14:23:31Z

G.dimaio at 14:22, 2 August 2013

2013-08-02T14:22:56Z

G.dimaio at 11:38, 2 August 2013

2013-08-02T11:38:00Z

G.dimaio at 10:03, 2 August 2013

2013-08-02T10:03:59Z

G.dimaio at 09:56, 2 August 2013

2013-08-02T09:56:54Z

Show changes

G.dimaio at 08:27, 2 August 2013

2013-08-02T08:27:37Z

Show changes

G.dimaio at 16:02, 29 July 2013

2013-07-29T16:02:42Z

A.capaldo: /* RequestFlatParamMapping */

2013-07-26T16:57:02Z

‎RequestFlatParamMapping

@@ Line 421: / Line 421: @@
 The following table shows the '''ResponseStringParamMapping''' attributes:
 {|class="gvtable"
 ! Attribute !! Type !! Description

← Older revision		Revision as of 14:32, 2 August 2013
Line 480:		Line 480:
	===DefaultValue===		===DefaultValue===
	This element represents a plain text value to be assigned as source/target of an handler mapping.		This element represents a plain text value to be assigned as source/target of an handler mapping.
		+
		+
		+	===DefaultErrorMessage===
		+	This element represents a plain text value to be assigned as source of an inbound response error message.
		+
		+
		+	===GVTransactionErrorInfo===
		+	This element represents a mapping target from a field of an [[GVTransactionInfo]] object to the error value of an HTTP parameter.
		+	The following table shows the '''GVTransactionErrorInfo''' attributes:
		+	{\|class="gvtable"
		+	! Attribute !! Type !! Description
		+	\|-
		+	\| Value \|\| required \|\| The [[GVTransactionInfo]] field name.
		+	The possible values are:
		+	* GVTransInfo.system
		+	* GVTransInfo.service
		+	* GVTransInfo.id
		+	* GVTransInfo.errorCode
		+	* GVTransInfo.errorMessage
		+	\|}

← Older revision		Revision as of 14:23, 2 August 2013
Line 474:		Line 474:


−	===~~OpTyp~~=e==	+	===OpType===
	This element represents a mapping target to the variable containing the communication paradigm to be used.		This element represents a mapping target to the variable containing the communication paradigm to be used.

@@ Line 305: / Line 305: @@
 * GetRequest
 * GetReply
 |}
@@ Line 352: / Line 472: @@
 | 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 48: / Line 48: @@
 ! Attribute !! Type !! Description
 |-
-| ParamNameValueSeparator|| required|| Parameters name-value separator string within input querystring.
+| ParamNameValueSeparator|| optional || Parameters name-value separator string within input querystring.
 |-
 | ParamEntrySeparator|| optional || Parameters entry separator string within input querystring.
@@ Line 83: / Line 83: @@
-==RequestXMLParamHandler==
+==ResponseParams==
 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.
@@ Line 104: / Line 147: @@
-===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)
@@ Line 122: / Line 165: @@
-==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 a [[GVBuffer]] request object to be sent to GreenVulcano.
@@ Line 145: / Line 188: @@
-===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).
@@ Line 172: / Line 215: @@
-==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 a [[GVBuffer]] request object to be sent to GreenVulcano.
@@ Line 193: / Line 236: @@
-===RequestStringParamMapping===
+====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).
@@ Line 209: / Line 252: @@
-==GVBufferDefaultValues==
+==Default Value Handlers==
 This element contains the configuration of default values for some of all the fields of a inbound request [[GVBuffer]] object.
@@ Line 216: / Line 260: @@
 * [[#GVBufferPropertyDefaultValue|GVBufferPropertyDefaultValue]]
 ===GVBufferFieldDefaultValue===
 A configured default value for a field of a [[GVBuffer]] object.
 The following table shows the '''GVBufferFieldDefaultValue''' attributes:
@@ Line 234: / Line 279: @@
-===GVBufferPropertyDefaultValue===
+====GVBufferPropertyDefaultValue====
 A configured default value for a property of a [[GVBuffer]] object.
 The following table shows the '''GVBufferPropertyDefaultValue''' attributes:
@@ Line 246: / Line 291: @@
-==OpTypeDefaultValue==
+===OpTypeDefaultValue===
 A configured default value for the communication paradigm to be used.
@@ Line 263: / Line 308: @@
-==GVBufferField==
+==Common Elements==
 This element represents a mapping target from/to a field of a [[GVBuffer]] object.
 The following table shows the '''GVBufferField''' attributes:
@@ Line 279: / Line 325: @@
-==GVBufferProperty==
+===GVBufferProperty===
 This element represents a mapping target from/to a property of a [[GVBuffer]] object.
 The following table shows the '''GVBufferProperty''' attributes:
@@ Line 289: / Line 335: @@
-==GVBufferPropertyList==
+===GVBufferPropertyList===
 This element represents a mapping target from/to a list of properties of a [[GVBuffer]] object.
 The following table shows the '''GVBufferPropertyList''' attributes:
@@ Line 308: / Line 354: @@
-==DefaultValue==
+===DefaultValue===
 This element represents a plain text value to be assigned as source/target of an handler mapping.

@@ Line 54: / Line 54: @@
-==RequestContent==
+===RequestParam===
-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 specifies the rules to follow to convert a single parameter of an inbound http request into a partially populated [[GVBuffer]] object.
 Contains the sub-elements:
@@ Line 62: / Line 62: @@
 * [[#RequestStringParamHandler|RequestStringParamHandler]]
 The following table shows the '''RequestParam''' attributes:
 {|class="gvtable"
@@ Line 75: / Line 72: @@
 | Type|| optional || '''Not used'''
 |}
@@ Line 98: / Line 104: @@
-==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)
@@ Line 139: / Line 145: @@
-==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).
@@ Line 203: / Line 209: @@
-===GVBufferDefaultValues===
+==GVBufferDefaultValues==
 This element contains the configuration of default values for some of all the fields of a inbound request [[GVBuffer]] object.
@@ Line 210: / Line 216: @@
 * [[#GVBufferPropertyDefaultValue|GVBufferPropertyDefaultValue]]
+===GVBufferFieldDefaultValue===
 A configured default value for a field of a [[GVBuffer]] object.
 The following table shows the '''GVBufferFieldDefaultValue''' attributes:
@@ Line 245: / Line 233: @@
 |}
 ==GVBufferPropertyDefaultValue==
 A configured default value for a property of a [[GVBuffer]] object.
 The following table shows the '''GVBufferPropertyDefaultValue''' attributes:
@@ Line 255: / Line 244: @@
 | FieldValue || required || A configured default value for a property field of a [[GVBuffer]] object.
 |}
 ==GVBufferField==
@@ Line 270: / Line 277: @@
 * GVBuffer.object
 |}
 ==GVBufferProperty==
@@ Line 279: / Line 287: @@
 | FieldName || required || The [[GVBuffer]] property name.
 |}
 ==GVBufferPropertyList==

@@ Line 15: / Line 15: @@
 | type || fixed || This attribute must keep the value '''FormatterPlugin'''.
 |-
-| class|| fixed || Module Id always set to '''it.greenvulcano.gvesb.adapter.http.formatters.handlers.ExtendedInboundParamHandlerFormatter'''.
+| class|| fixed || Set to '''it.greenvulcano.gvesb.adapter.http.formatters.handlers.ExtendedInboundParamHandlerFormatter'''.
 |-
-| ID || required || If 'true' reads the request HTTP headers and provide them with the request parameters. Default value is '''false'''.
+| ID || required || Formatter identifier
 |-
-| read-request-header || optional || CharacterEncoding to be used to handle requests from external system. Default to UTF-8.
+| 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 handle responses to the external system. Default to UTF-8.
+| ReqCharacterEncoding || optional || CharacterEncoding to be used to handle requests from external system. Default to UTF-8.
 |-
-| RespCharacterEncoding || optional || ContentType to be declared while handling HTTP responses to the external system. Default to text/html.
+| RespCharacterEncoding || optional || CharacterEncoding to handle responses to the external system. Default to UTF-8.
 |-
-| RespContentType || optional || If true force the POST body to be handled as application/x-www-form-urlencoded content type. Default is false.
+| RespContentType || optional || ContentType to be declared while handling HTTP responses to the external system. Default to text/html.
 |-
-| HandlePostBodyAsParams || optional || If != -1 force the adapter to respond with the given http code on case of error. Default is -1 (disabled).
+| 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 || CharacterEncoding to be used to handle requests from external system. Default to UTF-8.
+| ResponseOnError-HTTPCode || optional || If != -1 force the adapter to respond with the given http code on case of error. Default is -1 (disabled).
 |}

@@ Line 487: / Line 487: @@
                          </ul>
                     </td>
                  </tr>
              </table>