Difference between revisions of "Http-call"

From GreenVulcano Wiki
Jump to: navigation, search
(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...")
 
Line 1: Line 1:
 
==Description==
 
==Description==
  
−
HTTP VCL plugin to call HTTP methods on remote servers.
+
This {{GVESB}} element is the HTTP VCL plugin to call HTTP methods on remote servers.
  
 
=={{VULCON}} / {{GVCONSOLE}} Configuration==
 
=={{VULCON}} / {{GVCONSOLE}} Configuration==
  
 
The http-call Element is used by: [[Channel]] and [[routed-call]]. Its attributes are:
 
The http-call Element is used by: [[Channel]] and [[routed-call]]. Its attributes are:
−
* ''type'': call.
+
{|class="gvtable"
−
* ''class'': it.greenvulcano.gvesb.virtual.http.HTTPCallOperation.
+
! Attribute !! Type !! Description
−
* ''name'': Operation name. Used in the [[Flow]] section to associate workflow nodes to VCL operations.
+
|-
 +
| type || fixed || This attribute must assume the value '''call'''.
 +
|-
 +
| class || fixed || This attribute must assume the value '''it.greenvulcano.gvesb.virtual.http.HTTPCallOperation'''.
 +
| name || required || Operation name. Used in the [[Flow]] section to associate workflow nodes to VCL operations.
 +
|}
  
−
its subelements are:
+
Might contain the following subelements:
 
* Description
 
* Description
 
* endpoint
 
* endpoint
 
* method
 
* method
−
 
  
 
===endpoint===
 
===endpoint===
Line 21: Line 25:
  
 
The endpoint Element is used by: http-call. Its attributes are:
 
The endpoint Element is used by: http-call. Its attributes are:
−
* ''host'': Host to connect to.
+
{|class="gvtable"
−
* ''port'': Port where the service is exposed. Default port is '80'.
+
! Attribute !! Type !! Description
−
* ''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 {{GVESB}} on {{GVSupport}} configuration.
+
| host || required || Host to connect to.
 +
|-
 +
| port || optional || Port where the service is exposed. Default port is '80'.
 +
|-
 +
| secure || optional || 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 || optional || Can be one of those defined locally for this 'http-call', or globally in {{GVESB}} on GVSupport configuration.
 +
|}
  
 
It has the subelements:
 
It has the subelements:
Line 37: Line 48:
 
The CustomProtocol Element is used by: endpoint.
 
The CustomProtocol Element is used by: endpoint.
 
Its attributes are:
 
Its attributes are:
−
* ''name'': Name identifier for this protocol.
+
{|class="gvtable"
−
* ''protocol-scheme'': The URI protocol scheme (http, https, etc.).
+
! Attribute !! Type !! Description
−
* ''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
+
|-
 +
| name || required || Name identifier for this protocol.
 +
|-
 +
| protocol-scheme || required || The URI protocol scheme (http, https, etc.).
 +
|-
 +
| protocol-socket-factory || required || 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.
 
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.
+
| protocol-default-port || required || The default port number for this custom protocol.
 +
|-
 +
| protocol-virtual-scheme || optional || 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:
 
Its subelements are:
 
* Description
 
* Description
−
* constructor-args
+
* constructor-args: containing more '''constructor-param''' items where you can specify the constructor arguments, if your protocol socket factory class does not have a default constructor.
  
−
=====constructor-args=====
+
=====constructor-param=====
  
−
You can specify constructor arguments here, if your protocol socket factory class does not have a default constructor.
+
The constructor-param Element is a constructor parameter that has the attributes:
−
The constructor-args Element is used by CustomProtocol and contains the subelements:
+
{|class="gvtable"
−
* Description
+
! Attribute !! Type !! 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:
+
| type || required || Parameter type. Only simple java types are supported. The attribute's admitted values are:
−
*** byte
+
* byte
−
*** boolean
+
* boolean
−
*** char
+
* char
−
*** double
+
* double
−
*** float
+
* float
−
*** int
+
* int
−
*** long
+
* long
−
*** short
+
* short
−
*** String
+
* 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
+
| value || optional || Parameter value. Do not specify the value of this parameter if null should be passed. #Encrypted. The attribute's admitted values are:
−
*** false
+
* true
 +
* false
 +
|}
  
 
===method===
 
===method===
Line 73: Line 94:
  
 
Its attributes are:
 
Its attributes are:
−
* ''name'': Method name. The attribute's admitted values are:
+
{|class="gvtable"
−
** OPTIONS
+
! Attribute !! Type !! Description
−
** GET
+
|-
−
** HEAD
+
| name || required || Method name. The attribute's admitted values are:
−
** POST
+
* OPTIONS
−
** PUT
+
* GET
−
** DELETE
+
* HEAD
−
* ''request-uri'': Request URI. Can contain placeholders.
+
* POST
−
* ''ref-dp'': Name of Data Provider to use to prepare the request.
+
* PUT
 +
* DELETE
 +
|-
 +
| request-uri || required || Request URI. Can contain placeholders.
 +
|-
 +
| ref-dp || optional || Name of [[Data Provider]] to use to prepare the request.
 +
|}

Revision as of 10:31, 9 February 2012

Description

This GreenVulcano® ESB element is the 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:

Attribute Type Description
type fixed This attribute must assume the value call.
class fixed This attribute must assume the value it.greenvulcano.gvesb.virtual.http.HTTPCallOperation. name required Operation name. Used in the Flow section to associate workflow nodes to VCL operations.

Might contain the following subelements:

  • Description
  • endpoint
  • method

endpoint

Endpoint configuration to connect to the server.

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

Attribute Type Description
host required Host to connect to.
port optional Port where the service is exposed. Default port is '80'.
secure optional 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 optional Can be one of those defined locally for this 'http-call', or globally in GreenVulcano® ESB on 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:

Attribute Type Description
name required Name identifier for this protocol.
protocol-scheme required The URI protocol scheme (http, https, etc.).
protocol-socket-factory required 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 required The default port number for this custom protocol.
protocol-virtual-scheme optional 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: containing more constructor-param items where you can specify the constructor arguments, if your protocol socket factory class does not have a default constructor.
constructor-param

The constructor-param Element is a constructor parameter that has the attributes:

Attribute Type Description
type required Parameter type. Only simple java types are supported. The attribute's admitted values are:
  • byte
  • boolean
  • char
  • double
  • float
  • int
  • long
  • short
  • String
value optional 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:

Attribute Type Description
name required Method name. The attribute's admitted values are:
  • OPTIONS
  • GET
  • HEAD
  • POST
  • PUT
  • DELETE
request-uri required Request URI. Can contain placeholders.
ref-dp optional Name of Data Provider to use to prepare the request.
Retrieved from "https://gvwiki.greenvulcano.com/gvwiki/index.php?title=Http-call&oldid=1667"