- CACHE_CONTROL - Static variable in interface javax.ws.rs.core.HttpHeaders
-
- cacheControl(CacheControl) - Method in interface javax.ws.rs.client.Invocation.Builder
-
Set the cache control data of the message.
- CacheControl - Class in javax.ws.rs.core
-
An abstraction for the value of a HTTP Cache-Control response header.
- CacheControl() - Constructor for class javax.ws.rs.core.CacheControl
-
Create a new instance of CacheControl.
- cacheControl(CacheControl) - Method in class javax.ws.rs.core.Response.ResponseBuilder
-
Set the cache control data of the message.
- cancel() - Method in interface javax.ws.rs.container.AsyncResponse
-
Cancel the suspended request processing.
- cancel(int) - Method in interface javax.ws.rs.container.AsyncResponse
-
Cancel the suspended request processing.
- cancel(Date) - Method in interface javax.ws.rs.container.AsyncResponse
-
Cancel the suspended request processing.
- CHARSET_PARAMETER - Static variable in class javax.ws.rs.core.MediaType
-
The media type charset
parameter name.
- clear() - Method in class javax.ws.rs.core.AbstractMultivaluedMap
-
- Client - Interface in javax.ws.rs.client
-
Client is the main entry point to the fluent API used to build and execute client
requests in order to consume responses returned.
- CLIENT_CERT_AUTH - Static variable in interface javax.ws.rs.core.SecurityContext
-
String identifier for Client Certificate authentication.
- ClientBuilder - Class in javax.ws.rs.client
-
Main entry point to the client API used to bootstrap
Client
instances.
- ClientBuilder() - Constructor for class javax.ws.rs.client.ClientBuilder
-
Allows custom implementations to extend the ClientBuilder
class.
- ClientErrorException - Exception in javax.ws.rs
-
A base runtime application exception indicating a client request error
(HTTP 4xx
status codes).
- ClientErrorException(Response.Status) - Constructor for exception javax.ws.rs.ClientErrorException
-
Construct a new client error exception.
- ClientErrorException(int) - Constructor for exception javax.ws.rs.ClientErrorException
-
Construct a new client error exception.
- ClientErrorException(Response) - Constructor for exception javax.ws.rs.ClientErrorException
-
Construct a new client error exception.
- ClientErrorException(Response.Status, Throwable) - Constructor for exception javax.ws.rs.ClientErrorException
-
Construct a new client error exception.
- ClientErrorException(int, Throwable) - Constructor for exception javax.ws.rs.ClientErrorException
-
Construct a new client error exception.
- ClientErrorException(Response, Throwable) - Constructor for exception javax.ws.rs.ClientErrorException
-
Construct a new client error exception.
- ClientRequestContext - Interface in javax.ws.rs.client
-
Client request filter context.
- ClientRequestFilter - Interface in javax.ws.rs.client
-
An extension interface implemented by client request filters.
- ClientResponseContext - Interface in javax.ws.rs.client
-
Client response filter context.
- ClientResponseFilter - Interface in javax.ws.rs.client
-
An extension interface implemented by client response filters.
- clone() - Method in class javax.ws.rs.core.Response.ResponseBuilder
- clone() - Method in class javax.ws.rs.core.UriBuilder
-
Create a copy of the UriBuilder preserving its state.
- close() - Method in interface javax.ws.rs.client.Client
-
Close client instance and all it's associated resources.
- close() - Method in class javax.ws.rs.core.Response
-
Close the underlying message entity input stream (if available and open)
as well as releases any other resources associated with the response
(e.g.
- completed(RESPONSE) - Method in interface javax.ws.rs.client.InvocationCallback
-
Called when the invocation was successfully completed.
- CompletionCallback - Interface in javax.ws.rs.container
-
A request processing callback that receives request processing completion events.
- Configurable<C extends Configurable> - Interface in javax.ws.rs.core
-
Represents a client or server-side configurable context in JAX-RS.
- Configuration - Interface in javax.ws.rs.core
-
A configuration state associated with a
configurable
JAX-RS context.
- configure(ResourceInfo, FeatureContext) - Method in interface javax.ws.rs.container.DynamicFeature
-
- configure(FeatureContext) - Method in interface javax.ws.rs.core.Feature
-
A call-back method called when the feature is to be enabled in a given
runtime configuration scope.
- ConnectionCallback - Interface in javax.ws.rs.container
-
Asynchronous request processing lifecycle callback that receives connection
related
asynchronous response
lifecycle events.
- ConstrainedTo - Annotation Type in javax.ws.rs
-
Indicates the run-time context in which an annotated JAX-RS provider
is applicable.
- Consumes - Annotation Type in javax.ws.rs
-
Defines the media types that the methods of a resource class or
MessageBodyReader
can accept.
- ContainerRequestContext - Interface in javax.ws.rs.container
-
Container request filter context.
- ContainerRequestFilter - Interface in javax.ws.rs.container
-
An extension interface implemented by container request filters.
- ContainerResponseContext - Interface in javax.ws.rs.container
-
Container response filter context.
- ContainerResponseFilter - Interface in javax.ws.rs.container
-
An extension interface implemented by container response filters.
- containsKey(Object) - Method in class javax.ws.rs.core.AbstractMultivaluedMap
-
- containsValue(Object) - Method in class javax.ws.rs.core.AbstractMultivaluedMap
-
- CONTENT_DISPOSITION - Static variable in interface javax.ws.rs.core.HttpHeaders
-
- CONTENT_ENCODING - Static variable in interface javax.ws.rs.core.HttpHeaders
-
- CONTENT_ID - Static variable in interface javax.ws.rs.core.HttpHeaders
-
- CONTENT_LANGUAGE - Static variable in interface javax.ws.rs.core.HttpHeaders
-
- CONTENT_LENGTH - Static variable in interface javax.ws.rs.core.HttpHeaders
-
- CONTENT_LOCATION - Static variable in interface javax.ws.rs.core.HttpHeaders
-
- CONTENT_TYPE - Static variable in interface javax.ws.rs.core.HttpHeaders
-
- contentLocation(URI) - Method in class javax.ws.rs.core.Response.ResponseBuilder
-
Set the content location.
- Context - Annotation Type in javax.ws.rs.core
-
This annotation is used to inject information into a class
field, bean property or method parameter.
- ContextResolver<T> - Interface in javax.ws.rs.ext
-
Contract for a provider that supplies context information to resource
classes and other providers.
- cookie(Cookie) - Method in interface javax.ws.rs.client.Invocation.Builder
-
Add a cookie to be set.
- cookie(String, String) - Method in interface javax.ws.rs.client.Invocation.Builder
-
Add a cookie to be set.
- Cookie - Class in javax.ws.rs.core
-
Represents the value of a HTTP cookie, transferred in a request.
- Cookie(String, String, String, String, int) - Constructor for class javax.ws.rs.core.Cookie
-
Create a new instance.
- Cookie(String, String, String, String) - Constructor for class javax.ws.rs.core.Cookie
-
Create a new instance.
- Cookie(String, String) - Constructor for class javax.ws.rs.core.Cookie
-
Create a new instance.
- COOKIE - Static variable in interface javax.ws.rs.core.HttpHeaders
-
- cookie(NewCookie...) - Method in class javax.ws.rs.core.Response.ResponseBuilder
-
Add cookies to the response message.
- CookieParam - Annotation Type in javax.ws.rs
-
Binds the value of a HTTP cookie to a resource method parameter,
resource class field, or resource class bean property.
- created(URI) - Static method in class javax.ws.rs.core.Response
-
Create a new ResponseBuilder for a created resource, set the location
header using the supplied value.
- createEndpoint(Application, Class<T>) - Method in class javax.ws.rs.ext.RuntimeDelegate
-
Create a configured instance of the supplied endpoint type.
- createHeaderDelegate(Class<T>) - Method in class javax.ws.rs.ext.RuntimeDelegate
-
- createLinkBuilder() - Method in class javax.ws.rs.ext.RuntimeDelegate
-
- createResponseBuilder() - Method in class javax.ws.rs.ext.RuntimeDelegate
-
- createUriBuilder() - Method in class javax.ws.rs.ext.RuntimeDelegate
-
- createVariantListBuilder() - Method in class javax.ws.rs.ext.RuntimeDelegate
-
- GenericEntity<T> - Class in javax.ws.rs.core
-
Represents a message entity of a generic type T
.
- GenericEntity(T) - Constructor for class javax.ws.rs.core.GenericEntity
-
Constructs a new generic entity.
- GenericEntity(T, Type) - Constructor for class javax.ws.rs.core.GenericEntity
-
Create a new instance of GenericEntity, supplying the generic type information.
- GenericType<T> - Class in javax.ws.rs.core
-
Represents a generic message entity type T
.
- GenericType() - Constructor for class javax.ws.rs.core.GenericType
-
Constructs a new generic type, deriving the generic type and class from
type parameter.
- GenericType(Type) - Constructor for class javax.ws.rs.core.GenericType
-
Constructs a new generic type, supplying the generic type
information and deriving the class.
- get() - Method in interface javax.ws.rs.client.AsyncInvoker
-
Invoke HTTP GET method for the current request asynchronously.
- get(Class<T>) - Method in interface javax.ws.rs.client.AsyncInvoker
-
Invoke HTTP GET method for the current request asynchronously.
- get(GenericType<T>) - Method in interface javax.ws.rs.client.AsyncInvoker
-
Invoke HTTP GET method for the current request asynchronously.
- get(InvocationCallback<T>) - Method in interface javax.ws.rs.client.AsyncInvoker
-
Invoke HTTP GET method for the current request asynchronously.
- get() - Method in interface javax.ws.rs.client.SyncInvoker
-
Invoke HTTP GET method for the current request synchronously.
- get(Class<T>) - Method in interface javax.ws.rs.client.SyncInvoker
-
Invoke HTTP GET method for the current request synchronously.
- get(GenericType<T>) - Method in interface javax.ws.rs.client.SyncInvoker
-
Invoke HTTP GET method for the current request synchronously.
- get(Object) - Method in class javax.ws.rs.core.AbstractMultivaluedMap
-
- GET - Annotation Type in javax.ws.rs
-
Indicates that the annotated method responds to HTTP GET requests.
- GET - Static variable in annotation type javax.ws.rs.HttpMethod
-
HTTP GET method.
- getAbsolutePath() - Method in interface javax.ws.rs.core.UriInfo
-
Get the absolute path of the request.
- getAbsolutePathBuilder() - Method in interface javax.ws.rs.core.UriInfo
-
Get the absolute path of the request in the form of a UriBuilder.
- getAcceptableLanguages() - Method in interface javax.ws.rs.client.ClientRequestContext
-
Get a list of languages that are acceptable for the response.
- getAcceptableLanguages() - Method in interface javax.ws.rs.container.ContainerRequestContext
-
Get a list of languages that are acceptable for the response.
- getAcceptableLanguages() - Method in interface javax.ws.rs.core.HttpHeaders
-
Get a list of languages that are acceptable for the response.
- getAcceptableMediaTypes() - Method in interface javax.ws.rs.client.ClientRequestContext
-
Get a list of media types that are acceptable for the response.
- getAcceptableMediaTypes() - Method in interface javax.ws.rs.container.ContainerRequestContext
-
Get a list of media types that are acceptable for the response.
- getAcceptableMediaTypes() - Method in interface javax.ws.rs.core.HttpHeaders
-
Get a list of media types that are acceptable for the response.
- getAllowedMethods() - Method in interface javax.ws.rs.client.ClientResponseContext
-
Get the allowed HTTP methods from the Allow HTTP header.
- getAllowedMethods() - Method in interface javax.ws.rs.container.ContainerResponseContext
-
Get the allowed HTTP methods from the Allow HTTP header.
- getAllowedMethods() - Method in class javax.ws.rs.core.Response
-
Get the allowed HTTP methods from the Allow HTTP header.
- getAnnotations() - Method in class javax.ws.rs.client.Entity
-
Get the entity annotations.
- getAnnotations() - Method in interface javax.ws.rs.ext.InterceptorContext
-
Get an array of the annotations formally declared on the artifact that
initiated the intercepted entity provider invocation.
- getAuthenticationScheme() - Method in interface javax.ws.rs.core.SecurityContext
-
Returns the string value of the authentication scheme used to protect
the resource.
- getBaseUri() - Method in interface javax.ws.rs.core.UriInfo
-
Get the base URI of the application.
- getBaseUriBuilder() - Method in interface javax.ws.rs.core.UriInfo
-
Get the base URI of the application in the form of a UriBuilder.
- getCacheExtension() - Method in class javax.ws.rs.core.CacheControl
-
Corresponds to a set of extension cache control directives.
- getChallenges() - Method in exception javax.ws.rs.NotAuthorizedException
-
Get the list of authorization challenges associated with the exception and
applicable to the resource requested by the client.
- getClasses() - Method in class javax.ws.rs.core.Application
-
Get a set of root resource, provider and
feature
classes.
- getClasses() - Method in interface javax.ws.rs.core.Configuration
-
Get the immutable set of registered JAX-RS component (such as provider or
feature
) classes to be instantiated, injected and utilized in the scope
of the configurable instance.
- getClient() - Method in interface javax.ws.rs.client.ClientRequestContext
-
Get the client instance associated with the request.
- getComment() - Method in class javax.ws.rs.core.NewCookie
-
Get the comment associated with the cookie.
- getConfiguration() - Method in interface javax.ws.rs.client.ClientRequestContext
-
Get the immutable configuration of the request.
- getConfiguration() - Method in interface javax.ws.rs.core.Configurable
-
Get a live view of an internal configuration state of this configurable instance.
- getContext(Class<?>) - Method in interface javax.ws.rs.ext.ContextResolver
-
Get a context of type T
that is applicable to the supplied
type.
- getContextResolver(Class<T>, MediaType) - Method in interface javax.ws.rs.ext.Providers
-
Get a context resolver for a particular type of context and media type.
- getContracts(Class<?>) - Method in interface javax.ws.rs.core.Configuration
-
Get the extension contract registration information for a component of a given class.
- getConverter(Class<T>, Type, Annotation[]) - Method in interface javax.ws.rs.ext.ParamConverterProvider
-
Obtain a
ParamConverter
that can provide from/to string conversion
for an instance of a particular Java type.
- getCookies() - Method in interface javax.ws.rs.client.ClientRequestContext
-
Get any cookies that accompanied the request.
- getCookies() - Method in interface javax.ws.rs.client.ClientResponseContext
-
Get any new cookies set on the response message.
- getCookies() - Method in interface javax.ws.rs.container.ContainerRequestContext
-
Get any cookies that accompanied the request.
- getCookies() - Method in interface javax.ws.rs.container.ContainerResponseContext
-
Get any new cookies set on the response message.
- getCookies() - Method in interface javax.ws.rs.core.HttpHeaders
-
Get any cookies that accompanied the request.
- getCookies() - Method in class javax.ws.rs.core.Response
-
Get any new cookies set on the response message.
- getDate() - Method in interface javax.ws.rs.client.ClientRequestContext
-
Get message date.
- getDate() - Method in interface javax.ws.rs.client.ClientResponseContext
-
Get message date.
- getDate() - Method in interface javax.ws.rs.container.ContainerRequestContext
-
Get message date.
- getDate() - Method in interface javax.ws.rs.container.ContainerResponseContext
-
Get message date.
- getDate() - Method in interface javax.ws.rs.core.HttpHeaders
-
Get message date.
- getDate() - Method in class javax.ws.rs.core.Response
-
Get message date.
- getDomain() - Method in class javax.ws.rs.core.Cookie
-
Get the domain of the cookie.
- getEncoding() - Method in class javax.ws.rs.client.Entity
-
Get entity encoding.
- getEncoding() - Method in class javax.ws.rs.core.Variant
-
Get the encoding of the variant.
- getEntity() - Method in interface javax.ws.rs.client.ClientRequestContext
-
Get the message entity Java instance.
- getEntity() - Method in class javax.ws.rs.client.Entity
-
Get entity data.
- getEntity() - Method in interface javax.ws.rs.container.ContainerResponseContext
-
Get the message entity Java instance.
- getEntity() - Method in class javax.ws.rs.core.GenericEntity
-
Get the enclosed entity.
- getEntity() - Method in class javax.ws.rs.core.Response
-
Get the message entity Java instance.
- getEntity() - Method in interface javax.ws.rs.ext.WriterInterceptorContext
-
Get object to be written as HTTP entity.
- getEntityAnnotations() - Method in interface javax.ws.rs.client.ClientRequestContext
-
Get the annotations attached to the entity instance.
- getEntityAnnotations() - Method in interface javax.ws.rs.container.ContainerResponseContext
-
Get the annotations attached to the entity instance.
- getEntityClass() - Method in interface javax.ws.rs.client.ClientRequestContext
-
Get the raw entity type information.
- getEntityClass() - Method in interface javax.ws.rs.container.ContainerResponseContext
-
Get the raw entity type information.
- getEntityStream() - Method in interface javax.ws.rs.client.ClientRequestContext
-
Get the entity output stream.
- getEntityStream() - Method in interface javax.ws.rs.client.ClientResponseContext
-
Get the entity input stream.
- getEntityStream() - Method in interface javax.ws.rs.container.ContainerRequestContext
-
Get the entity input stream.
- getEntityStream() - Method in interface javax.ws.rs.container.ContainerResponseContext
-
Get the entity output stream.
- getEntityTag() - Method in interface javax.ws.rs.client.ClientResponseContext
-
Get the entity tag.
- getEntityTag() - Method in interface javax.ws.rs.container.ContainerResponseContext
-
Get the entity tag.
- getEntityTag() - Method in class javax.ws.rs.core.Response
-
Get the entity tag.
- getEntityType() - Method in interface javax.ws.rs.client.ClientRequestContext
-
Get the generic entity type information.
- getEntityType() - Method in interface javax.ws.rs.container.ContainerResponseContext
-
Get the generic entity type information.
- getExceptionMapper(Class<T>) - Method in interface javax.ws.rs.ext.Providers
-
Get an exception mapping provider for a particular class of exception.
- getExpiry() - Method in class javax.ws.rs.core.NewCookie
-
Get the cookie expiry date.
- getFamily() - Method in enum javax.ws.rs.core.Response.Status
-
Get the class of status code.
- getFamily() - Method in interface javax.ws.rs.core.Response.StatusType
-
Get the class of status code.
- getFirst(K) - Method in class javax.ws.rs.core.AbstractMultivaluedMap
-
- getFirst(K) - Method in interface javax.ws.rs.core.MultivaluedMap
-
A shortcut to get the first value of the supplied key.
- getGenericType() - Method in interface javax.ws.rs.ext.InterceptorContext
-
Get the type of the object to be produced or written.
- getHeaders() - Method in interface javax.ws.rs.client.ClientRequestContext
-
Get the mutable request headers multivalued map.
- getHeaders() - Method in interface javax.ws.rs.client.ClientResponseContext
-
Get the mutable response headers multivalued map.
- getHeaders() - Method in interface javax.ws.rs.container.ContainerRequestContext
-
Get the mutable request headers multivalued map.
- getHeaders() - Method in interface javax.ws.rs.container.ContainerResponseContext
-
Get the mutable response headers multivalued map.
- getHeaders() - Method in class javax.ws.rs.core.Response
-
Get view of the response headers and their object values.
- getHeaders() - Method in interface javax.ws.rs.ext.ReaderInterceptorContext
-
Get mutable map of HTTP headers.
- getHeaders() - Method in interface javax.ws.rs.ext.WriterInterceptorContext
-
Get mutable map of HTTP headers.
- getHeaderString(String) - Method in interface javax.ws.rs.client.ClientRequestContext
-
Get a message header as a single string value.
- getHeaderString(String) - Method in interface javax.ws.rs.client.ClientResponseContext
-
Get a message header as a single string value.
- getHeaderString(String) - Method in interface javax.ws.rs.container.ContainerRequestContext
-
Get a message header as a single string value.
- getHeaderString(String) - Method in interface javax.ws.rs.container.ContainerResponseContext
-
Get a message header as a single string value.
- getHeaderString(String) - Method in interface javax.ws.rs.core.HttpHeaders
-
Get a HTTP header as a single string value.
- getHeaderString(String) - Method in class javax.ws.rs.core.Response
-
Get a message header as a single string value.
- getInputStream() - Method in interface javax.ws.rs.ext.ReaderInterceptorContext
-
Get the input stream of the object to be read.
- getInstance() - Static method in class javax.ws.rs.ext.RuntimeDelegate
-
Obtain a RuntimeDelegate
instance.
- getInstances() - Method in interface javax.ws.rs.core.Configuration
-
Get the immutable set of registered JAX-RS component (such as provider or
feature
) instances to be utilized by the configurable instance.
- getLanguage() - Method in interface javax.ws.rs.client.ClientRequestContext
-
Get the language of the entity.
- getLanguage() - Method in interface javax.ws.rs.client.ClientResponseContext
-
Get the language of the entity.
- getLanguage() - Method in class javax.ws.rs.client.Entity
-
Get entity language.
- getLanguage() - Method in interface javax.ws.rs.container.ContainerRequestContext
-
Get the language of the entity.
- getLanguage() - Method in interface javax.ws.rs.container.ContainerResponseContext
-
Get the language of the entity.
- getLanguage() - Method in interface javax.ws.rs.core.HttpHeaders
-
Get the language of the request entity.
- getLanguage() - Method in class javax.ws.rs.core.Response
-
Get the language of the message entity.
- getLanguage() - Method in class javax.ws.rs.core.Variant
-
Get the language of the variant.
- getLanguageString() - Method in class javax.ws.rs.core.Variant
-
Get the string representation of the variant language,
or null
if no language has been set.
- getLastModified() - Method in interface javax.ws.rs.client.ClientResponseContext
-
Get the last modified date.
- getLastModified() - Method in interface javax.ws.rs.container.ContainerResponseContext
-
Get the last modified date.
- getLastModified() - Method in class javax.ws.rs.core.Response
-
Get the last modified date.
- getLength() - Method in interface javax.ws.rs.client.ClientResponseContext
-
Get Content-Length value.
- getLength() - Method in interface javax.ws.rs.container.ContainerRequestContext
-
Get Content-Length value.
- getLength() - Method in interface javax.ws.rs.container.ContainerResponseContext
-
Get Content-Length value.
- getLength() - Method in interface javax.ws.rs.core.HttpHeaders
-
Get Content-Length value.
- getLength() - Method in class javax.ws.rs.core.Response
-
Get Content-Length value.
- getLink(String) - Method in interface javax.ws.rs.client.ClientResponseContext
-
Get the link for the relation.
- getLink(String) - Method in interface javax.ws.rs.container.ContainerResponseContext
-
Get the link for the relation.
- getLink(String) - Method in class javax.ws.rs.core.Response
-
Get the link for the relation.
- getLinkBuilder(String) - Method in interface javax.ws.rs.client.ClientResponseContext
-
Convenience method that returns a
Link.Builder
for the relation.
- getLinkBuilder(String) - Method in interface javax.ws.rs.container.ContainerResponseContext
-
Convenience method that returns a
Link.Builder
for the relation.
- getLinkBuilder(String) - Method in class javax.ws.rs.core.Response
-
Convenience method that returns a
Link.Builder
for the relation.
- getLinks() - Method in interface javax.ws.rs.client.ClientResponseContext
-
Get the links attached to the message as header.
- getLinks() - Method in interface javax.ws.rs.container.ContainerResponseContext
-
Get the links attached to the message as header.
- getLinks() - Method in class javax.ws.rs.core.Response
-
Get the links attached to the message as headers.
- getLocation() - Method in interface javax.ws.rs.client.ClientResponseContext
-
Get the location.
- getLocation() - Method in interface javax.ws.rs.container.ContainerResponseContext
-
Get the location.
- getLocation() - Method in class javax.ws.rs.core.Response
-
Get the location.
- getLocation() - Method in exception javax.ws.rs.RedirectionException
-
Get the redirection response location.
- getMatchedResources() - Method in interface javax.ws.rs.core.UriInfo
-
Get a read-only list of the currently matched resource class instances.
- getMatchedURIs() - Method in interface javax.ws.rs.core.UriInfo
-
Get a read-only list of URIs for matched resources.
- getMatchedURIs(boolean) - Method in interface javax.ws.rs.core.UriInfo
-
Get a read-only list of URIs for matched resources.
- getMatrixParameters() - Method in interface javax.ws.rs.core.PathSegment
-
Get a map of the matrix parameters associated with the path segment.
- getMaxAge() - Method in class javax.ws.rs.core.CacheControl
-
Corresponds to the max-age cache control directive.
- getMaxAge() - Method in class javax.ws.rs.core.NewCookie
-
Get the maximum age of the the cookie in seconds.
- getMediaType() - Method in interface javax.ws.rs.client.ClientRequestContext
-
Get the media type of the entity.
- getMediaType() - Method in interface javax.ws.rs.client.ClientResponseContext
-
Get the media type of the entity.
- getMediaType() - Method in class javax.ws.rs.client.Entity
-
Get entity media type.
- getMediaType() - Method in interface javax.ws.rs.container.ContainerRequestContext
-
Get the media type of the entity.
- getMediaType() - Method in interface javax.ws.rs.container.ContainerResponseContext
-
Get the media type of the entity.
- getMediaType() - Method in interface javax.ws.rs.core.HttpHeaders
-
Get the media type of the request entity.
- getMediaType() - Method in class javax.ws.rs.core.Response
-
Get the media type of the message entity.
- getMediaType() - Method in class javax.ws.rs.core.Variant
-
Get the media type of the variant.
- getMediaType() - Method in interface javax.ws.rs.ext.InterceptorContext
-
Get media type of HTTP entity.
- getMessageBodyReader(Class<T>, Type, Annotation[], MediaType) - Method in interface javax.ws.rs.ext.Providers
-
Get a message body reader that matches a set of criteria.
- getMessageBodyWriter(Class<T>, Type, Annotation[], MediaType) - Method in interface javax.ws.rs.ext.Providers
-
Get a message body writer that matches a set of criteria.
- getMetadata() - Method in class javax.ws.rs.core.Response
-
- getMethod() - Method in interface javax.ws.rs.client.ClientRequestContext
-
Get the request method.
- getMethod() - Method in interface javax.ws.rs.container.ContainerRequestContext
-
Get the request method.
- getMethod() - Method in interface javax.ws.rs.core.Request
-
Get the request method, e.g.
- getName() - Method in class javax.ws.rs.core.Cookie
-
Get the name of the cookie.
- getNoCacheFields() - Method in class javax.ws.rs.core.CacheControl
-
Corresponds to the value of the no-cache cache control directive.
- getOutputStream() - Method in interface javax.ws.rs.ext.WriterInterceptorContext
-
Get the output stream for the object to be written.
- getParameters() - Method in class javax.ws.rs.core.MediaType
-
Getter for a read-only parameter map.
- getParams() - Method in class javax.ws.rs.core.Link
-
Returns an immutable map that includes all the link parameters
defined on this link.
- getParams() - Method in class javax.ws.rs.core.Link.JaxbLink
-
Get the parameter map for this link.
- getPath() - Method in class javax.ws.rs.core.Cookie
-
Get the path of the cookie.
- getPath() - Method in interface javax.ws.rs.core.PathSegment
-
Get the path segment.
- getPath() - Method in interface javax.ws.rs.core.UriInfo
-
Get the path of the current request relative to the base URI as a string.
- getPath(boolean) - Method in interface javax.ws.rs.core.UriInfo
-
Get the path of the current request relative to the base URI as a string.
- getPathParameters() - Method in interface javax.ws.rs.core.UriInfo
-
Get the values of any embedded URI template parameters.
- getPathParameters(boolean) - Method in interface javax.ws.rs.core.UriInfo
-
Get the values of any embedded URI template parameters.
- getPathSegments() - Method in interface javax.ws.rs.core.UriInfo
-
Get the path of the current request relative to the base URI as a
list of
PathSegment
.
- getPathSegments(boolean) - Method in interface javax.ws.rs.core.UriInfo
-
Get the path of the current request relative to the base URI as a list of
PathSegment
.
- getPrivateFields() - Method in class javax.ws.rs.core.CacheControl
-
Corresponds to the value of the private cache control directive.
- getProperties() - Method in class javax.ws.rs.core.Application
-
Get a map of custom application-wide properties.
- getProperties() - Method in interface javax.ws.rs.core.Configuration
-
Get the immutable bag of configuration properties.
- getProperty(String) - Method in interface javax.ws.rs.client.ClientRequestContext
-
Returns the property with the given name registered in the current request/response
exchange context, or null
if there is no property by that name.
- getProperty(String) - Method in interface javax.ws.rs.container.ContainerRequestContext
-
Returns the property with the given name registered in the current request/response
exchange context, or null
if there is no property by that name.
- getProperty(String) - Method in interface javax.ws.rs.core.Configuration
-
Get the value for the property with a given name.
- getProperty(String) - Method in interface javax.ws.rs.ext.InterceptorContext
-
Returns the property with the given name registered in the current request/response
exchange context, or null
if there is no property by that name.
- getPropertyNames() - Method in interface javax.ws.rs.client.ClientRequestContext
-
Returns an immutable
collection
containing the property names
available within the context of the current request/response exchange context.
- getPropertyNames() - Method in interface javax.ws.rs.container.ContainerRequestContext
-
Returns an immutable
collection
containing the property
names available within the context of the current request/response exchange context.
- getPropertyNames() - Method in interface javax.ws.rs.core.Configuration
-
Returns an immutable
collection
containing the
property names available within the context of the current configuration instance.
- getPropertyNames() - Method in interface javax.ws.rs.ext.InterceptorContext
-
Returns an immutable
collection
containing the property
names available within the context of the current request/response exchange context.
- getQueryParameters() - Method in interface javax.ws.rs.core.UriInfo
-
Get the URI query parameters of the current request.
- getQueryParameters(boolean) - Method in interface javax.ws.rs.core.UriInfo
-
Get the URI query parameters of the current request.
- getRawType() - Method in class javax.ws.rs.core.GenericEntity
-
Gets the raw type of the enclosed entity.
- getRawType() - Method in class javax.ws.rs.core.GenericType
-
Returns the object representing the class or interface that declared
the type represented by this generic type instance.
- getReasonPhrase() - Method in enum javax.ws.rs.core.Response.Status
-
Get the reason phrase.
- getReasonPhrase() - Method in interface javax.ws.rs.core.Response.StatusType
-
Get the reason phrase.
- getRel() - Method in class javax.ws.rs.core.Link
-
Returns the value associated with the link rel
param, or
null
if this param is not specified.
- getRels() - Method in class javax.ws.rs.core.Link
-
Returns the value associated with the link rel
param as a list
of strings or the empty list if rel
is not defined.
- getRequest() - Method in interface javax.ws.rs.container.ContainerRequestContext
-
Get the injectable request information.
- getRequestHeader(String) - Method in interface javax.ws.rs.core.HttpHeaders
-
Get the values of a HTTP request header.
- getRequestHeaders() - Method in interface javax.ws.rs.core.HttpHeaders
-
Get the values of HTTP request headers.
- getRequestUri() - Method in interface javax.ws.rs.core.UriInfo
-
Get the absolute request URI including any query parameters.
- getRequestUriBuilder() - Method in interface javax.ws.rs.core.UriInfo
-
Get the absolute request URI in the form of a UriBuilder.
- getResource(Class<T>) - Method in interface javax.ws.rs.container.ResourceContext
-
Get a resolved instance of a resource or sub-resource class.
- getResourceClass() - Method in interface javax.ws.rs.container.ResourceInfo
-
Get the resource class that is the target of a request,
or null
if this information is not available.
- getResourceMethod() - Method in interface javax.ws.rs.container.ResourceInfo
-
Get the resource method that is the target of a request,
or null
if this information is not available.
- getResponse() - Method in exception javax.ws.rs.client.ResponseProcessingException
-
Get the HTTP response for which the processing has failed.
- getResponse() - Method in exception javax.ws.rs.WebApplicationException
-
Get the HTTP response.
- getRetryTime(Date) - Method in exception javax.ws.rs.ServiceUnavailableException
-
Get the retry time for the failed request.
- getRuntimeType() - Method in interface javax.ws.rs.core.Configuration
-
Get the runtime type of this configuration context.
- getSecurityContext() - Method in interface javax.ws.rs.container.ContainerRequestContext
-
Get the injectable security context information for the current request.
- getSingletons() - Method in class javax.ws.rs.core.Application
-
Get a set of root resource, provider and
feature
instances.
- getSize(T, Class<?>, Type, Annotation[], MediaType) - Method in interface javax.ws.rs.ext.MessageBodyWriter
-
Originally, the method has been called before writeTo
to ascertain the length in bytes of
the serialized form of t
.
- getSMaxAge() - Method in class javax.ws.rs.core.CacheControl
-
Corresponds to the s-maxage cache control directive.
- getSslContext() - Method in interface javax.ws.rs.client.Client
-
Get the SSL context configured to be used with the current client run-time.
- getStatus() - Method in interface javax.ws.rs.client.ClientResponseContext
-
Get the status code associated with the response.
- getStatus() - Method in interface javax.ws.rs.container.ContainerResponseContext
-
Get the status code associated with the response.
- getStatus() - Method in class javax.ws.rs.core.Response
-
Get the status code associated with the response.
- getStatusCode() - Method in enum javax.ws.rs.core.Response.Status
-
Get the associated status code.
- getStatusCode() - Method in interface javax.ws.rs.core.Response.StatusType
-
Get the associated status code.
- getStatusInfo() - Method in interface javax.ws.rs.client.ClientResponseContext
-
Get the complete status information associated with the response.
- getStatusInfo() - Method in interface javax.ws.rs.container.ContainerResponseContext
-
Get the complete status information associated with the response.
- getStatusInfo() - Method in class javax.ws.rs.core.Response
-
Get the complete status information associated with the response.
- getStringHeaders() - Method in interface javax.ws.rs.client.ClientRequestContext
-
Get a string view of header values associated with the message.
- getStringHeaders() - Method in interface javax.ws.rs.container.ContainerResponseContext
-
Get a string view of header values associated with the message.
- getStringHeaders() - Method in class javax.ws.rs.core.Response
-
Get view of the response headers and their string values.
- getSubtype() - Method in class javax.ws.rs.core.MediaType
-
Getter for subtype.
- getTitle() - Method in class javax.ws.rs.core.Link
-
Returns the value associated with the link title
param, or
null
if this param is not specified.
- getType() - Method in class javax.ws.rs.core.GenericEntity
-
Gets underlying Type
instance.
- getType() - Method in class javax.ws.rs.core.GenericType
-
Retrieve the type represented by the generic type instance.
- getType() - Method in class javax.ws.rs.core.Link
-
Returns the value associated with the link type
param, or
null
if this param is not specified.
- getType() - Method in class javax.ws.rs.core.MediaType
-
Getter for primary type.
- getType() - Method in interface javax.ws.rs.ext.InterceptorContext
-
Get Java type supported by corresponding message body provider.
- getUri() - Method in interface javax.ws.rs.client.ClientRequestContext
-
Get the request URI.
- getUri() - Method in interface javax.ws.rs.client.WebTarget
-
Get the URI identifying the resource.
- getUri() - Method in class javax.ws.rs.core.Link
-
Returns the underlying URI associated with this link.
- getUri() - Method in class javax.ws.rs.core.Link.JaxbLink
-
Get the underlying URI for this link.
- getUriBuilder() - Method in interface javax.ws.rs.client.WebTarget
-
Get the URI builder initialized with the
URI
of the current
resource target.
- getUriBuilder() - Method in class javax.ws.rs.core.Link
-
Convenience method that returns a
UriBuilder
initialized with this link's underlying URI.
- getUriInfo() - Method in interface javax.ws.rs.container.ContainerRequestContext
-
Get request URI information.
- getUserPrincipal() - Method in interface javax.ws.rs.core.SecurityContext
-
Returns a java.security.Principal
object containing the
name of the current authenticated user.
- getValue() - Method in class javax.ws.rs.core.Cookie
-
Get the value of the cookie.
- getValue() - Method in class javax.ws.rs.core.EntityTag
-
Get the value of an EntityTag
.
- getValues(K) - Method in class javax.ws.rs.core.AbstractMultivaluedMap
-
Return a non-null list of values for a given key.
- getVariant() - Method in class javax.ws.rs.client.Entity
-
- getVersion() - Method in class javax.ws.rs.core.Cookie
-
Get the version of the cookie.
- param(String, String) - Method in class javax.ws.rs.core.Form
-
Adds a new value to the specified form parameter.
- param(String, String) - Method in interface javax.ws.rs.core.Link.Builder
-
Set an arbitrary parameter on this link.
- ParamConverter<T> - Interface in javax.ws.rs.ext
-
Defines a contract for a delegate responsible for converting between a
String
form of a message parameter value and the corresponding custom
Java type T
.
- ParamConverter.Lazy - Annotation Type in javax.ws.rs.ext
-
Mandates that a conversion of any
default value
delegated
to a
parameter converter
annotated with
@Lazy
annotation SHOULD occur only once the value is actually required (e.g.
- ParamConverterProvider - Interface in javax.ws.rs.ext
-
- path(String) - Method in interface javax.ws.rs.client.WebTarget
-
Create a new WebTarget
instance by appending path to the URI of
the current target instance.
- path(String) - Method in class javax.ws.rs.core.UriBuilder
-
Append path to the existing path.
- path(Class) - Method in class javax.ws.rs.core.UriBuilder
-
Append the path from a Path-annotated class to the
existing path.
- path(Class, String) - Method in class javax.ws.rs.core.UriBuilder
-
Append the path from a Path-annotated method to the
existing path.
- path(Method) - Method in class javax.ws.rs.core.UriBuilder
-
Append the path from a
Path
-annotated method to the
existing path.
- Path - Annotation Type in javax.ws.rs
-
Identifies the URI path that a resource class or class method will serve
requests for.
- PathParam - Annotation Type in javax.ws.rs
-
Binds the value of a URI template parameter or a path segment
containing the template parameter to a resource method parameter, resource
class field, or resource class
bean property.
- PathSegment - Interface in javax.ws.rs.core
-
Represents a URI path segment and any associated matrix parameters.
- port(int) - Method in class javax.ws.rs.core.UriBuilder
-
Set the URI port.
- post(Entity<?>) - Method in interface javax.ws.rs.client.AsyncInvoker
-
Invoke HTTP POST method for the current request asynchronously.
- post(Entity<?>, Class<T>) - Method in interface javax.ws.rs.client.AsyncInvoker
-
Invoke HTTP POST method for the current request asynchronously.
- post(Entity<?>, GenericType<T>) - Method in interface javax.ws.rs.client.AsyncInvoker
-
Invoke HTTP POST method for the current request asynchronously.
- post(Entity<?>, InvocationCallback<T>) - Method in interface javax.ws.rs.client.AsyncInvoker
-
Invoke HTTP POST method for the current request asynchronously.
- post(Entity<?>) - Method in interface javax.ws.rs.client.SyncInvoker
-
Invoke HTTP POST method for the current request synchronously.
- post(Entity<?>, Class<T>) - Method in interface javax.ws.rs.client.SyncInvoker
-
Invoke HTTP POST method for the current request synchronously.
- post(Entity<?>, GenericType<T>) - Method in interface javax.ws.rs.client.SyncInvoker
-
Invoke HTTP POST method for the current request synchronously.
- POST - Static variable in annotation type javax.ws.rs.HttpMethod
-
HTTP POST method.
- POST - Annotation Type in javax.ws.rs
-
Indicates that the annotated method responds to HTTP POST requests.
- PreMatching - Annotation Type in javax.ws.rs.container
-
Global binding annotation that can be applied to a
container request filter
to indicate that such filter should be applied globally
on all resources in the application before the actual resource matching occurs.
- Priorities - Class in javax.ws.rs
-
A collection of built-in priority constants for the JAX-RS components that are supposed to be
ordered based on their
priority
when used or applied
by JAX-RS runtime.
- proceed() - Method in interface javax.ws.rs.ext.ReaderInterceptorContext
-
Proceed to the next interceptor in the chain.
- proceed() - Method in interface javax.ws.rs.ext.WriterInterceptorContext
-
Proceed to the next interceptor in the chain.
- ProcessingException - Exception in javax.ws.rs
-
A base JAX-RS runtime processing exception.
- ProcessingException(Throwable) - Constructor for exception javax.ws.rs.ProcessingException
-
Constructs a new JAX-RS runtime processing exception with the specified cause
and a detail message of (cause==null ? null : cause.toString())
(which typically contains the class and detail message of cause
).
- ProcessingException(String, Throwable) - Constructor for exception javax.ws.rs.ProcessingException
-
Constructs a new JAX-RS runtime processing exception with the specified detail
message and cause.
- ProcessingException(String) - Constructor for exception javax.ws.rs.ProcessingException
-
Constructs a new JAX-RS runtime processing exception with the specified detail
message.
- Produces - Annotation Type in javax.ws.rs
-
Defines the media type(s) that the methods of a resource class or
MessageBodyWriter
can produce.
- property(String, Object) - Method in interface javax.ws.rs.core.Configurable
-
Set the new configuration property, if already set, the existing value of
the property will be updated.
- Provider - Annotation Type in javax.ws.rs.ext
-
Marks an implementation of an extension interface that should be discoverable
by JAX-RS runtime during a provider scanning phase.
- Providers - Interface in javax.ws.rs.ext
-
An injectable interface providing runtime lookup of provider instances.
- put(Entity<?>) - Method in interface javax.ws.rs.client.AsyncInvoker
-
Invoke HTTP PUT method for the current request asynchronously.
- put(Entity<?>, Class<T>) - Method in interface javax.ws.rs.client.AsyncInvoker
-
Invoke HTTP PUT method for the current request asynchronously.
- put(Entity<?>, GenericType<T>) - Method in interface javax.ws.rs.client.AsyncInvoker
-
Invoke HTTP PUT method for the current request asynchronously.
- put(Entity<?>, InvocationCallback<T>) - Method in interface javax.ws.rs.client.AsyncInvoker
-
Invoke HTTP PUT method for the current request asynchronously.
- put(Entity<?>) - Method in interface javax.ws.rs.client.SyncInvoker
-
Invoke HTTP PUT method for the current request synchronously.
- put(Entity<?>, Class<T>) - Method in interface javax.ws.rs.client.SyncInvoker
-
Invoke HTTP PUT method for the current request synchronously.
- put(Entity<?>, GenericType<T>) - Method in interface javax.ws.rs.client.SyncInvoker
-
Invoke HTTP PUT method for the current request synchronously.
- put(K, List<V>) - Method in class javax.ws.rs.core.AbstractMultivaluedMap
-
- PUT - Static variable in annotation type javax.ws.rs.HttpMethod
-
HTTP PUT method.
- PUT - Annotation Type in javax.ws.rs
-
Indicates that the annotated method responds to HTTP PUT requests.
- putAll(Map<? extends K, ? extends List<V>>) - Method in class javax.ws.rs.core.AbstractMultivaluedMap
-
- putSingle(K, V) - Method in class javax.ws.rs.core.AbstractMultivaluedMap
-
Set the value for the key to be a one item list consisting of the supplied
value.
- putSingle(K, V) - Method in interface javax.ws.rs.core.MultivaluedMap
-
Set the key's value to be a one item list consisting of the supplied value.
- readEntity(Class<T>) - Method in class javax.ws.rs.core.Response
-
Read the message entity input stream as an instance of specified Java type
using a
MessageBodyReader
that supports mapping the
message entity stream onto the requested type.
- readEntity(GenericType<T>) - Method in class javax.ws.rs.core.Response
-
Read the message entity input stream as an instance of specified Java type
using a
MessageBodyReader
that supports mapping the
message entity stream onto the requested type.
- readEntity(Class<T>, Annotation[]) - Method in class javax.ws.rs.core.Response
-
Read the message entity input stream as an instance of specified Java type
using a
MessageBodyReader
that supports mapping the
message entity stream onto the requested type.
- readEntity(GenericType<T>, Annotation[]) - Method in class javax.ws.rs.core.Response
-
Read the message entity input stream as an instance of specified Java type
using a
MessageBodyReader
that supports mapping the
message entity stream onto the requested type.
- ReaderInterceptor - Interface in javax.ws.rs.ext
-
- ReaderInterceptorContext - Interface in javax.ws.rs.ext
-
Context class used by
ReaderInterceptor
to intercept calls to (@link javax.ws.rs.ext.MessageBodyReader#readFrom}.
- readFrom(Class<T>, Type, Annotation[], MediaType, MultivaluedMap<String, String>, InputStream) - Method in interface javax.ws.rs.ext.MessageBodyReader
-
- RedirectionException - Exception in javax.ws.rs
-
A runtime application exception indicating a request redirection
(HTTP 3xx
status codes).
- RedirectionException(Response.Status, URI) - Constructor for exception javax.ws.rs.RedirectionException
-
Construct a new redirection exception.
- RedirectionException(int, URI) - Constructor for exception javax.ws.rs.RedirectionException
-
Construct a new redirection exception.
- RedirectionException(Response) - Constructor for exception javax.ws.rs.RedirectionException
-
Construct a new redirection exception.
- register(Class<?>) - Method in interface javax.ws.rs.container.AsyncResponse
-
Register an asynchronous processing lifecycle callback class to receive lifecycle
events for the asynchronous response based on the implemented callback interfaces.
- register(Class<?>, Class<?>...) - Method in interface javax.ws.rs.container.AsyncResponse
-
Register asynchronous processing lifecycle callback classes to receive lifecycle
events for the asynchronous response based on the implemented callback interfaces.
- register(Object) - Method in interface javax.ws.rs.container.AsyncResponse
-
Register an asynchronous processing lifecycle callback instance to receive lifecycle
events for the asynchronous response based on the implemented callback interfaces.
- register(Object, Object...) - Method in interface javax.ws.rs.container.AsyncResponse
-
Register an asynchronous processing lifecycle callback instances to receive lifecycle
events for the asynchronous response based on the implemented callback interfaces.
- register(Class<?>) - Method in interface javax.ws.rs.core.Configurable
-
Register a class of a custom JAX-RS component (such as an extension provider or
a
feature
meta-provider) to be instantiated
and used in the scope of this configurable context.
- register(Class<?>, int) - Method in interface javax.ws.rs.core.Configurable
-
Register a class of a custom JAX-RS component (such as an extension provider or
a
feature
meta-provider) to be instantiated
and used in the scope of this configurable context.
- register(Class<?>, Class<?>...) - Method in interface javax.ws.rs.core.Configurable
-
Register a class of a custom JAX-RS component (such as an extension provider or
a
feature
meta-provider) to be instantiated
and used in the scope of this configurable context.
- register(Class<?>, Map<Class<?>, Integer>) - Method in interface javax.ws.rs.core.Configurable
-
Register a class of a custom JAX-RS component (such as an extension provider or
a
feature
meta-provider) to be instantiated
and used in the scope of this configurable context.
- register(Object) - Method in interface javax.ws.rs.core.Configurable
-
Register an instance of a custom JAX-RS component (such as an extension provider or
a
feature
meta-provider) to be instantiated
and used in the scope of this configurable context.
- register(Object, int) - Method in interface javax.ws.rs.core.Configurable
-
Register an instance of a custom JAX-RS component (such as an extension provider or
a
feature
meta-provider) to be instantiated
and used in the scope of this configurable context.
- register(Object, Class<?>...) - Method in interface javax.ws.rs.core.Configurable
-
Register an instance of a custom JAX-RS component (such as an extension provider or
a
feature
meta-provider) to be instantiated
and used in the scope of this configurable context.
- register(Object, Map<Class<?>, Integer>) - Method in interface javax.ws.rs.core.Configurable
-
Register an instance of a custom JAX-RS component (such as an extension provider or
a
feature
meta-provider) to be instantiated
and used in the scope of this configurable context.
- rel(String) - Method in interface javax.ws.rs.core.Link.Builder
-
Convenience method to set a link relation.
- REL - Static variable in class javax.ws.rs.core.Link
-
Rel link param from RFC 5988.
- relativize(URI) - Method in interface javax.ws.rs.core.UriInfo
-
Relativize a URI with respect to the current request URI.
- relativize(URI, URI) - Method in interface javax.ws.rs.core.UriInfo
-
Relativize a URI as follows:
If URI to relativize is already relative, it is first resolved using
UriInfo.resolve(java.net.URI)
and the result is normalized.
The resulting URI is relativize with respect to the first URI passed to
this method.
- remove(Object) - Method in class javax.ws.rs.core.AbstractMultivaluedMap
-
- removeProperty(String) - Method in interface javax.ws.rs.client.ClientRequestContext
-
Removes a property with the given name from the current request/response
exchange context.
- removeProperty(String) - Method in interface javax.ws.rs.container.ContainerRequestContext
-
Removes a property with the given name from the current request/response
exchange context.
- removeProperty(String) - Method in interface javax.ws.rs.ext.InterceptorContext
-
Removes a property with the given name from the current request/response
exchange context.
- replaceAll(MultivaluedMap<String, Object>) - Method in class javax.ws.rs.core.Response.ResponseBuilder
-
Replaces all existing headers with the newly supplied headers.
- replaceMatrix(String) - Method in class javax.ws.rs.core.UriBuilder
-
Set the matrix parameters of the current final segment of the current URI path.
- replaceMatrixParam(String, Object...) - Method in class javax.ws.rs.core.UriBuilder
-
Replace the existing value(s) of a matrix parameter on
the current final segment of the URI path.
- replacePath(String) - Method in class javax.ws.rs.core.UriBuilder
-
Set the URI path.
- replaceQuery(String) - Method in class javax.ws.rs.core.UriBuilder
-
Set the URI query string.
- replaceQueryParam(String, Object...) - Method in class javax.ws.rs.core.UriBuilder
-
Replace the existing value(s) of a query parameter.
- replaceWith(Configuration) - Method in interface javax.ws.rs.core.Configurable
-
Replace the existing configuration state with an externally provided configuration state.
- request() - Method in interface javax.ws.rs.client.WebTarget
-
Start building a request to the targeted web resource.
- request(String...) - Method in interface javax.ws.rs.client.WebTarget
-
Start building a request to the targeted web resource and define the accepted
response media types.
- request(MediaType...) - Method in interface javax.ws.rs.client.WebTarget
-
Start building a request to the targeted web resource and define the accepted
response media types.
- Request - Interface in javax.ws.rs.core
-
An injectable helper for request processing, all methods throw an
IllegalStateException
if called outside the scope of a request
(e.g.
- resolve(URI) - Method in interface javax.ws.rs.core.UriInfo
-
Resolve a relative URI with respect to the base URI of the application.
- resolve(URI, URI) - Method in interface javax.ws.rs.core.UriInfo
-
Resolve a relative URI with respect to a base URI.
- resolveTemplate(String, Object) - Method in interface javax.ws.rs.client.WebTarget
-
Create a new WebTarget
instance by resolving a URI template with a given name
in the URI of the current target instance using a supplied value.
- resolveTemplate(String, Object, boolean) - Method in interface javax.ws.rs.client.WebTarget
-
Create a new WebTarget
instance by resolving a URI template with a given name
in the URI of the current target instance using a supplied value.
- resolveTemplate(String, Object) - Method in class javax.ws.rs.core.UriBuilder
-
Resolve a URI template with a given name
in this UriBuilder
instance
using a supplied value.
- resolveTemplate(String, Object, boolean) - Method in class javax.ws.rs.core.UriBuilder
-
Resolve a URI template with a given name
in this UriBuilder
instance
using a supplied value.
- resolveTemplateFromEncoded(String, Object) - Method in interface javax.ws.rs.client.WebTarget
-
Create a new WebTarget
instance by resolving a URI template with a given name
in the URI of the current target instance using a supplied encoded value.
- resolveTemplateFromEncoded(String, Object) - Method in class javax.ws.rs.core.UriBuilder
-
Resolve a URI template with a given name
in this UriBuilder
instance
using a supplied encoded value.
- resolveTemplates(Map<String, Object>) - Method in interface javax.ws.rs.client.WebTarget
-
Create a new WebTarget
instance by resolving one or more URI templates
in the URI of the current target instance using supplied name-value pairs.
- resolveTemplates(Map<String, Object>, boolean) - Method in interface javax.ws.rs.client.WebTarget
-
Create a new WebTarget
instance by resolving one or more URI templates
in the URI of the current target instance using supplied name-value pairs.
- resolveTemplates(Map<String, Object>) - Method in class javax.ws.rs.core.UriBuilder
-
Resolve one or more URI templates in this UriBuilder
instance using supplied
name-value pairs.
- resolveTemplates(Map<String, Object>, boolean) - Method in class javax.ws.rs.core.UriBuilder
-
Resolve one or more URI templates in this UriBuilder
instance using supplied
name-value pairs.
- resolveTemplatesFromEncoded(Map<String, Object>) - Method in interface javax.ws.rs.client.WebTarget
-
Create a new WebTarget
instance by resolving one or more URI templates
in the URI of the current target instance using supplied name-encoded value pairs.
- resolveTemplatesFromEncoded(Map<String, Object>) - Method in class javax.ws.rs.core.UriBuilder
-
Resolve one or more URI templates in this UriBuilder
instance using supplied
name-value pairs.
- ResourceContext - Interface in javax.ws.rs.container
-
The resource context provides access to instances of resource classes.
- ResourceInfo - Interface in javax.ws.rs.container
-
An injectable class to access the resource class and resource method
matched by the current request.
- Response - Class in javax.ws.rs.core
-
Defines the contract between a returned instance and the runtime when
an application needs to provide meta-data to the runtime.
- Response() - Constructor for class javax.ws.rs.core.Response
-
Protected constructor, use one of the static methods to obtain a
Response.ResponseBuilder
instance and obtain a Response from that.
- Response.ResponseBuilder - Class in javax.ws.rs.core
-
A class used to build Response instances that contain metadata instead
of or in addition to an entity.
- Response.ResponseBuilder() - Constructor for class javax.ws.rs.core.Response.ResponseBuilder
-
Protected constructor, use one of the static methods of
Response
to obtain an instance.
- Response.Status - Enum in javax.ws.rs.core
-
- Response.Status.Family - Enum in javax.ws.rs.core
-
An enumeration representing the class of status code.
- Response.StatusType - Interface in javax.ws.rs.core
-
Base interface for statuses used in responses.
- ResponseProcessingException - Exception in javax.ws.rs.client
-
JAX-RS client-side runtime processing exception thrown to indicate that
response processing has failed (e.g.
- ResponseProcessingException(Response, Throwable) - Constructor for exception javax.ws.rs.client.ResponseProcessingException
-
Constructs a new JAX-RS runtime response processing exception
for a specific
response
with the specified cause
and a detail message of
(cause==null ? null : cause.toString())
(which typically contains the class and detail message of
cause
).
- ResponseProcessingException(Response, String, Throwable) - Constructor for exception javax.ws.rs.client.ResponseProcessingException
-
Constructs a new JAX-RS runtime response processing exception with the specified detail
message and cause.
- ResponseProcessingException(Response, String) - Constructor for exception javax.ws.rs.client.ResponseProcessingException
-
Constructs a new JAX-RS runtime processing exception with the specified detail
message.
- resume(Object) - Method in interface javax.ws.rs.container.AsyncResponse
-
Resume the suspended request processing using the provided response data.
- resume(Throwable) - Method in interface javax.ws.rs.container.AsyncResponse
-
Resume the suspended request processing using the provided throwable.
- RETRY_AFTER - Static variable in interface javax.ws.rs.core.HttpHeaders
-
- RuntimeDelegate - Class in javax.ws.rs.ext
-
Implementations of JAX-RS provide a concrete subclass of RuntimeDelegate and
various JAX-RS API methods defer to methods of RuntimeDelegate for their
functionality.
- RuntimeDelegate() - Constructor for class javax.ws.rs.ext.RuntimeDelegate
-
Allows custom implementations to extend the RuntimeDelegate
class.
- RuntimeDelegate.HeaderDelegate<T> - Interface in javax.ws.rs.ext
-
Defines the contract for a delegate that is responsible for
converting between the String form of a HTTP header and
the corresponding JAX-RS type T
.
- RuntimeType - Enum in javax.ws.rs
-
Enumeration of JAX-RS runtime types.
- scheme(String) - Method in class javax.ws.rs.core.UriBuilder
-
Set the URI scheme.
- schemeSpecificPart(String) - Method in class javax.ws.rs.core.UriBuilder
-
Set the URI scheme-specific-part (see
URI
).
- SecurityContext - Interface in javax.ws.rs.core
-
An injectable interface that provides access to security related
information.
- seeOther(URI) - Static method in class javax.ws.rs.core.Response
-
Create a new ResponseBuilder for a redirection.
- segment(String...) - Method in class javax.ws.rs.core.UriBuilder
-
Append path segments to the existing path.
- selectVariant(List<Variant>) - Method in interface javax.ws.rs.core.Request
-
Select the representation variant that best matches the request.
- serverError() - Static method in class javax.ws.rs.core.Response
-
Create a new ResponseBuilder with an server error status.
- ServerErrorException - Exception in javax.ws.rs
-
A base runtime application exception indicating a server error
(HTTP 5xx
status codes).
- ServerErrorException(Response.Status) - Constructor for exception javax.ws.rs.ServerErrorException
-
Construct a new server error exception.
- ServerErrorException(int) - Constructor for exception javax.ws.rs.ServerErrorException
-
Construct a new server error exception.
- ServerErrorException(Response) - Constructor for exception javax.ws.rs.ServerErrorException
-
Construct a new server error exception.
- ServerErrorException(Response.Status, Throwable) - Constructor for exception javax.ws.rs.ServerErrorException
-
Construct a new server error exception.
- ServerErrorException(int, Throwable) - Constructor for exception javax.ws.rs.ServerErrorException
-
Construct a new server error exception.
- ServerErrorException(Response, Throwable) - Constructor for exception javax.ws.rs.ServerErrorException
-
Construct a new server error exception.
- ServiceUnavailableException - Exception in javax.ws.rs
-
- ServiceUnavailableException() - Constructor for exception javax.ws.rs.ServiceUnavailableException
-
Construct a new "service unavailable" exception without any "Retry-After" information
specified for the failed request.
- ServiceUnavailableException(Long) - Constructor for exception javax.ws.rs.ServiceUnavailableException
-
Construct a new "service unavailable" exception with an interval specifying
the "Retry-After" information for the failed request.
- ServiceUnavailableException(Date) - Constructor for exception javax.ws.rs.ServiceUnavailableException
-
Construct a new "service unavailable" exception with an interval specifying
the "Retry-After" information for the failed request.
- ServiceUnavailableException(Response) - Constructor for exception javax.ws.rs.ServiceUnavailableException
-
Construct a new "service unavailable" exception.
- ServiceUnavailableException(Date, Throwable) - Constructor for exception javax.ws.rs.ServiceUnavailableException
-
Construct a new "service unavailable" exception with a date specifying
the "Retry-After" information for the failed request and an underlying
request failure cause.
- ServiceUnavailableException(Long, Throwable) - Constructor for exception javax.ws.rs.ServiceUnavailableException
-
Construct a new "service unavailable" exception with an interval specifying
the "Retry-After" information for the failed request and an underlying
request failure cause.
- ServiceUnavailableException(Response, Throwable) - Constructor for exception javax.ws.rs.ServiceUnavailableException
-
Construct a new "service unavailable" exception.
- SET_COOKIE - Static variable in interface javax.ws.rs.core.HttpHeaders
-
- setAnnotations(Annotation[]) - Method in interface javax.ws.rs.ext.InterceptorContext
-
Update annotations on the formal declaration of the artifact that
initiated the intercepted entity provider invocation.
- setEntity(Object, Annotation[], MediaType) - Method in interface javax.ws.rs.client.ClientRequestContext
-
Set a new response message entity.
- setEntity(Object, Annotation[], MediaType) - Method in interface javax.ws.rs.container.ContainerResponseContext
-
Set a new response message entity.
- setEntity(Object) - Method in interface javax.ws.rs.ext.WriterInterceptorContext
-
Update object to be written as HTTP entity.
- setEntityStream(OutputStream) - Method in interface javax.ws.rs.client.ClientRequestContext
-
Set a new entity output stream.
- setEntityStream(InputStream) - Method in interface javax.ws.rs.client.ClientResponseContext
-
Set a new entity input stream.
- setEntityStream(InputStream) - Method in interface javax.ws.rs.container.ContainerRequestContext
-
Set a new entity input stream.
- setEntityStream(OutputStream) - Method in interface javax.ws.rs.container.ContainerResponseContext
-
Set a new entity output stream.
- setGenericType(Type) - Method in interface javax.ws.rs.ext.InterceptorContext
-
Update type of the object to be produced or written.
- setInputStream(InputStream) - Method in interface javax.ws.rs.ext.ReaderInterceptorContext
-
Update the input stream of the object to be read.
- setInstance(RuntimeDelegate) - Static method in class javax.ws.rs.ext.RuntimeDelegate
-
Set the runtime delegate that will be used by JAX-RS classes.
- setMaxAge(int) - Method in class javax.ws.rs.core.CacheControl
-
Corresponds to the max-age cache control directive.
- setMediaType(MediaType) - Method in interface javax.ws.rs.ext.InterceptorContext
-
Update media type of HTTP entity.
- setMethod(String) - Method in interface javax.ws.rs.client.ClientRequestContext
-
Set the request method.
- setMethod(String) - Method in interface javax.ws.rs.container.ContainerRequestContext
-
Set the request method.
- setMustRevalidate(boolean) - Method in class javax.ws.rs.core.CacheControl
-
Corresponds to the must-revalidate cache control directive.
- setNoCache(boolean) - Method in class javax.ws.rs.core.CacheControl
-
Corresponds to the no-cache cache control directive.
- setNoStore(boolean) - Method in class javax.ws.rs.core.CacheControl
-
Corresponds to the no-store cache control directive.
- setNoTransform(boolean) - Method in class javax.ws.rs.core.CacheControl
-
Corresponds to the no-transform cache control directive.
- setOutputStream(OutputStream) - Method in interface javax.ws.rs.ext.WriterInterceptorContext
-
Update the output stream for the object to be written.
- setPrivate(boolean) - Method in class javax.ws.rs.core.CacheControl
-
Corresponds to the private cache control directive.
- setProperty(String, Object) - Method in interface javax.ws.rs.client.ClientRequestContext
-
Binds an object to a given property name in the current request/response
exchange context.
- setProperty(String, Object) - Method in interface javax.ws.rs.container.ContainerRequestContext
-
Binds an object to a given property name in the current request/response
exchange context.
- setProperty(String, Object) - Method in interface javax.ws.rs.ext.InterceptorContext
-
Binds an object to a given property name in the current request/response
exchange context.
- setProxyRevalidate(boolean) - Method in class javax.ws.rs.core.CacheControl
-
Corresponds to the must-revalidate cache control directive.
- setRequestUri(URI) - Method in interface javax.ws.rs.container.ContainerRequestContext
-
Set a new request URI using the current base URI of the application to
resolve the application-specific request URI part.
- setRequestUri(URI, URI) - Method in interface javax.ws.rs.container.ContainerRequestContext
-
Set a new request URI using a new base URI to resolve the application-specific
request URI part.
- setSecurityContext(SecurityContext) - Method in interface javax.ws.rs.container.ContainerRequestContext
-
Set a new injectable security context information for the current request.
- setSMaxAge(int) - Method in class javax.ws.rs.core.CacheControl
-
Corresponds to the s-maxage cache control directive.
- setStatus(int) - Method in interface javax.ws.rs.client.ClientResponseContext
-
Set a new response status code.
- setStatus(int) - Method in interface javax.ws.rs.container.ContainerResponseContext
-
Set a new response status code.
- setStatusInfo(Response.StatusType) - Method in interface javax.ws.rs.client.ClientResponseContext
-
Set the complete status information (status code and reason phrase) associated
with the response.
- setStatusInfo(Response.StatusType) - Method in interface javax.ws.rs.container.ContainerResponseContext
-
Set the complete status information (status code and reason phrase) associated
with the response.
- setTimeout(long, TimeUnit) - Method in interface javax.ws.rs.container.AsyncResponse
-
Set/update the suspend timeout.
- setTimeoutHandler(TimeoutHandler) - Method in interface javax.ws.rs.container.AsyncResponse
-
Set/replace a time-out handler for the suspended asynchronous response.
- setType(Class<?>) - Method in interface javax.ws.rs.ext.InterceptorContext
-
Update Java type before calling message body provider.
- setUri(URI) - Method in interface javax.ws.rs.client.ClientRequestContext
-
Set a new request URI.
- size() - Method in class javax.ws.rs.core.AbstractMultivaluedMap
-
- sslContext(SSLContext) - Method in class javax.ws.rs.client.ClientBuilder
-
Set the SSL context that will be used when creating secured transport connections
to server endpoints from
web targets
created by the client
instance that is using this SSL context.
- status(int) - Method in class javax.ws.rs.core.Response.ResponseBuilder
-
Set the status on the ResponseBuilder.
- status(Response.StatusType) - Method in class javax.ws.rs.core.Response.ResponseBuilder
-
Set the status on the ResponseBuilder.
- status(Response.Status) - Method in class javax.ws.rs.core.Response.ResponseBuilder
-
Set the status on the ResponseBuilder.
- status(Response.StatusType) - Static method in class javax.ws.rs.core.Response
-
Create a new ResponseBuilder with the supplied status.
- status(Response.Status) - Static method in class javax.ws.rs.core.Response
-
Create a new ResponseBuilder with the supplied status.
- status(int) - Static method in class javax.ws.rs.core.Response
-
Create a new ResponseBuilder with the supplied status.
- store - Variable in class javax.ws.rs.core.AbstractMultivaluedMap
-
Backing store for the [key, multi-value] pairs.
- StreamingOutput - Interface in javax.ws.rs.core
-
A type that may be used as a resource method return value or as the entity
in a
Response
when the application wishes to stream the output.
- submit() - Method in interface javax.ws.rs.client.Invocation
-
Submit the request for an asynchronous invocation and receive a future
response back.
- submit(Class<T>) - Method in interface javax.ws.rs.client.Invocation
-
Submit the request for an asynchronous invocation and receive a future
response of the specified type back.
- submit(GenericType<T>) - Method in interface javax.ws.rs.client.Invocation
-
Submit the request for an asynchronous invocation and receive a future
response of the specified generic type back.
- submit(InvocationCallback<T>) - Method in interface javax.ws.rs.client.Invocation
-
Submit the request for an asynchronous invocation and register an
InvocationCallback
to process the future result of the invocation.
- Suspended - Annotation Type in javax.ws.rs.container
-
- SyncInvoker - Interface in javax.ws.rs.client
-
Uniform interface for synchronous invocation of HTTP methods.