Difference between revisions of "ExtendedInboundParamHandlerFormatter"

From GreenVulcano Wiki
Jump to: navigation, search
(→‎GVBufferProperty)
(→‎GVBufferPropertyList)
Line 154: Line 154:
 
                 <tr>
 
                 <tr>
 
                     <td>Value length: <b><xsl:value-of select="string-length(text())"/></b> characters</td>
 
                     <td>Value length: <b><xsl:value-of select="string-length(text())"/></b> characters</td>
 +
                </tr>
 +
            </table>
 +
        </xsl:template>
 +
</syntaxhighlight>
 +
|}
 +
 +
==RequestParams==
 +
The following table shows the '''RequestParams''' attributes:
 +
{|class="gvtable"
 +
! Attribute !! Type !! Description
 +
|-
 +
| ParamNameValueSeparator|| required|| Parameters name-value separator string within list. Possible values are : '''True''', '''False'''. Default is ';'
 +
|-
 +
| ParamEntrySeparator|| optional || Parameters entry separator string within list. Default is '='
 +
This is the template used:
 +
<syntaxhighlight lang="XML">
 +
        <xsl:template match="RequestContent">
 +
            <table cellpadding="0" cellspacing="0">
 +
                <tr>
 +
                        <td>Configured handlers:</td>
 +
                        <td width="20"></td>
 +
                        <td><b><xsl:value-of select="count(./*[@ItemType='Handler'])"/></b></td>
 
                 </tr>
 
                 </tr>
 
             </table>
 
             </table>

Revision as of 16:02, 26 July 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.


DA COMPLETARE


GreenVulcano® ESB Configuration

The GVAdapterHttpConfiguration Element is used by: GVAdapters.

The following table shows the ExtendedInboundParamHandlerFormatter attributes:

Attribute Type Description
type fixed This attribute must keep the value FormatterPlugin.
class fixed Module Id always 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.
read-request-header optional CharacterEncoding to be used to handle requests from external system. Default to UTF-8.
ReqCharacterEncoding optional CharacterEncoding to handle responses to the external system. Default to UTF-8.
RespCharacterEncoding optional ContentType to be declared while handling HTTP responses to the external system. Default to text/html.
RespContentType optional If true force the POST body to be handled as application/x-www-form-urlencoded content type. Default is false.
HandlePostBodyAsParams optional If != -1 force the adapter to respond with the given http code on case of error. Default is -1 (disabled).
ResponseOnError-HTTPCode optional CharacterEncoding to be used to handle requests from external system. Default to UTF-8.

Template to follow: 

        <xsl:template match="GVBufferFieldDefaultValue">
            <table cellpadding="0" cellspacing="0">
                <tr>
                    <td>Field name:  <i><xsl:value-of select="@FieldName"/></i></td>
                </tr>
                <tr>
                    <td>Field value:  <i><xsl:value-of select="@FieldValue"/></i></td>
                </tr>
            </table>
        </xsl:template>

Contains the sub-elements GVBufferFieldDefaultValue.

Contains the sub-elements GVBufferPropertyDefaultValue.

Contains the sub-elements GVBufferField.

GVBufferFieldDefaultValue

The following table shows the GVBufferFieldDefaultValue attributes:

Attribute Type Description
FieldName required The configured default value of an GVBuffer field. Cannot be left blank.
FieldValue required A configured default value for a property field of an GVBuffer object.

GVBufferPropertyDefaultValue

The name of an GVBuffer extended field. The following table shows the GVBufferPropertyDefaultValue attributes:

Attribute Type Description
FieldName required This element represents a mapping target from/to a property field of an GVBuffer object.
FieldValue required This element represents a mapping target from/to a field of an GVBuffer object.

Template to follow: 

        <xsl:template match="GVBufferPropertyDefaultValue">
            <table cellpadding="0" cellspacing="0">
                <tr>
                    <td>Extended field name:  <i><xsl:value-of select="@FieldName"/></i></td>
                </tr>
                <tr>
                    <td>Extended field value:  <i><xsl:value-of select="@FieldValue"/></i></td>
                </tr>
            </table>
        </xsl:template>

GVBufferField

The name of a field of an GVBuffer object. The following table shows the GVBufferField attributes:

Attribute Type Description
FieldName required The configured default value of an GVBuffer extended field. Cannot be left blank.

Template to follow: 

        <xsl:template match="GVBufferProperty">
            <table cellpadding="0" cellspacing="0">
                 <tr>
                    <td>Extended field name: <b><xsl:value-of select="@FieldName"/></b></td>
                </tr>
            </table>
        </xsl:template>

GVBufferProperty

The name of a field of an GVBuffer object. The following table shows the GVBufferProperty attributes:

Attribute Type Description
FieldName required This element represents a plain text value to be assigned as source/target of an handler mapping.

Template to follow: 

        <xsl:template match="DefaultValue">
            <table cellpadding="0" cellspacing="0">
                 <tr>
                    <td>Value length: <b><xsl:value-of select="string-length(text())"/></b> characters</td>
                </tr>
            </table>
        </xsl:template>

This element represents a mapping target from/to a list of extended field of an GVBuffer object. Template to follow 

        <xsl:template match="GVBufferPropertyList">
            <table cellpadding="0" cellspacing="0">
                 <tr>
                    <td>Excluded Extended fields names: <b><xsl:value-of select="@ExcludeFields"/></b></td>
                </tr>
            </table>
        </xsl:template>

GVBufferPropertyList

The following table shows the GVBufferPropertyList attributes:

Attribute Type Description
URLEncoding required Parameters name-value separator string within list. Possible values are : True, False. Default is ';'
FieldNameValueSeparator optional Parameters entry separator string within list. Default is '='
FieldEntrySeparator optional The comma separated list of extended fields names to ignore.
ExcludeFields required This element represents a plain text value to be assigned as source/target of an handler mapping.

This is the template used: 

        <xsl:template match="DefaultValue">
            <table cellpadding="0" cellspacing="0">
                 <tr>
                    <td>Value length: <b><xsl:value-of select="string-length(text())"/></b> characters</td>
                </tr>
            </table>
        </xsl:template>

RequestParams

The following table shows the RequestParams attributes:

Attribute Type Description
ParamNameValueSeparator required Parameters name-value separator string within list. Possible values are : True, False. Default is ';'
ParamEntrySeparator optional Parameters entry separator string within list. Default is '='

This is the template used: 

        <xsl:template match="RequestContent">
            <table cellpadding="0" cellspacing="0">
                 <tr>
                        <td>Configured handlers:</td>
                        <td width="20"></td>
                        <td><b><xsl:value-of select="count(./*[@ItemType='Handler'])"/></b></td>
                </tr>
            </table>
        </xsl:template>
Retrieved from "https://gvwiki.greenvulcano.com/gvwiki/index.php?title=ExtendedInboundParamHandlerFormatter&oldid=4073"