Http-call

From GreenVulcano Wiki
Revision as of 16:50, 3 February 2012 by Anonymous (talk) (Created page with "==Description== HTTP VCL plugin to call HTTP methods on remote servers. =={{VULCON}} / {{GVCONSOLE}} Configuration== The http-call Element is used by: Channel and [[routed...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Description

HTTP VCL plugin to call HTTP methods on remote servers.

VulCon / GV Console Configuration

The http-call Element is used by: Channel and routed-call. Its attributes are:

  • type: call.
  • class: it.greenvulcano.gvesb.virtual.http.HTTPCallOperation.
  • name: Operation name. Used in the Flow section to associate workflow nodes to VCL operations.

its subelements are:

  • Description
  • endpoint
  • method


endpoint

Endpoint configuration to connect to the server.

The endpoint Element is used by: http-call. Its attributes are:

  • host: Host to connect to.
  • port: Port where the service is exposed. Default port is '80'.
  • secure: Defines if the endpoint connection is secure or not. If secure is 'true', the default connection protocol will be 'http'; otherwise, the default connection protocol will be 'https'. The default value is 'false'.
  • custom-protocol: Can be one of those defined locally for this 'http-call', or globally in GreenVulcano® ESB on Template:GVSupport configuration.

It has the subelements:

  • Description
  • CustomProtocol
  • Proxy

CustomProtocol

This element represents the custom protocol handler configuration. Referes to HttpClient documentation for further info: [1]

The CustomProtocol Element is used by: endpoint. Its attributes are:

  • name: Name identifier for this protocol.
  • protocol-scheme: The URI protocol scheme (http, https, etc.).
  • protocol-socket-factory: The custom socket factory class, implementation of class org.apache.commons.httpclient.protocol.ProtocolSocketFactory. If this class do not have a default constructor, you can

specify constructor arguments using constructor-args element.

  • protocol-default-port: The default port number for this custom protocol.
  • protocol-virtual-scheme: You can specify this parameter to use your own custom protocol designator as well as the default protocol implementation, specified by protocol-scheme attribute.

Its subelements are:

  • Description
  • constructor-args
constructor-args

You can specify constructor arguments here, if your protocol socket factory class does not have a default constructor. The constructor-args Element is used by CustomProtocol and contains the subelements:

  • Description
  • constructor-param: A constructor parameter that has the attributes:
    • type: Parameter type. Only simple java types are supported. The attribute's admitted values are:
      • byte
      • boolean
      • char
      • double
      • float
      • int
      • long
      • short
      • String
    • value: Parameter value. Do not specify the value of this parameter if null should be passed. #Encrypted. The attribute's admitted values are:
      • true
      • false

method

Method to execute to the server. It is used by: http-call.

Its attributes are:

  • name: Method name. The attribute's admitted values are:
    • OPTIONS
    • GET
    • HEAD
    • POST
    • PUT
    • DELETE
  • request-uri: Request URI. Can contain placeholders.
  • ref-dp: Name of Data Provider to use to prepare the request.