Contents

Title and Copyright Information

Preface

• Documentation Accessibility
• Conventions

What's New in This Guide

• New and Changed Features for Release 12c (12.2.1.1.0)
• New and Changed Features for Release 12c (12.2.1)
• New and Changed Features for Release 12c (12.1.3)
• New and Changed Features for Release 12c (12.1.2)

1 Introduction to RESTful Web Services

• Introduction to the REST Architectural Style
• What are RESTful Web Services?
• Standards Supported for RESTful Web Service Development on WebLogic Server
• Roadmap for Implementing RESTful Web Services
• Learn More About RESTful Web Services

2 Developing RESTful Web Services

• About RESTful Web Service Development
  • Summary of Tasks to Develop RESTful Web Services
  • Example of a RESTful Web Service
• Defining the Root Resource Class
• Defining the Relative URI of the Root Resource and Subresources
  • How to Define the Relative URI of the Resource Class (@Path)
  • How to Define the Relative URI of Subresources (@Path)
  • What Happens at Runtime: How the Base URI is Constructed
• Mapping Incoming HTTP Requests to Java Methods
  • About the Jersey Bookmark Sample
  • How to Transmit a Representation of the Resource (@GET)
  • How to Create or Update the Representation of the Resource (@PUT)
  • How to Delete a Representation of the Resource (@DELETE)
  • How to Create, Update, or Perform an Action on a Representation of the Resource (@POST)
• Customizing Media Types for the Request and Response Messages
  • How To Customize Media Types for the Request Message (@Consumes)
  • How To Customize Media Types for the Response Message (@Produces)
  • What Happens At Runtime: How the Resource Method Is Selected for Response Messages
• Extracting Information From the Request Message
  • How to Extract Variable Information from the Request URI (@PathParam)
  • How to Extract Request Parameters (@QueryParam)
  • How to Define the DefaultValue (@DefaultValue)
  • Enabling the Encoding Parameter Values (@Encoded)
• Building Custom Response Messages
• Mapping HTTP Request and Response Entity Bodies Using Entity Providers
• Accessing the Application Context
• Building URIs
• Using Conditional GETs
• Accessing the WADL
• More Advanced RESTful Web Service Tasks

3 Developing RESTful Web Service Clients

• Summary of Tasks to Develop RESTful Web Service Clients
• Example of a RESTful Web Service Client
• Invoking a RESTful Web Service from a Standalone Client

4 Building, Packaging, and Deploying RESTful Web Service Applications

• Building RESTful Web Service Applications
• Packaging RESTful Web Service Applications
  • Packaging With an Application Subclass
  • Packaging With a Servlet
    • How to Package the RESTful Web Service Application with Servlet 3.0
      • Packaging the RESTful Web Service Application Using web.xml With Application Subclass
      • Packaging the RESTful Web Service Application Using web.xml Without Application Subclass
    • How to Package the RESTful Web Service Application with Pre-3.0 Servlets
  • Packaging as a Default Resource
• Deploying RESTful Web Service Applications

5 Securing RESTful Web Services and Clients

• About RESTful Web Service Security
• Securing RESTful Web Services and Clients Using OWSM Policies
• Securing RESTful Web Services Using web.xml
• Securing RESTful Web Services Using SecurityContext
• Securing RESTful Web Services Using Java Security Annotations

6 Testing RESTful Web Services

7 Monitoring RESTful Web Services and Clients

• About Monitoring RESTful Web Services
• Monitoring RESTful Web Services Using Enterprise Manager Fusion Middleware Control
• Monitoring RESTful Web Services Using the Administration Console
• Monitoring RESTful Web Services Using WLST
• Enabling the Tracing Feature
• Disabling RESTful Web Service Application Monitoring
  • Disabling Monitoring for a RESTful Web Service Application Using Jersey Property
  • Disabling Monitoring for a RESTful Web Service Application Using WebLogic Configuration MBean
  • Disabling RESTful Web Service Application Monitoring for a WebLogic Domain
• Enable Monitoring of Synthetic Jersey Resources in a RESTful Web Service Application

8 Using Server-Sent Events in WebLogic Server

• Overview of Server-Sent Events (SSE)
• Understanding the WebLogic Server-Sent Events API
• Sample Applications for Server-Sent Events

A Compatibility with Earlier Jersey/JAX-RS Releases

• Develop RESTful Web Service Clients Using Jersey 1.18 (JAX-RS 1.1 RI)
  • Example of a RESTful Web Service Client
  • Creating and Configuring a Client Instance
  • Creating a Web Resource Instance
  • Sending Requests to the Resource
    • How to Build Requests
    • How to Send HTTP Requests
    • How to Pass Query Parameters
    • How to Configure the Accept Header
    • How to Add a Custom Header
    • How to Configure the Request Entity
  • Receiving a Response from a Resource
    • How to Access the Status of Request
    • How to Get the Response Entity
  • More Advanced RESTful Web Service Client Tasks
• Support for Jersey 1.18 (JAX-RS 1.1 RI) Deployments Packaged with Pre-3.0 Servlets