book

RESTful Java with JAX-RS 2.0, 2nd Edition

by Bill Burke

November 2013

Intermediate to advanced

392 pages

8h 59m

English

O'Reilly Media, Inc.

Start your free trial

Related skills

Jakarta RESTful Web Services (JAX-RS)

Author’s NoteWho Should Read This BookHow This Book Is OrganizedPart I, REST and the JAX-RS StandardPart II, JAX-RS WorkbookConventions Used in This BookUsing Code ExamplesSafari® Books OnlineHow to Contact UsAcknowledgments
REST and the Rebirth of HTTPRESTful Architectural PrinciplesAddressabilityThe Uniform, Constrained InterfaceWhy Is the Uniform Interface Important?Representation-OrientedCommunicate StatelesslyHATEOASThe engine of application stateWrapping Up
The Object ModelModel the URIsDefining the Data FormatRead and Update FormatCommon link elementThe detailsCreate FormatAssigning HTTP MethodsBrowsing All Orders, Customers, or ProductsObtaining Individual Orders, Customers, or ProductsCreating an Order, Customer, or ProductCreating with PUTCreating with POSTUpdating an Order, Customer, or ProductRemoving an Order, Customer, or ProductCancelling an OrderOverloading the meaning of DELETEStates versus operationsWrapping Up
Developing a JAX-RS RESTful ServiceCustomer: The Data ClassCustomerResource: Our JAX-RS ServiceCreating customersRetrieving customersUpdating a customerUtility methodsJAX-RS and Java InterfacesInheritanceDeploying Our ServiceWriting a ClientWrapping Up
Binding HTTP MethodsHTTP Method Extensions@PathBinding URIs@Path ExpressionsTemplate parametersRegular expressionsPrecedence rulesEncodingMatrix ParametersSubresource LocatorsFull Dynamic DispatchingGotchas in Request MatchingWrapping Up
The Basics@PathParamMore Than One Path ParameterScope of Path ParametersPathSegment and Matrix ParametersMatching with multiple PathSegmentsProgrammatic URI Information@MatrixParam@QueryParamProgrammatic Query Parameter Information@FormParam@HeaderParamRaw Headers@CookieParam@BeanParamCommon FunctionalityAutomatic Java Type ConversionPrimitive type conversionJava object conversionParamConvertersCollectionsConversion failures@DefaultValue@EncodedWrapping Up
Built-in Content Marshallingjavax.ws.rs.core.StreamingOutputjava.io.InputStream, java.io.Readerjava.io.Filebyte[]String, char[]MultivaluedMap<String, String> and Form Inputjavax.xml.transform.SourceJAXBIntro to JAXBJAXB JAX-RS HandlersManaging your own JAXBContexts with ContextResolversJAXB and JSONXML to JSON using BadgerFishJSON and JSON SchemaCustom MarshallingMessageBodyWriterAdding pretty printingPluggable JAXBContexts using ContextResolversMessageBodyReaderLife Cycle and EnvironmentWrapping Up
Default Response CodesSuccessful ResponsesError ResponsesComplex ResponsesReturning CookiesThe Status Enumjavax.ws.rs.core.GenericEntityException Handlingjavax.ws.rs.WebApplicationExceptionException MappingException HierarchyMapping default exceptionsWrapping Up

