Difference between revisions of "Http-call"
(→{{VULCON}} / {{GVCONSOLE}} Configuration) |
(→endpoint) |
||
| (2 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
==Description== | ==Description== | ||
| − | The {{GVESB}} http-call [[plugins | plug-in]] allows the data exchange through the [http://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol HTTP protocol] | + | The {{GVESB}} http-call [[plugins | plug-in]] allows the data exchange through the [http://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol HTTP protocol]. |
=={{VULCON}} / {{GVCONSOLE}} Configuration== | =={{VULCON}} / {{GVCONSOLE}} Configuration== | ||
| Line 39: | Line 39: | ||
| custom-protocol || optional || Can be one of those defined locally for this 'http-call', or globally in {{GVESB}} on [[GVSupport]] configuration. | | custom-protocol || optional || Can be one of those defined locally for this 'http-call', or globally in {{GVESB}} on [[GVSupport]] configuration. | ||
|} | |} | ||
| + | |||
| + | <div class="version_ge3.4/3.3.4"> | ||
| + | {|class="gvtable" | ||
| + | ! Attribute !! Type !! Description | ||
| + | |- | ||
| + | | conn-timeout || optional || Defines the connection timeout, in ms. Default to 10000ms. | ||
| + | |- | ||
| + | | so-timeout || optional || Defines the timeout to wait for a server response, in ms. Default to 30000ms. | ||
| + | |} | ||
| + | </div> | ||
| + | <div class="version_ge3.4"> | ||
| + | {|class="gvtable" | ||
| + | ! Attribute !! Type !! Description | ||
| + | |- | ||
| + | | context-path || optional || Optional context path to prepend to remote URI call. | ||
| + | |} | ||
| + | </div> | ||
| + | |||
It has the subelements: | It has the subelements: | ||
| Line 44: | Line 62: | ||
* [[#CustomProtocol|CustomProtocol]] | * [[#CustomProtocol|CustomProtocol]] | ||
* [[Proxy]] | * [[Proxy]] | ||
| + | <div class="version_ge3.4"> | ||
| + | * [[BasicHttpAuth]] | ||
| + | * [[NTLMHttpAuth]] | ||
| + | </div> | ||
====CustomProtocol==== | ====CustomProtocol==== | ||
| Line 96: | Line 118: | ||
===method=== | ===method=== | ||
| − | Method to | + | Method to invoke on the server. |
Its attributes are: | Its attributes are: | ||
| Line 114: | Line 136: | ||
| ref-dp || optional || Name of [[Data provider]] to use to prepare the request. | | ref-dp || optional || Name of [[Data provider]] to use to prepare the request. | ||
|} | |} | ||
| + | |||
| + | <div class="version_ge3.3.3"> | ||
| + | {|class="gvtable" | ||
| + | ! Attribute !! Type !! Description | ||
| + | |- | ||
| + | | uri-escaped || optional || If true the request-uri is already escaped, if false (WARNING!!!) the uri is escaped by the plug-in. | ||
| + | Default to true. | ||
| + | |} | ||
| + | </div> | ||
Latest revision as of 11:04, 31 December 2014
Contents
Description
The GreenVulcano® ESB http-call plug-in allows the data exchange through the HTTP protocol.
VulCon / GV Console Configuration
Use the HTTP VCL plugin if you want to call HTTP methods on remote servers.
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 sub-elements:
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. |
| Attribute | Type | Description |
|---|---|---|
| conn-timeout | optional | Defines the connection timeout, in ms. Default to 10000ms. |
| so-timeout | optional | Defines the timeout to wait for a server response, in ms. Default to 30000ms. |
| Attribute | Type | Description |
|---|---|---|
| context-path | optional | Optional context path to prepend to remote URI call. |
It has the subelements:
CustomProtocol
This element represents the custom protocol handler configuration. Refer to HttpClient documentation for further info: http://hc.apache.org/httpclient-3.x/sslguide.html
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:
constructor-args
Contains 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. It has the attributes:
| Attribute | Type | Description |
|---|---|---|
| type | required | Parameter type. Only simple java types are supported. The attribute's admitted values are:
|
| value | optional | Parameter value. Do not specify the value of this parameter if null should be passed. #Encrypted. The attribute's admitted values are:
|
method
Method to invoke on the server.
Its attributes are:
| Attribute | Type | Description |
|---|---|---|
| name | required | Method name. The attribute's admitted values are:
|
| request-uri | required | Request URI. Can contain placeholders. |
| ref-dp | optional | Name of Data provider to use to prepare the request. |
| Attribute | Type | Description |
|---|---|---|
| uri-escaped | optional | If true the request-uri is already escaped, if false (WARNING!!!) the uri is escaped by the plug-in.
Default to true. |
