IntroductionThe Petals ESB "WS API" is an extension providing a web service API to interact with a Petals ESB container. Several services are provided by this API:
|
Table of contents
Contributors
No contributors found for: authors on selected page(s)
|
Installation
This extension is embedded into the ZIP archive and automatically install when installing Petals ESB using this archive.
This extension is also available as a Debian package, see "Installing Petals ESB using the Debian packages" to install the package "petals-esb-wsapi", and requires the extension Petals ESB "Artifact Repository".
Using the Petals ESB WS API
To use the WS API, just open your favorite web service client UI and give it the URL of the WSDL of the service you want invoke. The WSDL URL template is: http://<host>:<port>/<context>/<service>?wsdl, where:
- <host> is the IP adress of the Petals ESB container you want to join,
- <port> is the TCP port on which the WS API is listenning,
- <context> is the URL path of the WS API,
- <service> is the name of the service you want to invoke. See below to known the available values.
Available services
ArtifactRepositoryService
TODO
DeploymentService
TODO
DragonConnectionService
TODO
EndpointService
TODO
InformationService
This service provides several information on the Petals ESB container:
- the local time of the container,
- the container type,
- the version of the container.
InstallationService
TODO
JBIArtefactsService
TODO
RuntimeService
TODO
ServiceAssemblyStateService
TODO
TopologyService
TODO
Configuration
Runtime configuration parameters
Configuration parameters of the Petals ESB WS API are available into the container local configuration (ie. into the file server.properties:
|| Parameter/Property name || Default value || Description ||
| petals.ws-api | true | Flag enabling/disabling the autoloader |
Logging configuration parameters
The Petals ESB WS API uses the following loggers to trace its execution:
- Petals.Extensions.WsApi: The root logger of the Petals ESB WS API,
- Petals.Extensions.WsApi.WebServiceManager: The logger of the WS API manager,
- Petals.Extensions.WsApi.ArtifactRepositoryService: The logger of the service ArtifactRepositoryService,
- Petals.Extensions.WsApi.DeploymentService: The logger of the service DeploymentService,
- Petals.Extensions.WsApi.DragonConnectionService: The logger of the service DragonConnectionService,
- Petals.Extensions.WsApi.EndpointService: The logger of the service EndpointService,
- Petals.Extensions.WsApi.InstallationService: The logger of the service InstallationService,
- Petals.Extensions.WsApi.JBIArtefactsService: The logger of the service JBIArtefactsService,
- Petals.Extensions.WsApi.RuntimeService: The logger of the service RuntimeService,
- Petals.Extensions.WsApi.ServiceAssemblyStateService: The logger of the service ServiceAssemblyStateService,
- Petals.Extensions.WsApi.TopologyService: The logger of the service TopologyService.
As the Petals ESB WS API is provided into the ZIP Archive of Petals ESB, its logging configuration is already configured. If you install this extension through Debian or RPM package, just add something like the following lines to your loggers.properties:
Petals.Extensions.WsApi.level=FINEST #Petals.Extensions.WsApi.WebServiceManager.level=FINEST #Petals.Extensions.WsApi.ArtifactRepositoryService.level=FINEST #Petals.Extensions.WsApi.DeploymentService.level=FINEST #Petals.Extensions.WsApi.DragonConnectionService.level=FINEST #Petals.Extensions.WsApi.EndpointService.level=FINEST #Petals.Extensions.WsApi.InformationService.level=FINEST #Petals.Extensions.WsApi.InstallationService.level=FINEST #Petals.Extensions.WsApi.JBIArtefactsService.level=FINEST #Petals.Extensions.WsApi.RuntimeService.level=FINEST #Petals.Extensions.WsApi.ServiceAssemblyStateService.level=FINEST #Petals.Extensions.WsApi.TopologyService.level=FINEST