Difference between revisions of "GVWebServices"

From GreenVulcano Wiki
Jump to: navigation, search
(Created page with "==Description== The element GVWebServices allows to define the Web Services implemented by {{GVESB}}. =={{VULCON}} / {{GVCONSOLE}} Configuration== The GVWebServices Elemen...")
 
Line 35: Line 35:
 
====GreenVulcanoWebService====
 
====GreenVulcanoWebService====
  
−
The key that identifies the service is given either by the field id-key, or by the triple system/service/operation:
+
The key that identifies the service is given either by the field id-key, or by the triple [[system]]/[[service]]/[[operation]]:
 
* If this key is not satisfied we will use the default inputObjectDataProviders and outputObjectDataProviders  
 
* If this key is not satisfied we will use the default inputObjectDataProviders and outputObjectDataProviders  
 
* If the defaults are not defined an exception will be thrown.
 
* If the defaults are not defined an exception will be thrown.
Line 58: Line 58:
 
* SendReply
 
* SendReply
 
|}
 
|}
 +
 +
===BusinessWebServices===
 +
 +
Business web services definition on Axis2.
 +
 +
The following table shows the BusinessWebServices element's attributes:
 +
{|class="gvtable"
 +
! Attribute !! Type !! Description
 +
|-
 +
| wsdl-directory || required || Directory containing the generated WSDL for the services exposed through Axis2.
 +
|-
 +
| services-directory || required || Directory containing the services generated from a WSDL using Axis2.
 +
|-
 +
| authenticated-http-soap-address || optional || This is the default URL that is used to build the soap:
 +
address for [[web services]] that require authentication exposed with http protocol.
 +
This URL can be overridden on different services.
 +
If not specified will be required to define it on the services.
 +
The final URL will be formed by concatenating the name of the service: default-soap-address/service
 +
|-
 +
| authenticated-https-soap-address || optional || This is the default URL that is used in the build the soap:address for web services that require authentication exposed with https protocol.
 +
This URL can be overridden on different services.
 +
If not specified will be required to define it on the services.
 +
The final URL will be formed by concatenating the name of the service: default-soap-address/service
 +
|-
 +
| http-soap-address || optional || This is the default URL that is used in the build the soap:address for web services that not require authentication exposed with http protocol.
 +
This URL can be overridden on different services.
 +
If not specified will be required to define it on the services.
 +
The final URL will be formed by concatenating the name of the service: default-soap-address/service
 +
|-
 +
| https-soap-address || optional || This is the default URL that is used in the build the soap:address for web services that not require authentication exposed with https protocol.
 +
This URL can be overridden on different services.
 +
If not specified will be required to define it on the services.
 +
The final URL will be formed by concatenating the name of the service: default-soap-address/service
 +
|}
 +
 +
Its subelements are:
 +
* Description
 +
* WebService
 +
 +
====WebService====
 +
 +
Definition of business web services.
 +
 +
The following table shows the WebService element's attributes:
 +
{|class="gvtable"
 +
! Attribute !! Type !! Description
 +
|-
 +
| web-service || required || The attribute's value can't be null.
 +
|-
 +
| force-https || optional || The attribute's admitted values are:
 +
* true
 +
* false
 +
|-
 +
| soap-address || optional || Il soap:address will be exactly the here specified url.
 +
As a difference with the default-soap-address, it won't be made any composition with the service name.
 +
If default-soap-address is not specified, this is mandatory.
 +
The attribute's value can't be null.
 +
|-
 +
| input-xsd || optional || The path of the XSD that defines the types of input that will be declared in the generated WSDL.
 +
May contain an absolute path or a relative path, in which case, is relative to <nowiki>${{gv.app.home}}/xmlconfig/xsds.</nowiki>
 +
May contain [[placeholders]]. May also include the types of output, in this case does not specify the parameter 'output-xsd'.
 +
The attribute's value can't be null.
 +
|-
 +
| output-xsd || optional || The path of the XSD that defines the types of output that will be declared in the generated WSDL.
 +
May contain an absolute path or a relative path, in which case, is relative to <nowiki>${{gv.app.home}}/xsds.</nowiki>
 +
If not specified only the parameter 'input-xsd' will be used.
 +
The attribute's value can't be null.
 +
|-
 +
| targetNS-from-xsd || optional || Defines if the target namespace of the types in the WSDL shall be that specified in the XSD input. If "false", the target namespace is: http://www.greenvulcano.it/greenvulcano
 +
The attribute's admitted values are:
 +
* true
 +
* false
 +
|-
 +
| useOriginalwsdl || optional || The attribute's admitted values are:
 +
* true
 +
* false
 +
|}
 +
 +
