JAX-WS. Java API for XML Web Services. Massimo Martinelli

Transcript

1 29/05/2010, Area Ricerca CNR, Pisa JAX-WS Java API for XML Web Services Massimo Martinelli Consiglio Nazionale delle Ricerche - CNR Istituto di Scienza e Tecnologie della Informazione - ISTI

2 Il corso di Java Web Services in 1 Minuto! import... Scriviamo una classe Java con un metodo Aggiungiamo public class MioWebService public String ciao(string nome) { return Ciao + nome; Finito!...

3 RIPARTIAMO :-) JAX-WS Java API for XML Web Services Massimo Martinelli Consiglio Nazionale delle Ricerche - CNR Istituto di Scienza e Tecnologie della Informazione - ISTI

4 Sommario Cosa è JAX-WS? Implementazione di Web Service e di Client Tipi di dato supportati da JAX-WS JAXB Esercizi da svolgere durante il corso

5 Secondo il W3C... Un Web Service è un sistema software designato a supportare interazioni interoperabili macchina-macchina su una rete. Ha una interfaccia descritta in un formato elaborabile da una macchina (specificamente WSDL). Altri sistemi interagiscono con il Web Service in un modo prescritto dalla sua descrizione usando messaggi SOAP, tipicamente convogliati usando HTTP con una serializzazione XML insieme ad altri standard Web.

6 Cosa è JAX-WS acronimo di Java API for XML Web Services Tecnologia per realizzare Web Service e client in Java che comunicano utilizzando messaggi SOAP-XML L implementazione di riferimento (JAX-WS for Reference Implementation) è un progetto open source e fa parte del progetto GlassFish, un application server Java EE. Fa parte della distribuzione Metro

7 Web Services semplificati Da Java 5 (Java 1.5) introdotte le annotazioni ovvero dei Metadati sul codice Java Esempio di Annotazioni: Possono essere trattate a livello di compilazione Possono essere trattate anche tempo di esecuzione

8 Annotazioni nei Web Service Per sviluppare un Web Service con JAX-WS è necessario utilizzare l'annotazione javax.jws.webservice Ovvero: la classe che implementa il Web Service deve essere annotata con la annotazione javax.jws.webservice (o con javax.jws.webserviceprovider)

9 Service Endpoint Interface (SEI) Una interfaccia service endpoint (SEI) è una interfaccia Java che dichiara i metodi che un client può invocare sul servizio SEI non necessaria quando si implementa un endpoint JAXWS: la classe di implementazione del Web Service (SIB Service Implementation Bean) definisce implicitamente una SEI può riferire esplicitamente una SEI tramite l elemento endpointinterface dell

10 Preparazione agli esercizi Creare una directory LINUX ~home/java-pgm/ C:/java-pgm/ dove installeremo i programmi che seguono...

11 Strumenti che utilizzeremo: Java SE 6 Java Standard Development Kit versione 6 (Se non è già installata eseguire da terminale il comando java version ) Scaricare da

12 Strumenti che utilizzeremo: Netbeans Netbeans è un ambiente di sviluppo realizzato da SUN Scaricare da (versione Java o All )

13 Strumenti che utilizzeremo: Glassfish Application server open source realizzato da Sun di riferimento per Java EE 5/6. Incluso con NetBeans Supporta: EJB 3.1 JPA 2 JAXB 2.x JAX-WS 2.x

14 Per utilizzare con Tomcat scaricare ant da scaricare metro da java -jar metro*.jar ant -Dtomcat.home=<DirectorydiTomcat> -f metro-ontomcat.xml install V

15 Implementazione di un Web Service A partire da: una classe Java un documento WSDL

16 Implementazione di un Web Service (classe Java): Passi Base 1. Codificare la classe che implementa il servizio 2. Compilare tale classe 3. Dispiegare (deploy) il file WAR 4. Codificare la classe per il client 5. Utilizzare wsimport per generare e compilare gli artefatti 6. Compilare la classe client 7. Eseguire il client

