h2. Deploy a FTP Service Unit
*Install and Deploy BC-FTP:*
# [Download Petals-BC-FTP|http://doc.petalslink.com/x/t4KK] .
# Deploy BC-FTP in Petals ESB.
*Configure and deploy a FTP Service-Unit for* *[ftp.petalslink.com|ftp.petalslink.com]**:*
# Start Petals ESB.
# Launch Petals Studio.
# File => New => Service Unit Project: Service Unit - Select the kind of service to create.
# Select: Provide / FTP / Current_Version => Next: FTP Service-Unit - Defines the JBI properties of the service to import.
## *Service Name*: FtpTutorial
# Next => Next: FTP Service-Unit - Define the specific properties for this version of the component.
{note}<folder> attribute is written as optionnal in Studio, but it is not. It will be optional in BC-FTP v3, so as soon as it is published, you will not need to specify the folder attribute for the tutorial.{note}
## *Server*: ftp.petalslink.com
## *Port*: 21
## *User*: petals
## *Password*: demo
## *Folder*: /
## *Transfer Type*: auto
## *Connection Mode*: active
# Finish.
# Look the generated _jbi.xml_ component configuration. It should look like:
{code:lang=xml|title=jbi.xml}<jbi:provides
interface-name="generatedNs:FtpInterface"
service-name="generatedNs:FtpTutorial"
endpoint-name="FtpTutorialEndpoint">
<\!-\- CDK specific elements -->
<petalsCDK:timeout>30000</petalsCDK:timeout>
<petalsCDK:validate-wsdl>true</petalsCDK:validate-wsdl>
<petalsCDK:forward-security-subject>false</petalsCDK:forward-security-subject>
<petalsCDK:forward-message-properties>false</petalsCDK:forward-message-properties>
<petalsCDK:forward-attachments>false</petalsCDK:forward-attachments>
<petalsCDK:wsdl>FtpService.wsdl</petalsCDK:wsdl>
<\!-\- Component specific elements -->
<ftp:server>ftp.petalslink.com</ftp:server>
<ftp:port>21</ftp:port>
<ftp:user>petals</ftp:user>
<ftp:password>demo</ftp:password>
<ftp:folder>/</ftp:folder>
<ftp:transfer-type>auto</ftp:transfer-type>
<ftp:connection-mode>active</ftp:connection-mode>
</jbi:provides>{code}
# Look the generated _FtpService.wsdl_ sources. Operations available on service are described here.
# On the left "Petals projects" tree, right click on the Service-Unit Project "_su-FtpTutorial-provide_" => Petals => Fast Export for Petals.
{note:title=Known bug for Studio v1.1.0 !}Please check jbi.xml and FtpService. There is a bug sometimes (on Windows 7).
"interface-name" attribute in _jbi.xml_ and "portType name" in the WSDL should have the same value. If not, please correct _FtpService.wsdl_ :
# SELECT:
<wsdl:portType name="Ftp">
# REPLACE BY:
<wsdl:portType name="FtpInterface">
This is a known bug in Petals Studio 1.1.0. It might be corrected in version 1.1.1.{note}
# Drop the generated _sa-FTP-FtpTutorial-provide.zip_ to ./_petals-platform-xxx/install/_ folder to deploy it.
# Check Petals ESB traces to be sure the SA was deployed successfully.
h2. Test and monitor in Webconsole
*Send test DIR Operation on root folder:*
# Start the Webconsole
# Server:0 => Test panel => Send
# Select:
## Endpoint: FtpTutorialEndpoint
## Operation: dir
## MEP: InOut
# Submit
The response message should list files on the Ftp.
*Monitor services:*
# In Webconsole, go to tab: Monitoring / Server Monitoring.
# Check "Filter endpoint".
# Select Endpoint: FtpTutorialEndpoint.
{info} You can also create filters based on Interface name, Service Name or Operation Name. This is useful for example if one service is duplicated on multiple endpoints.{info}
# Submit. FtpTutorial is now listed in exchange filters.
# Activate monitoring on FtpTutorialEndpointby clicking the small icon in the "Monitoring" column.
# Send a few test messages from the test panel.
# Go in tab: Monitoring/Filter Monitoring.
!Webconsole-monitoring.png|thumbnail,border=1!
_Screenshot: Message exchange monitoring_
*Change destination folder:*
# Got to [ftp://ftp.petalslink.com] in your web or ftp browser, using previous login. You see there is an "Integration" folder. Let's go there.
# Go to Petals Studio.
# Edit FtpTutorial _jbi.xml._
# Change <folder>/</folder> to <folder>Integration</folder>.
*Redeploy the component:*
# Go in Webconsole / Server:0 / Administration / Service-Assemblies.
# Uninstall the previous FtpTutorial SA (Stop=>Shutdown=>Uninstall).
{info}As for installing, you can use three methods:
* Webconsole. Stop=>Shutdown=>Uninstall (alternatives if needed: "force undeploy" or "clear all")
* Autoloader: Remove the corresponding .ZIP package from _./petals-platform-xxx/installed/_
* Command Line: _hu_ or _hotundeploy_. Ex: _"hu sa-FTP-FtpTutorial-provide.zip{_}_"._
{info}
# Go in Petals Studio => _"Fast export for Petals"_ on the FTP SU.
# Drop the newly generated _sa-FTP-FtpTutorial-provide.zip_ from Eclipse to _./petals-platform-xxx/install/_
# Check in Petals ESB traces that the new SA was deployed sucessfully.
# Test by calling DIR operation ob Webconsole.
{info:title=Want to go further?}Try reading the files you listed. Look at the BC-FTP Documentation and go on your own. (note that your ftp session is read-only, if you want to call writing operations, create your own ftp server).{info}
h2. Expose the FTP service over SOAP
Before, we used SOAP to import WSDL to create services inside Petals ESB. Meaning _Provide_ a SOAP service inside the bus.
Now we will do the contrary : A service (FTP) exists inside the bus, we want to deploy it outside. The new SOAP service will _Consume_ the existing FtpTutorial. Then the goal of SOAP-consume is to expose as SOAP outside of the bus.
*Expose a SOAP-Consume of FtpTutorial:*
# Petals Studio => File => New => Service Unit Project.
# Select: Consume / SOAP / Current_SOAP_Version.
# Next: SOAP Service-Unit - You have to provide the namespace.
# Clic "Select a service" => "FtpTutorial implements FtpInterface @ FtpTutorialEndpoint" => OK: Fields are automatically completed.
# Next: Define the project name and location.
# Next: Define the specific properties for this version of the component.
## *Service Name*: SoapFtpTutorial
# Next: Define the CDK properties.
# Finish.
# Export and deploy in Petals ESB.
h2. Test with SOAP UI
*Install SOAP UI*:
[Download SOAPUI|http://www.soapui.org/] and install it. SOAP UI is a client to send and receive messages with SOAP protocol.
*Find the WSDL URL:*
# You just deployed _sa-SOAP-FtpTutorial-consume_. Look at Petals ESB traces. Among the last messages, find one similar to the one following. And find the root URL, here "http://127.0.0.1:8084".
{code}[Petals.Container.Components.petals-bc-soap]-INFO 2010-10-06 15:26:22,032 The Axis2 service 'SoapFtpTutorial' has been registered and is available at 'http://127.0.0.1:8084/petals/services/SoapFtpTutorial'{code}
# Go to [http://127.0.0.1:8084] in your web browser.
# Go to Service List.
# Copy the SoapFtpTutorial WSDL URL.
*Create a SOAP UI Project:*
# Lauch SOAP UI.
# File => New soapUI Project.
## Project Name: PetalsFtpTutorial (or whatever name).
## Initial WSDL/WADL: \_Paste the WSDL URL previously copied. Might be: [http://127.0.0.1:8084/petals/services/SoapFtpTutorial?wsdl\_|http://127.0.0.1:8084/petals/services/SoapFtpTutorial?wsdl_]
# OK.
*Test the proxified FTP DIR operation:*
# PetalsFtpTutorial => FtpServiceSoapBinding => dir.
# Right clic on "Request1" => Show Request Editor: A window with a pre-generated messages appears.
# Delete what is under <\!\--Optionnal-\->: <connection> node and its children. Ftp parameters were already configured in the SU, so you do not need to configure them again.
{code:lang=xml|title=Your message looks like this}
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ver="http://petals.ow2.org/components/ftp/version-3">
<soapenv:Header/>
<soapenv:Body>
<ver:dir>
</ver:dir>
</soapenv:Body>
</soapenv:Envelope>
{code}
# Clic the green arrow to send the message. The response should list several files.
{info:title=Want to go further?}Try reading "HelloWorld.txt" into "Integration" folder, using optional elements instead of deleting them.
\\
You need to redefine ALL properties in this case.
{info}
*Technical monitoring with Webconsole:*
# Go in Webconsole => Server: 0 => Monitoring => Server Monitoring
## *Check* "Filter Endpoint"
## *Select*: FtpTutorialEndpoint
# Submit
# Click the small image in the "_Monitoring"_ Column to activate _FtpTutorialEndpoint_ monitoring.
# Send a few test message with SOAP UI.
# Go in Webconsole => Server: 0 => Monitoring => Filter Monitoring
# Click on the right of a message exchange to get details. You should get a screen like this:
!Exchange SOAP-FTP.png|thumbnail,border=1!
_Screen: Message exchange status_
{info}You can see the message was sent by BC-SOAP to BC-FTP{info}
*DONE. Bravo \!*
Now you know how to:
* Connect Petals ESB to an FTP Server and call operations.
* Monitor service exchanges in Webconsole.
* Expose a Petals Service as external SOAP Web-service.
* Test a web-service with soapUI.
This was more "real" usecase, hum ? Difficulty goes increasing, your knowledge as well.
*Tomorrow you will create a Petals service based on a custom Java class (annotated JSR 181)*
\* Petals Guide Package 1.0 - \[Download binaries here\|http://doc.petalslink.com/x/t4KK\]
\* Tomcat 6.0.29
\* JDK 6 update 20
This Tutorial uses:
\* Petals ESB
\* Petals Studio
\* Petals SE RMI
\* Petals BC SOAP
\* Petals Web console
\* Tomcat\* Petals Guide Package 1.0 - \[Download binaries here\|http://doc.petalslink.com/x/t4KK\]
\* Tomcat 6.0.29
\* JDK 6 update 20
This Tutorial uses:
\* Petals ESB
\* Petals Studio
\* Petals SE RMI
\* Petals BC SOAP
\* Petals Web console
\* Tomcat
E-mail
...