Its subelements are:
 +
* Description
 +
* WSOperation
 +
* Transport
 +
* EngageModule

Revision as of 23:17, 12 February 2012

Description

The element GVWebServices allows to define the Web Services implemented by GreenVulcano® ESB.

VulCon / GV Console Configuration

The GVWebServices Element is present in the VulCon Adapter view, as a GVAdapters subelement.

The following table shows GVWebServices the element's attributes:

Attribute Type Description
version fixed This attribute must assume the value 1.0.
type fixed This attribute must assume the value module.
name fixed This attribute must assume the value WEB_SERVICES.

Its subelements are:

  • Description
  • GreenVulcanoWebServices
  • BusinessWebServices
  • UDDI
  • AxisExtra

GreenVulcanoWebServices

This element represents the GreenVulcano® ESB Web Services definition.

Its subelements are:

  • Description
  • GreenVulcanoWebService

GreenVulcanoWebService

The key that identifies the service is given either by the field id-key, or by the triple system/service/operation:

  • If this key is not satisfied we will use the default inputObjectDataProviders and outputObjectDataProviders
  • If the defaults are not defined an exception will be thrown.

The following table shows the GreenVulcanoWebService element's attributes:

Attribute Type Description
type fixed This attribute must assume the value greenvulcanowebservice.
id-key optional The attribute's value can't be null.
id-service optional Service
id-system optional System
id-primitive required Primitive to invoke. The attribute's admitted values are:
  • Request
  • RequestReply
  • GetReply
  • GetRequest
  • SendReply

BusinessWebServices

Business web services definition on Axis2.

The following table shows the BusinessWebServices element's attributes:

Attribute Type Description
wsdl-directory required Directory containing the generated WSDL for the services exposed through Axis2.
services-directory required Directory containing the services generated from a WSDL using Axis2.
authenticated-http-soap-address optional This is the default URL that is used to build the soap:

address for web services that require authentication exposed with http protocol. This URL can be overridden on different services. If not specified will be required to define it on the services. The final URL will be formed by concatenating the name of the service: default-soap-address/service

authenticated-https-soap-address optional This is the default URL that is used in the build the soap:address for web services that require authentication exposed with https protocol.

This URL can be overridden on different services. If not specified will be required to define it on the services. The final URL will be formed by concatenating the name of the service: default-soap-address/service

http-soap-address optional This is the default URL that is used in the build the soap:address for web services that not require authentication exposed with http protocol.

This URL can be overridden on different services. If not specified will be required to define it on the services. The final URL will be formed by concatenating the name of the service: default-soap-address/service

https-soap-address optional This is the default URL that is used in the build the soap:address for web services that not require authentication exposed with https protocol.

This URL can be overridden on different services. If not specified will be required to define it on the services. The final URL will be formed by concatenating the name of the service: default-soap-address/service

Its subelements are:

  • Description
  • WebService

WebService

Definition of business web services.

The following table shows the WebService element's attributes:

Attribute Type Description
web-service required The attribute's value can't be null.
force-https optional The attribute's admitted values are:
  • true
  • false
soap-address optional Il soap:address will be exactly the here specified url.

As a difference with the default-soap-address, it won't be made any composition with the service name. If default-soap-address is not specified, this is mandatory. The attribute's value can't be null.

input-xsd optional The path of the XSD that defines the types of input that will be declared in the generated WSDL.

May contain an absolute path or a relative path, in which case, is relative to ${{gv.app.home}}/xmlconfig/xsds. May contain placeholders. May also include the types of output, in this case does not specify the parameter 'output-xsd'. The attribute's value can't be null.

output-xsd optional The path of the XSD that defines the types of output that will be declared in the generated WSDL.

May contain an absolute path or a relative path, in which case, is relative to ${{gv.app.home}}/xsds. If not specified only the parameter 'input-xsd' will be used. The attribute's value can't be null.

targetNS-from-xsd optional Defines if the target namespace of the types in the WSDL shall be that specified in the XSD input. If "false", the target namespace is: http://www.greenvulcano.it/greenvulcano

The attribute's admitted values are:

  • true
  • false
useOriginalwsdl optional The attribute's admitted values are:
  • true
  • false

Its subelements are:

  • Description
  • WSOperation
  • Transport
  • EngageModule
Retrieved from "https://gvwiki.greenvulcano.com/gvwiki/index.php?title=GVWebServices&oldid=2102"