17 Codifica della classe SIB (1/2) package serviziociao; import public class Ciao { private String messaggio = new String("Ciao, "); public void Ciao() public String saluto(string nome) { return messaggio + nome + ".";

18 Codifica della classe SIB (2/2) La classe implementata, Ciao, è annotata come web service utilizzando Ciao dichiara un singolo metodo chiamato saluto, annotato con La classe implementata deve anche definire un costruttore di default public senza argomenti

19 JAX-WS Endpoint I metodi della classe che implementa il Web Service devono essere public, e non devono essere dichiarati ne static ne final I metodi di Business esposti ai client dei Web service devono: essere annotati con javax.jws.webmethod avere tipi di parametri compatibili con JAX-B Le classi che implementano i Web Service Non devono essere dichiarate abstract Devono avere un costruttore di default public Non devono definire il metodo finalize Possono usare le annotazioni javax.annotation.postconstruct o javax.annotation.predestroy sui propri metodi per gestire il loro ciclo di vita Il è chiamato dal container prima che la classe di implementazione inizi a rispondere ai client del Web Service Il è chiamato dal container prima che l'endpoint sia rimosso dall'operazione

20 Esercizio (Guidato) Realizzare un Web Service che fa la somma di due numeri interi Da Netbeans creare un nuovo progetto Web Creare un nuovo Web service Dispiegare, eseguire e provare (Test)

21 Non vi avevo detto che bisognava importare anche... package serviziociao.endpoint; import javax.jws.webservice; import public class Ciao { private String messaggio = new String("Ciao, "); public void Ciao() public String saluto(string nome) { return messaggio + nome + ".";

22 @WebService V Attributi name: nome del wsdl:porttype (per difetto il nome della classe Java senza package) portname: nome del wsdl:portname (per difetto è il nome del WebService concatenato a Port) servicename: nome del servizio (wsdl:service) (per difetto il nome della classe concatenato alla Stringa Service ) endpointinterface: (es. endpointinterface = "package.miowebserviceinterface") specifica il nome completo della SEI (per difetto la classe java,comprensiva del package, concatenata alla Stringa ServicePortType ) targetnamespace: namespace di riferimento per il WSDL e gli XML generati (per difetto è il nome del package java) wsdllocation: l'indirizzo documento WSDL del Web Service. L'indirizzo può essere relativo o assoluto. (servicename = "NomeServizio", endpointinterface = "it.cnr.nomeservizioserviceporttype", targetnamespace=" portname="nomeservizioserviceport")

23 @WebMethod V Per difetto tutti i metodi public di una classe annotata vengono esposti nel Web Service Per personalizzare un metodo esposto come operazione WS si Attributi action definisce l'azione per l'operazione. (per difetto = al nome del metodo ) exclude specifica se il metodo va escluso dalla pubblicazione del Web Service. (per difetto= false ) (Booleano) operationname specifica il nome di wsdl:operation per il metodo (per difetto = nome del public int somma(@webparam(name = "i") int = "j") int j) { int k = i + j; return k;

24 @WebParam V personalizzazione dei parametri di input(@webparam) e di output(@webresult) di un metodo del Web Service Attributi header: Specifica se il parametro si trova in un'intestazione di messaggio anziché nel corpo. Per difetto è false. (Booleano) mode: WebParam.mode.IN parametro, WebParam.mode.OUT, WebParam.mode.INOUT che rappresentano parametri in input, in output e parametri ripetuti sia in input che in output name: nome del parametro. targetnamespace: spazio dei nomi XML dell'elemento XML per il parametro

25 @SOAPBinding In caso i metodi del Web Service utilizzino tipi semplici come String o int è possibile utilizzare la seguente In caso di utilizzo di tipi complessi lo stile da utilizzare corrisponde a quello di Nel secondo caso vedremo più avanti come utilizzare il mapping (da oggetti Java in XML e viceversa) con JAXB

26 @SOAPBinding Indipendenza dal Protocollo e dal specifica come avviene il mapping a livello SOAP Attributi style stile di codifica per messaggi inviati e ricevuti. Valori: DOCUMENT (default), RPC. use formattazione per messaggi inviati e ricevuti. Valori LITERAL(default). ENCODED (non WS-I standard) parameterstyle valori Wrapped (default) o BARE (utilizzabile solo in stile DOCUMENT) = " name = = SOAPBinding.Style.DOCUMENT, use = SOAPBinding.Use.LITERAL)

27 Personalizzazione tramite SistemaInformativoService, targetnamespace= ) public class SistemaInformativo getpersona ) public Persona getpersona(@webparam(name= codicefiscale ) String codicefiscale) { //... codice di implementazione...

28 Implementazione del Servizio (da classe Java) Al momento dell'esecuzione Netbeans genera automaticamente gli artefatti, compila tutte le classi, dispiega il servizio e attiva l application server Dietro le quinte il Web Service (endpoint) viene generato dal tool wsgen wsgen cp./build -keep -s./src -d./build package.class

29 Artefatti Il tool wsimport a partire dal WSDL crea le classi di supporto (artefatti): Service Endpoint Interface (SEI) Service Exception class a partire da wsdl:fault Oggetti generati a partire dagli schemi XML (JAXB...) Per invocare una operazione WS è necessario istanziare la classe service ed ottenere il proxy mediante chiamata al metodo: get<servicename>port CalculatorService svc = new CalculatorService(); Calculatorproxy = svc.getcalculatorport( ) ; int answer = proxy.somma(35, 7);

30 wsimport Parametri: wsdl: percorso del file wsdl (es: /home/massimo/servizio.wsdl, destdir: destinazione dei compilati generati sourcedestdir: destinazione dei sorgenti generati keep: se indicata mantiene i sorgenti generati verbose: dettaglio verboso delle operazioni svolte binding: specifica il tipo di collegamento package: nome del package per le classi generate

31 Prova del Servizio...senza un Client Aprire Admin Console collegandosi col browser all'indirizzo Fornire utente e password per effetturare il login Cliccare su Web Services nel panello a sinistra Cliccare Hello Cliccare Test (

32 Prova del metodo sayhello in Methods, scrivere un nome come parametro per il metodo sayhello Cliccare il pulsante sayhello

33 Analisi dei Messaggi SOAP

34 Client a partire da un WSDL

35 Implementazione di un servizio a partire da un WSDL Netbeans genera un Web Service (bozza) a partire da un WSDL Dietro le quinte esegue per noi il comando wsimport wsimport -keep s <directory_sorgenti> -d <classi_generate_compilate> <percorso_documento_wsdl> -keep non cancella i file sorgenti generati Il comando genera eventuali artefatti JAXB per gestire tipi non di base

36 Codifica del Client 1. Utilizzare l annotazione javax.xml.ws.webserviceref per riferire un Web Service L attributo wsdllocation specifica l URI del documento 080/EsempioWSCiao/CiaoService?wsdl 2. Invocare il metodo del Web Service utilizzando il proxy (port) del service Hello port = service.getciaoport(); 3. Invocare il metodo (saluto ) del proxy (port)

37 ClientCiao package simpleclient; import javax.xml.ws.webserviceref; import helloservice.endpoint.helloservice; import serviziociao.endpoint.ciao; public class ClientCiao static CiaoService service = new CiaoService(); public static void main(string[] args) { try { ClientCiao client = new ClientCiao(); client.dotest(args); catch(exception e) { e.printstacktrace(); public void dotest(string[] args) { try { System.out.println( Recupero il proxy (port) dal servizio: " + service); Ciao port = service.getciaoport(); System.out.println("Invoco l operazione saluto sul proxy (port)"); String name; if (args.length > 0) { nome= args[0]; else { nome = Nessun nome"; String response = port.saluto(nome); System.out.println(response); catch(exception e) { e.printstacktrace();

38 Esercizio Preparare un client che chiami il metodo registranome del Web Service WSnominativo descritto dal WSDL che trovate all indirizzo il metodo richiede in input un parametro di tipo String Test: Controllo accessi:

39 Tipi Supportati da JAX-WS Per essere indipendenti dal linguaggio i tipi supportati sono limitati a quelli descritti nelle specifiche: tipi atomici (es. int, boolean, ecc.) String array e List semplici JavaBean usati come strutture (con costruttore public) JAX-WS delega a JAXB il collegamento tra tipi Java e XML (e viceversa). Sviluppatori non devono preoccuparsi del collegamento (in generale)

40 JAXB Java API XML Binding Librerie che consentono di collegare (binding) oggetti Java a documenti XML A partire da un documento XML schema si può creare una classe Java corrispondente le cui istanze possono leggere/scrivere documenti XML e viceversa

41 Marshalling / Serializzazione Il procedimento detto marshalling si riferisce alla possibilità di serializzare (..trasformare..) oggetti Java in documenti XML. A partire da un oggetto Java, schemagen crea un documento XML corrispondente schemagen [-opzioni...] [sorgenti_java] Le istanze di queste classi possono essere collegate ai relativi documenti XML

42 Unmarshalling / Deserializzazione Il procedimento detto unmarshalling si riferisce alla possibilità di deserializzare (..trasformare..) documenti XML (schema) in oggetti Java. A partire da un documento xjc crea un oggetto Java corrispondente XML Schema xjc [-opzioni...] <schema> xjc biblioteca.xsd Le istanze di questa classe possono essere collegate a documenti XML

43 public class Persona () { private String nominativo; private String identificatore; public Persona() { public void getnominativo(){ return nominativo; public void setnominativo(string nominativo){ this.nominativo=nominativo; public int getidentificativo() { return // identificatore attributo dell'elemento radice public void setid(int identificatore) { this.identificatore = identificatore;

44 JAXB Serializzare e Deserializzare // Serializzare un oggetto in XML Persona persona= new Persona(); persona.setnominativo("salvo Montalbano"); persona.setidentificatore( slvmnt); // creiamo il contesto JAXB e un marshaller (serializzatore) JAXBContext contesto = JAXBContext.newInstance(Persona.class); Marshaller serializzatore = contesto.createmarshaller(); // Impostiamo un formato pretty serializzatore.setproperty(marshaller.jaxb_formatted_output, true); // serializzaimo serializzatore.marshal(persona, new File("/output.xml")); // Deserializzare (Ottenere l'oggetto dall'xml // creiamo il contesto JAXB e un unmarshaller (deserializzatore) JAXBContext contesto = JAXBContext.newInstance(Persona.class); Unmarshaller deserializzatore = contesto.createunmarshaller(); // otteniamo l'oggetto Message msg = (Persona)deserializzatore.unmarshal(new File("/persona.xml"));

45 public class Persona () { private String nominativo; private String public Dipendente() { Persona persona;

46 Esempio public class Persona () { private String nominativo; private String public Persona() { public void getnominativo(){ return nominativo; public void setnominativo(string nominativo){ this.nominativo=nominativo; public int getidentificativo() { return // identificatore attributo dell'elemento radice public void setid(int identificatore) { this.identificatore = identificatore;

47 Gestire gli allegati (attachment): = public class WSUpload { public void fileupload(string DataHandler data) { try { DataHandler dh = data; File file = new File(nomeFile); FileOutputStream outputstream = new FileOutputStream(file); dh.writeto(outputstream); catch (Exception e) { throw new WebServiceException(e);

48 Gestire gli allegati (attachment): Client WSUploadService service = new WSUploadService(); // classe generata MTOMFeature feature = new MTOMFeature(); WSUpload port = service.getwsuploadport(feature); //classe generata URL url = new URL("file:///home/massimo/prova.png"); DataHandler dh = new DataHandler(url); String nomefile = "prova.png"; port.fileupload(nomefile, dh);

49 Esercizio Preparare un client che chiami il metodo YYYYY del Web Service XXXX descritto dal WSDL che trovate all indirizzo il metodo richiede in input un parametro di tipo String e un parametro file corrispondente ad una immagine jpg o gif o png che avete sul vostro disco

50 Novità introdotta con in Java SE 6 //pubblicazione di un POJO (Plain Ordinary Java public class Calcolatore WebServiceContext context; // ottiene dal server il contesto dei WS public int somma(int a, int b) { return a+b; // crea e pubblica un endpoint Calcolator calculatore = new Calcolatore(); Endpoint endpoint=endpoint.publish( // WSDL creato e pubblicato al volo: // assegnazione di protocollo (per difetto è HTTP) // Endpoint endpoint=endpoint.create(soapbinding.soap12http_binding,calcolatore); //endpoint.publish( );

51 Client Asincroni (nonblocking) class AmazonAsyncClient { public static void main(string[ ] args) { // Usage if (args.length!= 1) { System.err.println("Usage: java AmazonAsyncClient <access key>"); return; final String access_key = args[0]; // Create service and get porttype reference. AWSECommerceService service = new AWSECommerceService(); AWSECommerceServicePortType port = service.getawsecommerceserviceport(); // Create request. ItemSearchRequest request = new ItemSearchRequest(); // Add details to request. request.setsearchindex("books"); request.setkeywords("quantum gravity"); ItemSearch item_search= new ItemSearch(); item_search.setawsaccesskeyid(access_key); // The handler class implements handleresponse, which executes item_search.getrequest().add(request); // if and when there's a response. port.itemsearchasync(item_search, new MyHandler()); static class MyHandler implements AsyncHandler<ItemSearchResponse> { // In this case, just sleep to give the search process time. public void handleresponse(response<itemsearchresponse> future) { // In a production application, other useful tasks could be try { // performed and the application could run indefinitely. ItemSearchResponse response = future.get(); try { List<Items> item_list = response.getitems(); Thread.sleep(400); for (Items next : item_list) for (Item item : next.getitem()) catch(interruptedexception e) { System.err.println(e); System.out.println(item.getItemAttributes().getTitle()); catch(interruptedexception e) { System.err.println(e); catch(executionexception e) { System.err.println(e);

52 Bibliografia Metro User Guide Java Web Services Developer Pack Java EE 5 Developing using Glassfish Application Server. David R. Heffelfinger Packt Publishing Create stand-alone Web services applications with Eclipse and Java SE 6. Fiona Lam, John Robertson, IBM developerworks Documentazione di WebSphere Application Server topic=/com.ibm.websphere.wsfep.multiplatform.doc/info/ae/ae/rwbs_jaxwsannotatio ns.html RESTful Web services: The basics. Alex Rodriguez - IBM developerworks Web Services con Java5. MokaByte 127, Marzo Aprile 2008 ( Java & XML. Brett McLaughlin O'Reilly Java Web Services Up adn Running O'Reilly Corso Comune Livorno Web Services. M.Martinelli Corso Comune Livorno AXIS 2.1. M.Martinelli Corso Comune Livorno Java e XML. M.Martinelli

53 Grazie!