Index

Symbols

@Consumes, Custom readers
@Context, Context annotation, Overview
@CookieParam, Injecting information from a cookie
@DefaultValue, Specifying a default value to inject
@DELETE, Specifying HTTP verbs
@Encoded, Disabling URI decoding
@FormParam, Injecting data from HTML forms
@GET, Specifying HTTP verbs
@HEAD, Specifying HTTP verbs
@HeaderParam, Injecting information from the HTTP headers
@MatrixParam, Using matrix parameters
@Path, Setting the path, Requirements, Specifying a sub-resource
@PathParam, Getting data from the URI's path
@POST, Specifying HTTP verbs
@Produces, Custom writers
@Provider, Implementing an exception mapper, Custom readers, Custom writers
@PUT, Specifying HTTP verbs
@QueryParam, Using query parameters

A

annotations

@Consumes (see @Consumes)
@Context (see @Context)
@CookieParam (see @CookieParam)
@DefaultValue (see @DefaultValue)
@DELETE (see @DELETE)
@Encoded (see @Encoded)
@FormParam (see @FormParam)
@GET (see @GET)
@HEAD (see @HEAD)
@HeaderParam (see @HeaderParam)
@MatrixParam (see @MatrixParam)
@Path (see @Path)
@PathParam (see @PathParam)
@POST (see @POST)
@Produces (see @Produces)
@Provider (see @Provider)
@PUT (see @PUT)
@QueryParam (see @QueryParam)
inheritance, Annotation Inheritance

B

build(), Relationship between a response and a response builder

C

CacheControl, Setting cache control directives
cacheControl(), Setting cache control directives
ContextResolver<T>, Adding contexts
cookie(), Adding a cookie
cookies, Injecting information from a cookie

E

entity parameter, Parameters
ExceptionMapper<E>, Implementing an exception mapper

F

form parameters, Injecting data from HTML forms
forms, Injecting data from HTML forms

G

GenericEntity<T>, Returning entities with generic type information

H

header(), Adding custom headers

HTML forms, Injecting data from HTML forms

HTTP

DELETE, Specifying HTTP verbs
GET, Specifying HTTP verbs
HEAD, Specifying HTTP verbs
POST, Specifying HTTP verbs
PUT, Specifying HTTP verbs

HTTP headers, Injecting information from the HTTP headers, Types of contexts

HttpHeaders, Types of contexts

M

matrix parameters, Using matrix parameters, Getting the matrix parameters
MessageBodyReader, Custom readers
MessageBodyWriter, Custom writers

N

NewCookie, Adding a cookie
noContent(), Creating responses for successful requests
notAcceptable(), Creating responses to signal errors
notModified(), Creating responses for redirection

O

ok(), Creating responses for successful requests

P

parameter constraints, Parameters
PathSegment, Getting the path

Q

query parameters, Using query parameters, Getting the query parameters

R

Request, Types of contexts

ResourceComparator, Customizing the selection process

Response, Relationship between a response and a response builder, Providing an entity body, Implementing an exception mapper

Response.Status, Setting the status code returned to the client

ResponseBuilder, Relationship between a response and a response builder, Getting a response builder, Handling more advanced responses

ResponseBuilderImpl, Getting a response builder, Handling more advanced responses

root resource

requirements, Requirements

root URI, Requirements, Working with the URI

S

SecurityContext, Types of contexts
seeOther(), Creating responses for redirection
serverError(), Creating responses to signal errors
status(), Setting the response status
sub-resource locator, Sub-resource locators
sub-resource method, Sub-resource methods

T

temporaryRedirect(), Creating responses for redirection

U

URI

decoding, Disabling URI decoding
injecting, Overview
matrix parameters, Using matrix parameters, Getting the matrix parameters
query parameters, Using query parameters, Getting the query parameters
root, Requirements, Working with the URI
template variables, Getting data from the URI's path, Getting the value of URI template variables

UriBuilder, Getting the Base URI, Getting the full request URI

UriInfo, Types of contexts, Working with the full request URI

W

WebApplicationException, Using WebApplicaitonException exceptions to report errors

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

© 2024 Red Hat, Inc.