Client IntroductionBootstrapping with ClientBuilderClient and WebTargetBuilding and Invoking RequestsInvocationException HandlingConfiguration ScopesWrapping Up
Conneg ExplainedPreference OrderingLanguage NegotiationEncoding NegotiationJAX-RS and ConnegMethod DispatchingLeveraging Conneg with JAXBComplex NegotiationViewing Accept headersVariant processingNegotiation by URI PatternsLeveraging Content NegotiationCreating New Media TypesFlexible SchemasWrapping Up
HATEOAS and Web ServicesAtom LinksAdvantages of Using HATEOAS with Web ServicesLocation transparencyDecoupling interaction detailsReduced state transition errorsW3C standardized relationshipsLink Headers Versus Atom LinksHATEOAS and JAX-RSBuilding URIs with UriBuilderRelative URIs with UriInfoBuilding Links and Link HeadersWriting Link HeadersEmbedding Links in XMLWrapping Up
CachingHTTP CachingExpires HeaderCache-ControlRevalidation and Conditional GETsLast-ModifiedETagJAX-RS and conditional GETsConcurrencyJAX-RS and Conditional UpdatesWrapping Up
Server-Side FiltersServer Request FiltersServer Response FiltersReader and Writer InterceptorsClient-Side FiltersDeploying Filters and InterceptorsOrdering Filters and InterceptorsPer-JAX-RS Method BindingsDynamicFeatureName BindingsDynamicFeature Versus @NameBindingException ProcessingWrapping Up
AsyncInvoker Client APIUsing FuturesException handlingUsing CallbacksFutures Versus CallbacksServer Asynchronous Response ProcessingAsyncResponse APIException HandlingCancelStatus MethodsTimeoutsCallbacksUse Cases for AsyncResponseServer-side pushPublish and subscribePriority schedulingWrapping Up
DeploymentThe Application ClassDeployment Within a JAX-RS-Aware ContainerDeployment Within a JAX-RS-Unaware ContainerConfigurationBasic ConfigurationEJB IntegrationSpring IntegrationWrapping Up
AuthenticationBasic AuthenticationDigest AuthenticationClient Certificate AuthenticationAuthorizationAuthentication and Authorization in JAX-RSEnforcing EncryptionAuthorization AnnotationsProgrammatic SecurityClient SecurityVerifying the ServerOAuth 2.0Signing and Encrypting Message BodiesDigital SignaturesDKIM/DOSETAJOSE JWSEncrypting RepresentationsWrapping Up
java.net.URLCachingAuthenticationClient Certificate AuthenticationAdvantages and DisadvantagesApache HttpClientAuthenticationClient Certificate authenticationAdvantages and DisadvantagesRESTEasy Client ProxiesAdvantages and DisadvantagesWrapping Up
Installing RESTEasy and the ExamplesExample Requirements and StructureCode Directory StructureEnvironment Setup
Build and Run the Example ProgramDeconstructing pom.xmlRunning the BuildExamining the Source Code
Example ex04_1: HTTP Method ExtensionBuild and Run the Example ProgramThe Server CodeThe Client CodeExample ex04_2: @Path with ExpressionsBuild and Run the Example ProgramThe Server CodeThe Client CodeExample ex04_3: Subresource LocatorsBuild and Run the Example ProgramThe Server CodeThe Client Code
Example ex05_1: Injecting URI InformationThe Server CodeThe Client CodeBuild and Run the Example ProgramExample ex05_2: Forms and CookiesThe Server CodeBuild and Run the Example Program
Example ex06_1: Using JAXBThe Client CodeChanges to pom.xmlBuild and Run the Example ProgramExample ex06_2: Creating a Content HandlerThe Content Handler CodeThe Resource ClassThe Application ClassThe Client CodeBuild and Run the Example Program
Example ex07_1: ExceptionMapperThe Client CodeBuild and Run the Example Program
Example ex09_1: Conneg with JAX-RSThe Client CodeBuild and Run the Example ProgramExample ex09_2: Conneg via URL PatternsThe Server CodeBuild and Run the Example Program
Example ex10_1: Atom LinksThe Server CodeThe Client CodeBuild and Run the Example ProgramExample ex10_2: Link HeadersThe Server CodeOrderResourceStoreResourceThe Client CodeBuild and Run the Example Program
Example ex11_1: Caching and Concurrent UpdatesThe Server CodeThe Client CodeBuild and Run the Example Program
Example ex12_1 : ContainerResponseFilter and DynamicFeatureThe Server CodeThe Client CodeBuild and Run the Example ProgramExample ex12_2: Implementing a WriterInterceptorThe Client CodeBuild and Run the Example Program
Example ex13_1: Chat REST InterfaceThe Client CodeThe Server CodePosting a new messageHandling poll requestsBuild and Run the Example Program
Example ex14_1: EJB and JAX-RSProject StructureThe EJBsThe Remaining Server CodeThe ExceptionMappersChanges to Application classThe Client CodeBuild and Run the Example ProgramExample ex14_2: Spring and JAX-RSBuild and Run the Example Program
Example ex15_1: Custom SecurityOne-Time Password AuthenticationThe server codeAllowed-per-Day Access PolicyThe client codeBuild and Run the Example ProgramExample ex15_1: JSON Web EncryptionBuild and Run the Example Program

Overview

Learn how to design and develop distributed web services in Java, using RESTful architectural principles and the JAX-RS 2.0 specification in Java EE 7. By focusing on implementation rather than theory, this hands-on reference demonstrates how easy it is to get started with services based on the REST architecture.

With the book’s technical guide, you’ll learn how REST and JAX-RS work and when to use them. The RESTEasy workbook that follows provides step-by-step instructions for installing, configuring, and running several working JAX-RS examples, using the JBoss RESTEasy implementation of JAX-RS 2.0.

Learn JAX-RS 2.0 features, including a client API, server-side asynchronous HTTP, and filters and interceptors
Examine the design of a distributed RESTful interface for an e-commerce order entry system
Use the JAX-RS Response object to return complex responses to your client (ResponseBuilder)
Increase the performance of your services by leveraging HTTP caching protocols
Deploy and integrate web services within Java EE7, servlet containers, EJB, Spring, and JPA
Learn popular mechanisms to perform authentication on the Web, including client-side SSL and OAuth 2.0