Difference between revisions of "ExtendedInboundParamHandlerFormatter"
| Line 54: | Line 54: | ||
| − | == | + | ===RequestParam=== |
| − | This element | + | 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: | Contains the sub-elements: | ||
| Line 62: | Line 62: | ||
* [[#RequestStringParamHandler|RequestStringParamHandler]] | * [[#RequestStringParamHandler|RequestStringParamHandler]] | ||
| − | |||
| − | |||
| − | |||
The following table shows the '''RequestParam''' attributes: | The following table shows the '''RequestParam''' attributes: | ||
{|class="gvtable" | {|class="gvtable" | ||
| Line 75: | Line 72: | ||
| Type|| optional || '''Not used''' | | Type|| optional || '''Not used''' | ||
|} | |} | ||
| + | |||
| + | |||
| + | ==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: | ||
| + | * [[#RequestXMLParamHandler|RequestXMLParamHandler]] | ||
| + | * [[#RequestFlatParamHandler|RequestFlatParamHandler]] | ||
| + | * [[#RequestStringParamHandler|RequestStringParamHandler]] | ||
| 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) | 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). | 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== | |
This element contains the configuration of default values for some of all the fields of a inbound request [[GVBuffer]] object. | 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]] | * [[#GVBufferPropertyDefaultValue|GVBufferPropertyDefaultValue]] | ||
| − | + | ===GVBufferFieldDefaultValue=== | |
| − | === | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
A configured default value for a field of a [[GVBuffer]] object. | A configured default value for a field of a [[GVBuffer]] object. | ||
The following table shows the '''GVBufferFieldDefaultValue''' attributes: | The following table shows the '''GVBufferFieldDefaultValue''' attributes: | ||
| Line 245: | Line 233: | ||
|} | |} | ||
| − | ==GVBufferPropertyDefaultValue== | + | |
| + | ===GVBufferPropertyDefaultValue=== | ||
A configured default value for a property of a [[GVBuffer]] object. | A configured default value for a property of a [[GVBuffer]] object. | ||
The following table shows the '''GVBufferPropertyDefaultValue''' attributes: | 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. | | FieldValue || required || A configured default value for a property field of a [[GVBuffer]] object. | ||
|} | |} | ||
| + | |||
| + | |||
| + | ==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: | ||
| + | * RequestReply | ||
| + | * Request | ||
| + | * SendReply | ||
| + | * GetRequest | ||
| + | * GetReply | ||
| + | |} | ||
| + | |||
==GVBufferField== | ==GVBufferField== | ||
| Line 270: | Line 277: | ||
* GVBuffer.object | * GVBuffer.object | ||
|} | |} | ||
| + | |||
==GVBufferProperty== | ==GVBufferProperty== | ||
| Line 279: | Line 287: | ||
| FieldName || required || The [[GVBuffer]] property name. | | FieldName || required || The [[GVBuffer]] property name. | ||
|} | |} | ||
| + | |||
==GVBufferPropertyList== | ==GVBufferPropertyList== | ||
Revision as of 10:03, 2 August 2013
Contents
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. |
RequestParam
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:
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 |
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:
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:
|
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:
|
| 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:
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:
|
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:
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:
|
| 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. |
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:
|
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:
|
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 :
|
| 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.
