ChangeGVBuffer

From GreenVulcano Wiki
Revision as of 14:23, 5 February 2012 by Anonymous (talk) (Created page with "==Description== This {{GVESB}} element specifies a modification of a data buffer. =={{VULCON}} / {{GVCONSOLE}} Configuration== A change to a data buffer is to set one or more ...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Description

This GreenVulcano® ESB element specifies a modification of a data buffer.

VulCon / GV Console Configuration

A change to a data buffer is to set one or more fields of the buffer with configurable values, or perform some transformation on the body. You can also completely remove the body field. This option is useful to return an acknowledgment to the client without overhead to transfer the response data.

The ChangeGVBuffer Element is used by ChangeGVBufferNode, GVEndNode, ServiceCallerTask and test-service-call. Its attributes are:

  • clear-data: This attribute can be set to:
    • true: reset the body field of the buffer
    • false: do not alter the body field of the buffer. This option is useful to return an acknowledgment to the client without overhead to transfer the response data.
  • system: This attribute sets the value of system field of the buffer.
  • service: This attribute sets the value of service field of the buffer.
  • ret-code: This attribute sets the value of return code field of the buffer.
  • crypto-op: This attribute defines whether or not to use encryption and if you encrypt or decrypt the body field. Can not be defined with compress-op, scope-name, base64-op and clear-data. The attribute's admitted values are:
    • none
    • encrypt
    • decrypt
  • key-id: This attribute sets the key to use for the encryption/decryption.
  • compress-op: This attribute defines whether to use compression and if you compress or decompress the body field. Can not be defined with crypto-op, scope-name, base64-op and clear-data. The attribute's admitted values are:
    • none
    • compress
    • uncompress
  • compress-level: This attribute sets the compression ratio to use. The attribute's admitted values are:
    • best-compression
    • best-speed
    • default-compression
    • no-compression
  • base64-op: This attribute defines whether to use Base64 encoding and if you encode or decode the body field. Can not be defined with compress-op, crypto-op, scope-name and clear-data. The attribute's admitted values are:
    • none
    • encode
    • decode
  • scope-name: This attribute defines whether to use a JavaScript. If it is defined, represent the 'scope' to be used for script execution. The execution environment map is added to the scope as environment, the current input object is added to the scope as data. Can not be defined with compress-op, crypto-op, base64-op and clear-data.
  • script-file: This attribute is the name of the file containing the script to run.

It has the following subelements:


SimpleGVBufferBodyBuilder

This element allows you to set the GVBuffer body. It is used by ChangeGVBuffer.

Its attributes are:

  • type: body-builder.
  • class: it.greenvulcano.gvesb.internal.data.SimpleGVBufferBodyMaker
  • file-name: This attribute is the path of a file whose contents should be inserted into the body of GVBuffer. You can specify a file on the server's classpath using the following syntax:
    CP://filename or cp://filename
    This attribute has precedence over the element content.
  • read-once: If true the file will be read only once, otherwise the file will be read on each invocation of the service. This attribute is meaningful only if the attribute file-name is specified. Default to "true".
  • encoding: This attribute is the encoding used to convert text to byte array. The attribute's admitted values are:
    • US-ASCII
    • ISO-8859-1
    • ISO-8859-15
    • ISO-LATIN-1
    • UTF-8
    • UTF-16BE
    • UTF-16LE
    • UTF-16