Develop Java Webservice Client

Transcription

1 Develop Java Webservice Client

2 Develop Java Webservice Client Contents Develop Java Webservice Client 2 Commercial In Confidence 3 Preface 4 Summary information 4 Confidentiality 4 Document Control 4 Who should use this guide? 4 Ellipse Java Web Service Client 5 Requirements 5 Eclipse 5 Java Project 5 WSDL To Java (WSDLToJava) 5 Example 5

3 Commercial In Confidence Copyright 2018 ABB All Rights Reserved Confidential and Proprietary Legal Disclaimer The product described in this documentation may be connected to, and/or communicate information and data via, a network interface, which should be connected to a secure network. It is your sole responsibility to ensure a secure connection to the network and to establish and maintain appropriate measures (such as but not limited to the installation of firewalls, application of authentication measures, encryption of data, installation of antivirus programs, etc.) to protect the product, the network, your systems, and the interface against any kind of security breach, unauthorised access, interference, intrusion, leakage, damage, or corruption or theft of data. We are not liable for damages or losses related to any such security breach, unauthorised access, interference, intrusion, leakage, damage, or corruption or theft of data.

4 Preface This document provides information on Ellipse Web Services. Summary information Confidentiality The contents of this document are confidential between ABB and its customers. The parties must keep the information herein confidential at all times and not disclose it, or permit it to be disclosed, to any third party, apart from any of their officers, employees, agents or advisers who have a specific need to access the information herein and have agreed to be bound by the terms of confidentiality. Document Control Once the project is completed or terminated, this document will revert to an uncontrolled document status. No further advice will be provided, and each recipient may either destroy the document or mark it as obsolete and retain it for future personal reference. All copies of this document will be issued electronically. Who should use this guide? This guide provides information on Ellipse Web Services for Ellipse Technical Consultants and Programmers.

5 Ellipse Java Web Service Client This document serves as a reference for implementing and connecting to the new Ellipse Web Services in Java. This document assumes a fairly solid understanding of both Java and Web Services and their associated terminology, such as WSDL and SOAP. Screenshots are taken using Eclipse 3.3 and so some of the terminology and procedures will vary with other IDEs such as IntelliJ and NetBeans. This is by no means a requirement of using an Ellipse Java Web Services Client. Some excellent documentation on developing a CXF client can be found at the following developing a consumer address: Requirements Java 1.5 JDK or higher. This is due to the dependency on CXF, which does not support older versions of Java. Java 1.4 may be used in conjunction with another client Web Service library such as XFire or Axis2. Eclipse Java Project Create a new Java project or use an existing one as required. WSDL To Java (WSDLToJava) CXF Client proxies are required to interface with the Web Services. These can be generated manually by running the CXF WSDLToJava tool. The documentation for WSDLToJava can be found on the CXF website (NOT WORKING) and won t be replicated here. For convenience, we have prepared a jar containing CXF client classes for your distribution of Ellipse services. It can be downloaded using the EllipseWebServicesJavaClient.zip link. Once downloaded, the pre-compiled jars will need to be included in the newly created project classpath. If the jar is added to sub-folder of the project, right click on the jar and select Build Path -> Add to Build Path. Otherwise right clicking on the project, Properties -> Java Build Path -> Libraries and then locate the relevant jar on the file-system or in the project. Example Here is a very basic example which called the fetchdefaultmenu operation on the Menu Service passing in an empty DTO and returns a replydto. This is very similar to most of the services calls, with the relevant values being set on the DTO before the operation is called. See Ellipse Web Service Usage Examples for more examples. Line Code 01 import java.net.url; 02 import com.mincom.ews.client.ewsclientconversation; 03 import com.mincom.ews.service.connectivity.operationcontext; 04 import com.mincom.enterpriseservice.ellipse.menu.*; public final class Client { public static void main(string args[]) throws Exception 09 { 10 EWSClientConversation client = new EWSClientConversation(); 11 client.start(new URL(url)); 12 client.authenticate("user","pass"); OperationContext context = new OperationContext(); 15 context.setdistrict("district");

6 16 context.setposition("position"); Menu service = client.createservice(menuservice.class); 19 MenuServiceFetchDefaultMenuRequestDTO dto = new MenuServiceFetch DefaultMenuRequestDTO(); 20 MenuServiceFetchDefaultMenuReplyDTO defaultmenu = 21 service.fetchdefaultmenu(context, dto); 22 System.out.println(defaultmenu.getMenuName()); 23 } 24 } A demonstration client example calling the Table service is contained in EllipseWebServicesSimpleClientExample.zip. It includes the Java source code and instructions on building and running the client.