WA2018 Programming REST Web Services with JAX-RS 1.1

Total Page:16

File Type:pdf, Size:1020Kb

WA2018 Programming REST Web Services with JAX-RS 1.1 Y L N O N IO T A U L A V E WA2018 Programming REST Web Services with JAX-RS 1.1 - WebLogic 12c / Eclipse Web Age Solutions Inc. USA: 1-877-517-6540 Canada: 1-866-206-4644 Web: http://www.webagesolutions.com The following terms are trademarks of other companies: Java and all Java-based trademarks and logos are trademarks or registered trademarks of Sun Microsystems, Inc. in the United States, other countries, or both. Microsoft, Windows, Windows NT, and the Windows logo are trademarks of Microsoft Corporation in the United States, other countries, or both. UNIX is a registered trademark of The Open Group in the United States and other countries. Linux is a trademark of Linus Torvalds in the United States, other countries, or both. IBM, WebSphere, DB2 and Tivoli are trademarks of the International Business Machines Corporation in the United States, other countries, or both. Other company, product, and service names may be trademarks or service marks of others. Y For customizations of this book or other sales inquiries, pleaseL contact us at: USA: 1-877-517-6540, email: [email protected] Canada: 1-866-206-4644 toll free, email: [email protected] O N Copyright © 2012 Web Age Solutions Inc. O This publication is protected by the copyright lawsI of Canada, United States and any other country where this book is sold. UnauthorizedT use of this material, including but not limited to, reproduction of the whole or partA of the content, re-sale or transmission through fax, photocopy or e-mail is prohibited.U To obtain authorization for any such activities, please write to: L Web Age Solutions Inc. A 439 University Ave V Suite 820 E Toronto Ontario, M5G 1Y8 Table of Contents Chapter 1 - REST Services..................................................................................................7 1.1 Many Flavors of Services..........................................................................................7 1.2 Understanding REST................................................................................................7 1.3 Principles of RESTful Services.................................................................................8 1.4 REST Resource Examples........................................................................................9 1.5 SOAP Equivalent Examples.....................................................................................9 1.6 REST vs SOAP Communication............................................................................10 1.7 More REST vs SOAP..............................................................................................10 1.8 REST vs SOAP Summary.......................................................................................11 1.9 Famous RESTful Services......................................................................................11 1.10 Additional Resources............................................................................................12 1.11 Summary...............................................................................................................12 Chapter 2 - Introduction to JAX-RS..................................................................................13 2.1 The JAX-RS Specification......................................................................................13 2.2 The Resource Class.................................................................................................Y 13 2.3 A Bunch of Annotations..........................................................................................L 14 2.4 @Path......................................................................................................................15 2.5 More Complex Paths...............................................................................................N 15 2.6 Using Path Parameters............................................................................................ O 16 2.7 HTTP Binding.........................................................................................................17 2.8 web.xml...................................................................................................................N 17 2.9 Summary.................................................................................................................O 18 Chapter 3 - JAX-RS Data Injection...................................................................................I 19 3.1 Sources for Injected Data........................................................................................T 19 3.2 Path Parameters.......................................................................................................A 19 3.3 Query Parameters....................................................................................................U 20 3.4 HTML Form Input..................................................................................................L 21 3.5 Cookies....................................................................................................................21 3.6 Matrix Parameters...................................................................................................A 22 3.7 HTTP Headers.........................................................................................................V 23 3.8 Default Values.........................................................................................................E 23 3.9 Parameter Conversion.............................................................................................24 3.10 Custom Types........................................................................................................24 3.11 Summary...............................................................................................................25 Chapter 4 - Designing a RESTful Service.........................................................................27 4.1 Introduction.............................................................................................................27 4.2 The Design Methodology........................................................................................27 4.3 Ingredients of a Service Operation Interface..........................................................28 4.4 What Constitutes a REST Resource........................................................................29 4.5 Resource Identifiers................................................................................................29 4.6 MIME Types...........................................................................................................30 4.7 HTTP Methods........................................................................................................30 4.8 Example Operation Interface Document.................................................................31 4.9 Summary.................................................................................................................31 Chapter 5 - JAX-RS Content Types...................................................................................33 5.1 Internet Media Types..............................................................................................33 5.2 Use of Media Type in REST...................................................................................34 5.3 The @Consumes Annotation..................................................................................34 5.4 Content Negotiation................................................................................................35 5.5 The @Produces Annotation....................................................................................36 5.6 The MediaType Class.............................................................................................36 5.7 JAXB.......................................................................................................................36 5.8 Dynamic Content Negotiation.................................................................................37 5.9 Summary.................................................................................................................38 Chapter 6 - Building Complex JAX-RS Responses..........................................................39 6.1 HTTP Response Status Codes.................................................................................39 6.2 Introduction to the JAX-RS Response Class..........................................................39 6.3 Using the Response and Response.ResponseBuilder Classes.................................40 6.4 Example: Conditional HTTP GET..........................................................................41 6.5 Returning Cookies...................................................................................................41 6.6 Cookies in Response Headers.................................................................................42 6.7 Reading Cookies.....................................................................................................Y 42 6.8 Returning an Exception...........................................................................................L 43 6.9 ExceptionMappers...................................................................................................N 44 6.10 Summary...............................................................................................................44 Chapter 7 - REST vs. SOAP.............................................................................................
Recommended publications
  • Security Management Server Virtual V10.2.11 Adminhelp
    Security Management Server Virtual v10.2.11 AdminHelp Table of Contents Welcome ............................................................................................................................................................... 1 About Online Help ............................................................................................................................................. 1 Attributions & Copyrights .................................................................................................................................. 1 Get Started.......................................................................................................................................................... 23 Get Started with Dell Data Security ................................................................................................................ 23 Log In ............................................................................................................................................................... 23 Log Out ............................................................................................................................................................ 23 Dashboard ........................................................................................................................................................ 24 Change Superadmin Password ......................................................................................................................... 26 Components .......................................................................................................................................................
    [Show full text]
  • A Post-Apocalyptic Sun.Misc.Unsafe World
    A Post-Apocalyptic sun.misc.Unsafe World http://www.superbwallpapers.com/fantasy/post-apocalyptic-tower-bridge-london-26546/ Chris Engelbert Twitter: @noctarius2k Jatumba! 2014, 2015, 2016, … Disclaimer This talk is not going to be negative! Disclaimer But certain things are highly speculative and APIs or ideas might change by tomorrow! sun.misc.Scissors http://www.underwhelmedcomic.com/wp-content/uploads/2012/03/runningdude.jpg sun.misc.Unsafe - What you (don’t) know sun.misc.Unsafe - What you (don’t) know • Internal class (sun.misc Package) sun.misc.Unsafe - What you (don’t) know • Internal class (sun.misc Package) sun.misc.Unsafe - What you (don’t) know • Internal class (sun.misc Package) • Used inside the JVM / JRE sun.misc.Unsafe - What you (don’t) know • Internal class (sun.misc Package) • Used inside the JVM / JRE // Unsafe mechanics private static final sun.misc.Unsafe U; private static final long QBASE; private static final long QLOCK; private static final int ABASE; private static final int ASHIFT; static { try { U = sun.misc.Unsafe.getUnsafe(); Class<?> k = WorkQueue.class; Class<?> ak = ForkJoinTask[].class; example: QBASE = U.objectFieldOffset (k.getDeclaredField("base")); java.util.concurrent.ForkJoinPool QLOCK = U.objectFieldOffset (k.getDeclaredField("qlock")); ABASE = U.arrayBaseOffset(ak); int scale = U.arrayIndexScale(ak); if ((scale & (scale - 1)) != 0) throw new Error("data type scale not a power of two"); ASHIFT = 31 - Integer.numberOfLeadingZeros(scale); } catch (Exception e) { throw new Error(e); } } } sun.misc.Unsafe
    [Show full text]
  • IBM Websphere Application Server Community Edition V3.0 Helps Streamline the Creation of Osgi and Java Enterprise Edition 6 Applications
    IBM United States Software Announcement 211-083, dated September 27, 2011 IBM WebSphere Application Server Community Edition V3.0 helps streamline the creation of OSGi and Java Enterprise Edition 6 applications Table of contents 1 Overview 6 Technical information 2 Key prerequisites 8 Ordering information 2 Planned availability date 9 Services 3 Description 9 Order now 6 Product positioning At a glance With WebSphere® Application Server Community Edition V3.0: • Developers can select just the components they need for optimum productivity (using OSGi and a component assembly model). • Developers can get JavaTM Enterprise Edition (Java EE) 6 applications started quickly for no charge. • System administrators are given more deployment and management options. • Organizations can take advantage of world-class, IBM® support options under a socket-based pricing model that can help reduce the cost burden in larger configurations. • You have access to a comprehensive and proven portfolio of middleware products from the WebSphere family. Overview WebSphere Application Server Community Edition V3.0 is the IBM open source- based application server that provides: • Java Enterprise Edition (Java EE) 6 support • An enterprise OSGi application programming model • Java Standard Edition (Java SE) 6 support Version 3 is built on Apache Geronimo and integrated with best-of-breed, open- source technology such as Apache Tomcat, Eclipse Equinox OSGi Framework, Apache Aries, Apache OpenEJB, Apache OpenJPA, Apache OpenWebBeans, and Apache MyFaces. Eclipse-based
    [Show full text]
  • Avaliando a Dívida Técnica Em Produtos De Código Aberto Por Meio De Estudos Experimentais
    UNIVERSIDADE FEDERAL DE GOIÁS INSTITUTO DE INFORMÁTICA IGOR RODRIGUES VIEIRA Avaliando a dívida técnica em produtos de código aberto por meio de estudos experimentais Goiânia 2014 IGOR RODRIGUES VIEIRA Avaliando a dívida técnica em produtos de código aberto por meio de estudos experimentais Dissertação apresentada ao Programa de Pós–Graduação do Instituto de Informática da Universidade Federal de Goiás, como requisito parcial para obtenção do título de Mestre em Ciência da Computação. Área de concentração: Ciência da Computação. Orientador: Prof. Dr. Auri Marcelo Rizzo Vincenzi Goiânia 2014 Ficha catalográfica elaborada automaticamente com os dados fornecidos pelo(a) autor(a), sob orientação do Sibi/UFG. Vieira, Igor Rodrigues Avaliando a dívida técnica em produtos de código aberto por meio de estudos experimentais [manuscrito] / Igor Rodrigues Vieira. - 2014. 100 f.: il. Orientador: Prof. Dr. Auri Marcelo Rizzo Vincenzi. Dissertação (Mestrado) - Universidade Federal de Goiás, Instituto de Informática (INF) , Programa de Pós-Graduação em Ciência da Computação, Goiânia, 2014. Bibliografia. Apêndice. Inclui algoritmos, lista de figuras, lista de tabelas. 1. Dívida técnica. 2. Qualidade de software. 3. Análise estática. 4. Produto de código aberto. 5. Estudo experimental. I. Vincenzi, Auri Marcelo Rizzo, orient. II. Título. Todos os direitos reservados. É proibida a reprodução total ou parcial do trabalho sem autorização da universidade, do autor e do orientador(a). Igor Rodrigues Vieira Graduado em Sistemas de Informação, pela Universidade Estadual de Goiás – UEG, com pós-graduação lato sensu em Desenvolvimento de Aplicações Web com Interfaces Ricas, pela Universidade Federal de Goiás – UFG. Foi Coordenador da Ouvidoria da UFG e, atualmente, é Analista de Tecnologia da Informação do Centro de Recursos Computacionais – CERCOMP/UFG.
    [Show full text]
  • Full-Graph-Limited-Mvn-Deps.Pdf
    org.jboss.cl.jboss-cl-2.0.9.GA org.jboss.cl.jboss-cl-parent-2.2.1.GA org.jboss.cl.jboss-classloader-N/A org.jboss.cl.jboss-classloading-vfs-N/A org.jboss.cl.jboss-classloading-N/A org.primefaces.extensions.master-pom-1.0.0 org.sonatype.mercury.mercury-mp3-1.0-alpha-1 org.primefaces.themes.overcast-${primefaces.theme.version} org.primefaces.themes.dark-hive-${primefaces.theme.version}org.primefaces.themes.humanity-${primefaces.theme.version}org.primefaces.themes.le-frog-${primefaces.theme.version} org.primefaces.themes.south-street-${primefaces.theme.version}org.primefaces.themes.sunny-${primefaces.theme.version}org.primefaces.themes.hot-sneaks-${primefaces.theme.version}org.primefaces.themes.cupertino-${primefaces.theme.version} org.primefaces.themes.trontastic-${primefaces.theme.version}org.primefaces.themes.excite-bike-${primefaces.theme.version} org.apache.maven.mercury.mercury-external-N/A org.primefaces.themes.redmond-${primefaces.theme.version}org.primefaces.themes.afterwork-${primefaces.theme.version}org.primefaces.themes.glass-x-${primefaces.theme.version}org.primefaces.themes.home-${primefaces.theme.version} org.primefaces.themes.black-tie-${primefaces.theme.version}org.primefaces.themes.eggplant-${primefaces.theme.version} org.apache.maven.mercury.mercury-repo-remote-m2-N/Aorg.apache.maven.mercury.mercury-md-sat-N/A org.primefaces.themes.ui-lightness-${primefaces.theme.version}org.primefaces.themes.midnight-${primefaces.theme.version}org.primefaces.themes.mint-choc-${primefaces.theme.version}org.primefaces.themes.afternoon-${primefaces.theme.version}org.primefaces.themes.dot-luv-${primefaces.theme.version}org.primefaces.themes.smoothness-${primefaces.theme.version}org.primefaces.themes.swanky-purse-${primefaces.theme.version}
    [Show full text]
  • Management of and Interaction with Olap Cloud Service
    MASTERARBEIT Titel der Masterarbeit: MANAGEMENT OF AND INTERACTION WITH OLAP CLOUD SERVICE eingereicht von: Sicen Ye zur Erlangung des akademischen Grades Diplom-Ingenieur(Dipl.-Ing.) Wien, October 2011 Matrikelnummer: 0309037 Studienrichtung: Scientific Computing A066 940 Begutachter: Ao. Univ.-Prof. Dipl.-Ing. Dr. Peter Brezany Ich versichere: dass ich die Diplomarbeit selbststndig verfasst, andere als die angegebenen Quellen und Hilfsmittel nicht benutzt und mich auch sonst keiner unerlaubten Hilfe bedient habe. dass ich diese Diplomarbeit bisher weder im In- noch im Ausland (einer Beurteilung bzw. einem Beurteiler zur Begutachtung) in irgendeiner Form als Prfungsarbeit vorgelegt habe. dass diese Arbeit mit der vom Begutachter beurteilten Arbeit bereinstimmt. Wien, October 2011 Sicen Ye Abstract Cloud Computing is a relatively newly emerged high performance parallel comput- ing paradigm. A lot of algorithms from the past could now find new opportunities and benefit from it. After several month of study on theory and implementation of On-Line Analytical Processing (OLAP), especially, the OLAP engine from the Grid- Miner project (http://www.gridminer.org), we decided to design and implement an OLAP system for Cloud Computing environment. For this cloud-enabled OLAP system we have also provided means for management and interaction with it, which are implemented by a multi-tier client subsystem including some business logic and Graphical User Interfaces (GUI) in an easy to use and understandable way. In this thesis the original design and implementation of the multi-tier client subsystem is described and discussed. Management and interaction with OLAP cloud means on one hand loading data from data source, transforming and transferring it to the OLAP cloud to construct data cube, On the other hand, submitting OLAP analysis queries and handling the results.
    [Show full text]
  • IBM Surveillance Insight for Financial Services Solution Guide
    IBM Surveillance Insight for Financial Services Version 2.0.1 IBM Surveillance Insight for Financial Services Solution Guide IBM Note Before using this information and the product it supports, read the information in “Notices” on page 103. Product Information This document applies to Version 2.0.1 and may also apply to subsequent releases. Licensed Materials - Property of IBM © Copyright International Business Machines Corporation 2016, 2017. US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp. Contents Introduction.......................................................................................................................... v Chapter 1. IBM Surveillance Insight for Financial Services......................................................1 The solution architecture...................................................................................................................................................1 Chapter 2. Surveillance Insight Workbench............................................................................ 3 Dashboard page................................................................................................................................................................. 3 Alert Details page...............................................................................................................................................................4 Employee Details page.......................................................................................................................................................6
    [Show full text]
  • 7X9 Word Template
    Apache Wink User Guide Software Version: 0.1 The Apache Wink User Guide document is a broad scope document that provides detailed information about the Apache Wink 0.1 design and implementation. Apache Wink 0.1 User Guide Table of Contents Apache Wink User Guide............................................................. 1 Table of Contents ......................................................................... 2 List of Tables ............................................................................... 8 1. Introduction .......................................................................... 9 1.1.1. Important Note ................................................................................................... 9 1.2. Target Audience .................................................................................................... 10 1.3. JAX-RS Compliancy .............................................................................................. 10 2. Apache Wink Architecture ................................................... 11 2.1. Wink Runtime Architecture Overview .................................................................. 11 2.2. Request Processor ................................................................................................. 12 2.3. Deployment Configuration .................................................................................... 13 2.3.1. Customization ................................................................................................... 13 2.4. Handler Chains ....................................................................................................
    [Show full text]
  • Vergleich Von Frameworks Zur Implementierung Von REST Basierten Anwendungen
    Institut für Architektur von Anwendungssystemen Universität Stuttgart Universitätsstraße 38 D–70569 Stuttgart Fachstudie Nr. 170 Vergleich von Frameworks zur Implementierung von REST basierten Anwendungen Markus Fischer und Kalman Kepes und Alexander Wassiljew Studiengang: Softwaretechnik Prüfer/in: Prof. Dr. Leymann Betreuer/in: Dipl.-Inf. Florian Haupt Beginn am: 2012-12-17 Beendet am: 2013-06-18 CR-Nummer: K 6.1, D 2.1, D 2.2, D 2.13, D 3.3 Kurzfassung Mit steigender Popularität des Architekturstils Representational State Transfer veröffentlicht in der Dissertation Architectural Styles and the Design of Network-based Software Architectures von Roy T. Fielding im Jahre 2000, wurden und werden immer mehr Arbeiten veröffent- licht die sich mit dem Thema beschäftigen. Darunter befinden sich auch Frameworks und Spezifikationen, die das Entwickeln von RESTful Services anhand der Aspekte von REST, wie beispielsweise Uniform Interface erleichtern wollen. In dieser Fachstudie werden eine Reihe von Frameworks, für das Entwickeln von RESTful Services vorgestellt und anhand eines Kriterienkatalogs ausgewertet und bewertet. Dieser Kriterienkatalog ist in 4 Kategorien eingeteilt. Darunter fallen Kriterien bezüglich der Dokumentation des Frameworks, die mit ihnen verbundenen Entwicklungsprozesse und inwieweit die REST Prinzipien mit Hilfe des Frameworks realisiert werden können. Weiterhin werden erweiterte technische Fähigkeiten betrachtet, wie beispielsweise Entwicklungsunterstützung für transaktionales Verhalten und Asynchronität, aber auch andere wichtige Aspekte für RESTful Applikationen, wie Sicherheit und Zuverlässigkeit. 3 Inhaltsverzeichnis 1. Einleitung 11 1.1. Einleitung........................................ 11 1.2. Gliederung........................................ 12 2. Verwandte Arbeiten 13 2.1. Guidelines for Designing REST Frameworks.................... 13 2.2. Zuzak NEA....................................... 14 2.3. REST: Die Architektur des Web............................ 14 2.4.
    [Show full text]
  • Developing Restful Web Services with JAX-RS
    <Insert Picture Here> Developing RESTful Web services with JAX-RS Arun Gupta, Java EE & GlassFish Guy blogs.oracle.com/arungupta, @arungupta The following/preceding is intended to outline our general product direction. It is intended for information purposes only, and may not be incorporated into any contract. It is not a commitment to deliver any material, code, or functionality, and should not be relied upon in making purchasing decisions. The development, release, and timing of any features or functionality described for Oracle’s products remains at the sole discretion of Oracle. 2 REST is an Architectural Style Style of software architecture for distributed hypermedia systems such as World Wide Web 3 RESTful Web Services Application of REST architectural style to services that utilize Web standards (URIs, HTTP, HTML, XML, Atom, RDF etc.) 4 Java API for RESTful Web Services (JAX-RS) Standard annotation-driven API that aims to help developers build RESTful Web services in Java 5 RESTful Application Cycle Resources are identified by URIs ↓ Clients communicate with resources via requests using a standard set of methods ↓ Requests and responses contain resource representations in formats identified by media types ↓ Responses contain URIs that link to further resources 6 Principles of REST • Give everything an ID • Standard set of methods • Link things together • Multiple representations • Stateless communications 7 Give Everything an ID • ID is a URI http://example.com/widgets/foo http://example.com/customers/bar http://example.com/customers/bar/orders/2
    [Show full text]
  • Bernd Hort, Assono Gmbh
    AD1238: REST Services in Domino - Key to modern Web Applications Bernd Hort, assono GmbH - February 1, 2016 Agenda • REST in a Nutshell • IBM Domino Access Services (DAS) • Extension Library: REST Service Control • Custom Database Servlet • Custom Wink Servlet • Questions and Answers Any code in this presentation and in the sample database is available under the Apache Software License v2! Bernd Hort, assono GmbH • IBM® Notes® Developer/Designer since Notes 3.3 • OpenNTF Contributer: assono Framework 2 • An OOP LotusScript Framework • Lately specialized in XPages, web and mobile development • Working for assono GmbH, Germany • Blog http://blog.assono.de • Twitter @BerndHort REST in a Nutshell • Representational state transfer (REST) is an architectural style bases on web standards for accessing resources • RESTful Web Services implements access and modification of resources • Mostly using HTTP • Resources may have different representations, e.g. text, xml, json etc. ▪ The rest client can ask for specific representation via the HTTP protocol (content negotiation). • No standard! • The WSDL equivalent Web Application Description Language (WADL) is mostly optional ▪ Hopefully the documentation is good ;-) REST in a Nutshell – Nouns and Verbs • Resources are identified via a URI - Nouns • Actions on resources uses the HTTP methods - Verbs Resource Get Post Put Delete Collections of Lists all resources Create a new entry Replace the entire Delete the entire resources http:// in the collection. collection with collection yourserver/path/ another collection. sessions Single resource Retrieve the details Normally not Replace the Delete the http://yourserver/ of a given resource implemented addressed member specified resource path/sessions/ of the collection, or AD1238 if it doesn't exist, create it.
    [Show full text]
  • Migrating Applications from Weblogic, Jboss and Tomcat to Websphere V6, SG24-6690: Hernan Cunico, Leonardo Fernandez, Christian Hellsten and Roman
    Front cover WebSphere Application Server V7 Competitive Migration Guide Learn migration strategy and planning Experiment with the Migration Toolkit Review migration case studies Joao Emilio S B da Silva Kiran Mantripragada Vasfi Gucer Kurtcebe Eroglu Hamdy Eed Fabio Xavier Albertoni ibm.com/redbooks International Technical Support Organization WebSphere Application Server V7: Competitive Migration Guide August 2010 SG24-7870-00 Note: Before using this information and the product it supports, read the information in “Notices” on page xix. First Edition (August 2010) This edition applies to IBM WebSphere Application Server Version 7.0. © Copyright International Business Machines Corporation 2010. All rights reserved. Note to U.S. Government Users Restricted Rights -- Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp. Contents Figures . xi Tables . xv Examples. xvii Notices . xix Trademarks . xx Preface . xxi The team who wrote this book . xxi Now you can become a published author, too! . xxiii Comments welcome. xxiii Stay connected to IBM Redbooks . xxiv Chapter 1. Introduction. 1 1.1 Objectives . 2 1.2 Scope of this book. 2 1.3 Applications covered in this book . 3 1.3.1 Java SE and EE technologies covered . 4 1.4 What is not covered in this book . 4 1.5 How to use this book . 5 Chapter 2. Common migration issues. 7 2.1 Java EE application server compatibility . 8 2.1.1 Differences in Java EE implementations. 8 2.1.2 Using vendor-specific features . 12 2.1.3 Deployment descriptors . 12 2.2 Application portability . 15 2.2.1 Application packaging . 15 2.2.2 Java source code .
    [Show full text]