A B C D E F G H I J L M N O P Q R S T U V W

A

ACCEPT - Static variable in interface javax.ws.rs.core.HttpHeaders

See HTTP/1.1 documentation.

ACCEPT_CHARSET - Static variable in interface javax.ws.rs.core.HttpHeaders

See HTTP/1.1 documentation.

ACCEPT_ENCODING - Static variable in interface javax.ws.rs.core.HttpHeaders

See HTTP/1.1 documentation.

ACCEPT_LANGUAGE - Static variable in interface javax.ws.rs.core.HttpHeaders

See HTTP/1.1 documentation.

add(K, V) - Method in interface javax.ws.rs.core.MultivaluedMap

Add a value to the current list of values for the supplied key.

add() - Method in class javax.ws.rs.core.Variant.VariantListBuilder

Add the current combination of metadata to the list of supported variants, after this method is called the current combination of metadata is emptied.

Application - Class in javax.ws.rs.core

Defines the components of a JAX-RS application and supplies additional metadata.

Application() - Constructor for class javax.ws.rs.core.Application

APPLICATION_ATOM_XML - Static variable in class javax.ws.rs.core.MediaType

"application/atom+xml"

APPLICATION_ATOM_XML_TYPE - Static variable in class javax.ws.rs.core.MediaType

"application/atom+xml"

APPLICATION_FORM_URLENCODED - Static variable in class javax.ws.rs.core.MediaType

"application/x-www-form-urlencoded"

APPLICATION_FORM_URLENCODED_TYPE - Static variable in class javax.ws.rs.core.MediaType

"application/x-www-form-urlencoded"

APPLICATION_JSON - Static variable in class javax.ws.rs.core.MediaType

"application/json"

APPLICATION_JSON_TYPE - Static variable in class javax.ws.rs.core.MediaType

"application/json"

APPLICATION_OCTET_STREAM - Static variable in class javax.ws.rs.core.MediaType

"application/octet-stream"

APPLICATION_OCTET_STREAM_TYPE - Static variable in class javax.ws.rs.core.MediaType

"application/octet-stream"

APPLICATION_SVG_XML - Static variable in class javax.ws.rs.core.MediaType

"application/svg+xml"

APPLICATION_SVG_XML_TYPE - Static variable in class javax.ws.rs.core.MediaType

"application/svg+xml"

APPLICATION_XHTML_XML - Static variable in class javax.ws.rs.core.MediaType

"application/xhtml+xml"

APPLICATION_XHTML_XML_TYPE - Static variable in class javax.ws.rs.core.MediaType

"application/xhtml+xml"

APPLICATION_XML - Static variable in class javax.ws.rs.core.MediaType

"application/xml"

APPLICATION_XML_TYPE - Static variable in class javax.ws.rs.core.MediaType

"application/xml"

ApplicationPath - Annotation Type in javax.ws.rs

Identifies the application path that serves as the base URI for all resource URIs provided by Path.

argumentsMustNotBeNull() - Method in interface org.jboss.resteasy.jaxrs_api.i18n.Messages

AUTHORIZATION - Static variable in interface javax.ws.rs.core.HttpHeaders

See HTTP/1.1 documentation.

B

BASE - Static variable in interface org.jboss.resteasy.jaxrs_api.i18n.Messages

BASIC_AUTH - Static variable in interface javax.ws.rs.core.SecurityContext

String identifier for Basic authentication.

build() - Method in class javax.ws.rs.core.Response.ResponseBuilder

Create a Response instance from the current ResponseBuilder.

build(Object...) - Method in class javax.ws.rs.core.UriBuilder

Build a URI, using the supplied values in order to replace any URI template parameters.

build() - Method in class javax.ws.rs.core.Variant.VariantListBuilder

Build a list of representation variants from the current state of the builder.

buildFromEncoded(Object...) - Method in class javax.ws.rs.core.UriBuilder

Build a URI.

buildFromEncodedMap(Map<String, ? extends Object>) - Method in class javax.ws.rs.core.UriBuilder

Build a URI, any URI template parameters will be replaced by the value in the supplied map.

buildFromMap(Map<String, ? extends Object>) - Method in class javax.ws.rs.core.UriBuilder

Build a URI, any URI template parameters will be replaced by the value in the supplied map.

C

CACHE_CONTROL - Static variable in interface javax.ws.rs.core.HttpHeaders

See HTTP/1.1 documentation.

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 on the ResponseBuilder.

classCastException(URL, String) - Method in interface org.jboss.resteasy.jaxrs_api.i18n.Messages

CLIENT_CERT_AUTH - Static variable in interface javax.ws.rs.core.SecurityContext

String identifier for Client Certificate authentication.

clone() - Method in class javax.ws.rs.core.Response.ResponseBuilder

Create a copy of the ResponseBuilder preserving its state.

clone() - Method in class javax.ws.rs.core.UriBuilder

Create a copy of the UriBuilder preserving its state.

Consumes - Annotation Type in javax.ws.rs

Defines the media types that the methods of a resource class or MessageBodyReader can accept.

CONTENT_ENCODING - Static variable in interface javax.ws.rs.core.HttpHeaders

See HTTP/1.1 documentation.

CONTENT_LANGUAGE - Static variable in interface javax.ws.rs.core.HttpHeaders

See HTTP/1.1 documentation.

CONTENT_LENGTH - Static variable in interface javax.ws.rs.core.HttpHeaders

See HTTP/1.1 documentation.

CONTENT_LOCATION - Static variable in interface javax.ws.rs.core.HttpHeaders

See HTTP/1.1 documentation.

CONTENT_TYPE - Static variable in interface javax.ws.rs.core.HttpHeaders

See HTTP/1.1 documentation.

contentLocation(URI) - Method in class javax.ws.rs.core.Response.ResponseBuilder

Set the content location on the ResponseBuilder.

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 - 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

See IETF RFC 2109.

cookie(NewCookie...) - Method in class javax.ws.rs.core.Response.ResponseBuilder

Add cookies to the ResponseBuilder.

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.

couldNotFindFromFactoryFile(URL) - Method in interface org.jboss.resteasy.jaxrs_api.i18n.Messages

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

Obtain an instance of a HeaderDelegate for the supplied class.

createResponseBuilder() - Method in class javax.ws.rs.ext.RuntimeDelegate

Create a new instance of a Response.ResponseBuilder.

createUriBuilder() - Method in class javax.ws.rs.ext.RuntimeDelegate

Create a new instance of a UriBuilder.

createVariantListBuilder() - Method in class javax.ws.rs.ext.RuntimeDelegate

Create a new instance of a Variant.VariantListBuilder.

D

DATE - Static variable in interface javax.ws.rs.core.HttpHeaders

See HTTP/1.1 documentation.

DEFAULT_MAX_AGE - Static variable in class javax.ws.rs.core.NewCookie

Specifies that the cookie expires with the current application/browser session.

DEFAULT_VERSION - Static variable in class javax.ws.rs.core.Cookie

Cookies using the default version correspond to RFC 2109.

DefaultValue - Annotation Type in javax.ws.rs

Defines the default value of request metadata that is bound using one of the following annotations: PathParam, QueryParam, MatrixParam, CookieParam, FormParam, or HeaderParam.

DELETE - Annotation Type in javax.ws.rs

Indicates that the annotated method responds to HTTP DELETE requests

DELETE - Static variable in annotation type javax.ws.rs.HttpMethod

HTTP DELETE method

DIGEST_AUTH - Static variable in interface javax.ws.rs.core.SecurityContext

String identifier for Digest authentication.

E

Encoded - Annotation Type in javax.ws.rs

Disables automatic decoding of parameter values bound using QueryParam, PathParam, FormParam or MatrixParam.

encodings(String...) - Static method in class javax.ws.rs.core.Variant

Create a Variant.VariantListBuilder initialized with a set of supported encodings.

encodings(String...) - Method in class javax.ws.rs.core.Variant.VariantListBuilder

Set the encoding[s] for this variant.

entity(Object) - Method in class javax.ws.rs.core.Response.ResponseBuilder

Set the entity on the ResponseBuilder.

entityMustNotBeNull() - Method in interface org.jboss.resteasy.jaxrs_api.i18n.Messages

EntityTag - Class in javax.ws.rs.core

An abstraction for the value of a HTTP Entity Tag, used as the value of an ETag response header.

EntityTag(String) - Constructor for class javax.ws.rs.core.EntityTag

Creates a new instance of a strong EntityTag.

EntityTag(String, boolean) - Constructor for class javax.ws.rs.core.EntityTag

Creates a new instance of an EntityTag

equals(Object) - Method in class javax.ws.rs.core.CacheControl

Compares obj to this cache control to see if they are the same considering all property values.

equals(Object) - Method in class javax.ws.rs.core.Cookie

Compare for equality

equals(Object) - Method in class javax.ws.rs.core.EntityTag

Compares obj to this tag to see if they are the same considering weakness and value.

equals(Object) - Method in class javax.ws.rs.core.MediaType

Compares obj to this media type to see if they are the same by comparing type, subtype and parameters.

equals(Object) - Method in class javax.ws.rs.core.NewCookie

Compare for equality.

equals(Object) - Method in class javax.ws.rs.core.Variant

Compares obj to this variant to see if they are the same considering all property values.

ETAG - Static variable in interface javax.ws.rs.core.HttpHeaders

See HTTP/1.1 documentation.

evaluatePreconditions(EntityTag) - Method in interface javax.ws.rs.core.Request

Evaluate request preconditions based on the passed in value.

evaluatePreconditions(Date) - Method in interface javax.ws.rs.core.Request

Evaluate request preconditions based on the passed in value.

evaluatePreconditions(Date, EntityTag) - Method in interface javax.ws.rs.core.Request

Evaluate request preconditions based on the passed in value.

evaluatePreconditions() - Method in interface javax.ws.rs.core.Request

Evaluate request preconditions for a resource that does not currently exist.

ExceptionMapper<E extends Throwable> - Interface in javax.ws.rs.ext

Contract for a provider that maps Java exceptions to Response.

EXPIRES - Static variable in interface javax.ws.rs.core.HttpHeaders

See HTTP/1.1 documentation.

expires(Date) - Method in class javax.ws.rs.core.Response.ResponseBuilder

Set the expires date on the ResponseBuilder.

F

FORM_AUTH - Static variable in interface javax.ws.rs.core.SecurityContext

String identifier for Form authentication.

FormParam - Annotation Type in javax.ws.rs

Binds the value(s) of a form parameter contained within a request entity body to a resource method parameter.

fragment(String) - Method in class javax.ws.rs.core.UriBuilder

Set the URI fragment.

fromPath(String) - Static method in class javax.ws.rs.core.UriBuilder

Create a new instance representing a relative URI initialized from a URI path.

fromResource(Class<?>) - Static method in class javax.ws.rs.core.UriBuilder

Create a new instance representing a relative URI initialized from a root resource class.

fromResponse(Response) - Static method in class javax.ws.rs.core.Response

Create a new ResponseBuilder by performing a shallow copy of an existing Response.

fromStatusCode(int) - Static method in enum javax.ws.rs.core.Response.Status

Convert a numerical status code into the corresponding Status

fromString(String) - Method in interface javax.ws.rs.ext.RuntimeDelegate.HeaderDelegate

Parse the supplied value and create an instance of T.

fromUri(URI) - Static method in class javax.ws.rs.core.UriBuilder

Create a new instance initialized from an existing URI.

fromUri(String) - Static method in class javax.ws.rs.core.UriBuilder

Create a new instance initialized from an existing URI.

G

GenericEntity<T> - Class in javax.ws.rs.core

Represents a response 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.

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.core.HttpHeaders

Get a list of languages 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.

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.

getClasses() - Method in class javax.ws.rs.core.Application

Get a set of root resource and provider classes.

getComment() - Method in class javax.ws.rs.core.NewCookie

Get the comment associated with the cookie.

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.

getCookies() - Method in interface javax.ws.rs.core.HttpHeaders

Get any cookies that accompanied the request.

getDomain() - Method in class javax.ws.rs.core.Cookie

Get the domain of the cookie

getEncoding() - Method in class javax.ws.rs.core.Variant

Get the encoding of the variant

getEntity() - Method in class javax.ws.rs.core.GenericEntity

Get the enclosed entity

getEntity() - Method in class javax.ws.rs.core.Response

Return the response entity.

getExceptionMapper(Class<T>) - Method in interface javax.ws.rs.ext.Providers

Get an exception mapping provider for a particular class of exception.

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 interface javax.ws.rs.core.MultivaluedMap

A shortcut to get the first value of the supplied key.

getInstance() - Static method in class javax.ws.rs.ext.RuntimeDelegate

Obtain a RuntimeDelegate instance.

getLanguage() - Method in interface javax.ws.rs.core.HttpHeaders

Get the language of the request entity

getLanguage() - Method in class javax.ws.rs.core.Variant

Get the language of the variant

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.core.HttpHeaders

Get the media type of the request entity

getMediaType() - Method in class javax.ws.rs.core.Variant

Get the media type of the variant

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

Get metadata associated with the response as a map.

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.

getParameters() - Method in class javax.ws.rs.core.MediaType

Getter for a read-only parameter map.

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.

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.

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

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.

getResponse() - Method in exception javax.ws.rs.WebApplicationException

Get the HTTP response.

getSingletons() - Method in class javax.ws.rs.core.Application

Get a set of root resource and provider instances.

getSize(T, Class<?>, Type, Annotation[], MediaType) - Method in interface javax.ws.rs.ext.MessageBodyWriter

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.

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

getSubtype() - Method in class javax.ws.rs.core.MediaType

Getter for subtype.

getType() - Method in class javax.ws.rs.core.GenericEntity

Gets underlying Type instance.

getType() - Method in class javax.ws.rs.core.MediaType

Getter for primary type.

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

getVersion() - Method in class javax.ws.rs.core.Cookie

Get the version of the cookie

H

hashCode() - Method in class javax.ws.rs.core.CacheControl

Generate hash code from cache control properties.

hashCode() - Method in class javax.ws.rs.core.Cookie

Generate a hashcode by hashing all of the cookies properties

hashCode() - Method in class javax.ws.rs.core.EntityTag

Generate hashCode based on value and weakness.

hashCode() - Method in class javax.ws.rs.core.MediaType

Generate a hashcode from the type, subtype and parameters.

hashCode() - Method in class javax.ws.rs.core.NewCookie

Generate a hashcode by hashing all of the properties

hashCode() - Method in class javax.ws.rs.core.Variant

Generate hash code from variant properties.

HEAD - Annotation Type in javax.ws.rs

Indicates that the annotated method responds to HTTP HEAD requests

HEAD - Static variable in annotation type javax.ws.rs.HttpMethod

HTTP HEAD method

header(String, Object) - Method in class javax.ws.rs.core.Response.ResponseBuilder

Add a header to the ResponseBuilder.

HeaderParam - Annotation Type in javax.ws.rs

Binds the value(s) of a HTTP header to a resource method parameter, resource class field, or resource class bean property.

HOST - Static variable in interface javax.ws.rs.core.HttpHeaders

See HTTP/1.1 documentation.

host(String) - Method in class javax.ws.rs.core.UriBuilder

Set the URI host.

HttpHeaders - Interface in javax.ws.rs.core

An injectable interface that provides access to HTTP header information.

HttpMethod - Annotation Type in javax.ws.rs

Associates the name of a HTTP method with an annotation.

I

IF_MATCH - Static variable in interface javax.ws.rs.core.HttpHeaders

See HTTP/1.1 documentation.

IF_MODIFIED_SINCE - Static variable in interface javax.ws.rs.core.HttpHeaders

See HTTP/1.1 documentation.

IF_NONE_MATCH - Static variable in interface javax.ws.rs.core.HttpHeaders

See HTTP/1.1 documentation.

IF_UNMODIFIED_SINCE - Static variable in interface javax.ws.rs.core.HttpHeaders

See HTTP/1.1 documentation.

isCompatible(MediaType) - Method in class javax.ws.rs.core.MediaType

Check if this media type is compatible with another media type.

isMustRevalidate() - Method in class javax.ws.rs.core.CacheControl

Corresponds to the must-revalidate cache control directive.

isNoCache() - Method in class javax.ws.rs.core.CacheControl

Corresponds to the no-cache cache control directive.

isNoStore() - Method in class javax.ws.rs.core.CacheControl

Corresponds to the no-store cache control directive.

isNoTransform() - Method in class javax.ws.rs.core.CacheControl

Corresponds to the no-transform cache control directive.

isPrivate() - Method in class javax.ws.rs.core.CacheControl

Corresponds to the private cache control directive.

isProxyRevalidate() - Method in class javax.ws.rs.core.CacheControl

Corresponds to the proxy-revalidate cache control directive.

isReadable(Class<?>, Type, Annotation[], MediaType) - Method in interface javax.ws.rs.ext.MessageBodyReader

Ascertain if the MessageBodyReader can produce an instance of a particular type.

isSecure() - Method in class javax.ws.rs.core.NewCookie

Whether the cookie will only be sent over a secure connection.

isSecure() - Method in interface javax.ws.rs.core.SecurityContext

Returns a boolean indicating whether this request was made using a secure channel, such as HTTPS.

isUserInRole(String) - Method in interface javax.ws.rs.core.SecurityContext

Returns a boolean indicating whether the authenticated user is included in the specified logical "role".

isWeak() - Method in class javax.ws.rs.core.EntityTag

Check the strength of an EntityTag

isWildcardSubtype() - Method in class javax.ws.rs.core.MediaType

Checks if the subtype is a wildcard

isWildcardType() - Method in class javax.ws.rs.core.MediaType

Checks if the primary type is a wildcard.

isWriteable(Class<?>, Type, Annotation[], MediaType) - Method in interface javax.ws.rs.ext.MessageBodyWriter

Ascertain if the MessageBodyWriter supports a particular type.

J

javax.ws.rs - package javax.ws.rs

High-level interfaces and annotations used to create RESTful service resources.

javax.ws.rs.core - package javax.ws.rs.core

Low-level interfaces and annotations used to create RESTful service resources.

javax.ws.rs.ext - package javax.ws.rs.ext

APIs that provide extensions to the types supported by the JAX-RS API.

JAXRS_RUNTIME_DELEGATE_PROPERTY - Static variable in class javax.ws.rs.ext.RuntimeDelegate

L

language(String) - Method in class javax.ws.rs.core.Response.ResponseBuilder

Set the language on the ResponseBuilder.

language(Locale) - Method in class javax.ws.rs.core.Response.ResponseBuilder

Set the language on the ResponseBuilder.

languages(Locale...) - Static method in class javax.ws.rs.core.Variant

Create a Variant.VariantListBuilder initialized with a set of supported languages.

languages(Locale...) - Method in class javax.ws.rs.core.Variant.VariantListBuilder

Set the language[s] for this variant.

LAST_MODIFIED - Static variable in interface javax.ws.rs.core.HttpHeaders

See HTTP/1.1 documentation.

lastModified(Date) - Method in class javax.ws.rs.core.Response.ResponseBuilder

Set the last modified date on the ResponseBuilder.

LOCATION - Static variable in interface javax.ws.rs.core.HttpHeaders

See HTTP/1.1 documentation.

location(URI) - Method in class javax.ws.rs.core.Response.ResponseBuilder

Set the location on the ResponseBuilder.

LOGGER - Static variable in interface org.jboss.resteasy.jaxrs_api.i18n.LogMessages

LogMessages - Interface in org.jboss.resteasy.jaxrs_api.i18n

M

matrixParam(String, Object...) - Method in class javax.ws.rs.core.UriBuilder

Append a matrix parameter to the existing set of matrix parameters of the current final segment of the URI path.

MatrixParam - Annotation Type in javax.ws.rs

Binds the value(s) of a URI matrix parameter to a resource method parameter, resource class field, or resource class bean property.

MEDIA_TYPE_WILDCARD - Static variable in class javax.ws.rs.core.MediaType

The value of a type or subtype wildcard: "*"

MediaType - Class in javax.ws.rs.core

An abstraction for a media type.

MediaType(String, String, Map<String, String>) - Constructor for class javax.ws.rs.core.MediaType

Creates a new instance of MediaType with the supplied type, subtype and parameters.

MediaType(String, String) - Constructor for class javax.ws.rs.core.MediaType

Creates a new instance of MediaType with the supplied type and subtype.

MediaType() - Constructor for class javax.ws.rs.core.MediaType

Creates a new instance of MediaType, both type and subtype are wildcards.

mediaTypeLanguageEncodingNull() - Method in interface org.jboss.resteasy.jaxrs_api.i18n.Messages

mediaTypes(MediaType...) - Static method in class javax.ws.rs.core.Variant

Create a Variant.VariantListBuilder initialized with a set of supported media types.

mediaTypes(MediaType...) - Method in class javax.ws.rs.core.Variant.VariantListBuilder

Set the media type[s] for this variant.

MessageBodyReader<T> - Interface in javax.ws.rs.ext

Contract for a provider that supports the conversion of a stream to a Java type.

MessageBodyWriter<T> - Interface in javax.ws.rs.ext

Contract for a provider that supports the conversion of a Java type to a stream.

Messages - Interface in org.jboss.resteasy.jaxrs_api.i18n

MESSAGES - Static variable in interface org.jboss.resteasy.jaxrs_api.i18n.Messages

missingTypeParameter() - Method in interface org.jboss.resteasy.jaxrs_api.i18n.Messages

MULTIPART_FORM_DATA - Static variable in class javax.ws.rs.core.MediaType

"multipart/form-data"

MULTIPART_FORM_DATA_TYPE - Static variable in class javax.ws.rs.core.MediaType

"multipart/form-data"

MultivaluedMap<K,V> - Interface in javax.ws.rs.core

A map of key-values pairs.

N

nameIsNull() - Method in interface org.jboss.resteasy.jaxrs_api.i18n.Messages

NewCookie - Class in javax.ws.rs.core

Used to create a new HTTP cookie, transferred in a response.

NewCookie(String, String) - Constructor for class javax.ws.rs.core.NewCookie

Create a new instance.

NewCookie(String, String, String, String, String, int, boolean) - Constructor for class javax.ws.rs.core.NewCookie

Create a new instance.

NewCookie(String, String, String, String, int, String, int, boolean) - Constructor for class javax.ws.rs.core.NewCookie

Create a new instance.

NewCookie(Cookie) - Constructor for class javax.ws.rs.core.NewCookie

Create a new instance copying the information in the supplied cookie.

NewCookie(Cookie, String, int, boolean) - Constructor for class javax.ws.rs.core.NewCookie

Create a new instance supplementing the information in the supplied cookie.

newInstance() - Static method in class javax.ws.rs.core.Response.ResponseBuilder

Create a new builder instance.

newInstance() - Static method in class javax.ws.rs.core.UriBuilder

Creates a new instance of UriBuilder.

newInstance() - Static method in class javax.ws.rs.core.Variant.VariantListBuilder

Create a new builder instance.

noContent() - Static method in class javax.ws.rs.core.Response

Create a new ResponseBuilder for an empty response.

notAcceptable(List<Variant>) - Static method in class javax.ws.rs.core.Response

Create a new ResponseBuilder for a not acceptable response.

notModified() - Static method in class javax.ws.rs.core.Response

Create a new ResponseBuilder with a not-modified status.

notModified(EntityTag) - Static method in class javax.ws.rs.core.Response

Create a new ResponseBuilder with a not-modified status.

notModified(String) - Static method in class javax.ws.rs.core.Response

Create a new ResponseBuilder with a not-modified status and a strong entity tag.

O

ok() - Static method in class javax.ws.rs.core.Response

Create a new ResponseBuilder with an OK status.

ok(Object) - Static method in class javax.ws.rs.core.Response

Create a new ResponseBuilder that contains a representation.

ok(Object, MediaType) - Static method in class javax.ws.rs.core.Response

Create a new ResponseBuilder that contains a representation.

ok(Object, String) - Static method in class javax.ws.rs.core.Response

Create a new ResponseBuilder that contains a representation.

ok(Object, Variant) - Static method in class javax.ws.rs.core.Response

Create a new ResponseBuilder that contains a representation.

OPTIONS - Static variable in annotation type javax.ws.rs.HttpMethod

HTTP OPTIONS method

OPTIONS - Annotation Type in javax.ws.rs

Indicates that the annotated method responds to HTTP OPTIONS requests

org.jboss.resteasy.jaxrs_api.i18n - package org.jboss.resteasy.jaxrs_api.i18n

P

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.

pathParameterIsNull() - Method in interface org.jboss.resteasy.jaxrs_api.i18n.Messages

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 - 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

Produces - Annotation Type in javax.ws.rs

Defines the media type(s) that the methods of a resource class or MessageBodyWriter can produce.

Provider - Annotation Type in javax.ws.rs.ext

Marks an implementation of an extension interface.

providerCouldNotBeFound(String) - Method in interface org.jboss.resteasy.jaxrs_api.i18n.Messages

providerCouldNotBeInstantiated(String, Exception) - Method in interface org.jboss.resteasy.jaxrs_api.i18n.Messages

Providers - Interface in javax.ws.rs.ext

An injectable interface providing runtime lookup of provider instances.

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

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.

Q

queryParam(String, Object...) - Method in class javax.ws.rs.core.UriBuilder

Append a query parameter to the existing set of query parameters.

QueryParam - Annotation Type in javax.ws.rs

Binds the value(s) of a HTTP query parameter to a resource method parameter, resource class field, or resource class bean property.

R

readFrom(Class<T>, Type, Annotation[], MediaType, MultivaluedMap<String, String>, InputStream) - Method in interface javax.ws.rs.ext.MessageBodyReader

Read a type from the InputStream.

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.

Request - Interface in javax.ws.rs.core

An injectable helper for request processing, all methods throw java.lang.IllegalStateException if called outside the scope of a request (e.g.

Response - Class in javax.ws.rs.core

Defines the contract between a returned instance and the runtime when an application needs to provide metadata 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

Commonly used status codes defined by HTTP, see HTTP/1.1 documentation for the complete list.

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.

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

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.

S

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.

SET_COOKIE - Static variable in interface javax.ws.rs.core.HttpHeaders

See IETF RFC 2109.

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.

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.

setPrivate(boolean) - Method in class javax.ws.rs.core.CacheControl

Corresponds to the private cache control directive.

setProxyRevalidate(boolean) - Method in class javax.ws.rs.core.CacheControl

Corresponds to the must-revalidate cache control directive.

setSMaxAge(int) - Method in class javax.ws.rs.core.CacheControl

Corresponds to the s-maxage cache control directive.

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.

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.

T

tag(EntityTag) - Method in class javax.ws.rs.core.Response.ResponseBuilder

Set an entity tag on the ResponseBuilder.

tag(String) - Method in class javax.ws.rs.core.Response.ResponseBuilder

Set a strong entity tag on the ResponseBuilder.

temporaryRedirect(URI) - Static method in class javax.ws.rs.core.Response

Create a new ResponseBuilder for a temporary redirection.

TEXT_HTML - Static variable in class javax.ws.rs.core.MediaType

"text/html"

TEXT_HTML_TYPE - Static variable in class javax.ws.rs.core.MediaType

"text/html"

TEXT_PLAIN - Static variable in class javax.ws.rs.core.MediaType

"text/plain"

TEXT_PLAIN_TYPE - Static variable in class javax.ws.rs.core.MediaType

"text/plain"

TEXT_XML - Static variable in class javax.ws.rs.core.MediaType

"text/xml"

TEXT_XML_TYPE - Static variable in class javax.ws.rs.core.MediaType

"text/xml"

toCookie() - Method in class javax.ws.rs.core.NewCookie

Obtain a new instance of a Cookie with the same name, value, path, domain and version as this NewCookie.

toResponse(E) - Method in interface javax.ws.rs.ext.ExceptionMapper

Map an exception to a Response.

toString() - Method in class javax.ws.rs.core.CacheControl

Convert the cache control to a string suitable for use as the value of the corresponding HTTP header.

toString() - Method in class javax.ws.rs.core.Cookie

Convert the cookie to a string suitable for use as the value of the corresponding HTTP header.

toString() - Method in class javax.ws.rs.core.EntityTag

Convert the entity tag to a string suitable for use as the value of the corresponding HTTP header.

toString() - Method in class javax.ws.rs.core.MediaType

Convert the media type to a string suitable for use as the value of a corresponding HTTP header.

toString() - Method in class javax.ws.rs.core.NewCookie

Convert the cookie to a string suitable for use as the value of the corresponding HTTP header.

toString() - Method in enum javax.ws.rs.core.Response.Status

Get the reason phrase

toString() - Method in class javax.ws.rs.core.Variant

toString(T) - Method in interface javax.ws.rs.ext.RuntimeDelegate.HeaderDelegate

Convert the supplied value to a String.

type(MediaType) - Method in class javax.ws.rs.core.Response.ResponseBuilder

Set the response media type on the ResponseBuilder.

type(String) - Method in class javax.ws.rs.core.Response.ResponseBuilder

Set the response media type on the ResponseBuilder.

typeIsIncompatible() - Method in interface org.jboss.resteasy.jaxrs_api.i18n.Messages

U

uri(URI) - Method in class javax.ws.rs.core.UriBuilder

Copies the non-null components of the supplied URI to the UriBuilder replacing any existing values for those components.

UriBuilder - Class in javax.ws.rs.core

URI template aware utility class for building URIs from their components.

UriBuilder() - Constructor for class javax.ws.rs.core.UriBuilder

Protected constructor, use one of the static fromXXX methods to obtain an instance.

UriBuilderException - Exception in javax.ws.rs.core

A runtime exception thrown by UriBuilder.build(java.lang.Object...) methods when a URI cannot be constructed based on the current state of the builder.

UriBuilderException() - Constructor for exception javax.ws.rs.core.UriBuilderException

Creates a new instance of UriBuilderException without detail message.

UriBuilderException(String) - Constructor for exception javax.ws.rs.core.UriBuilderException

Constructs an instance of UriBuilderException with the specified detail message.

UriBuilderException(String, Throwable) - Constructor for exception javax.ws.rs.core.UriBuilderException

Constructs an instance of UriBuilderException with the specified detail message and cause.

UriBuilderException(Throwable) - Constructor for exception javax.ws.rs.core.UriBuilderException

Constructs a new 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).

UriInfo - Interface in javax.ws.rs.core

An injectable interface that provides access to application and request URI information.

USER_AGENT - Static variable in interface javax.ws.rs.core.HttpHeaders

See HTTP/1.1 documentation.

userInfo(String) - Method in class javax.ws.rs.core.UriBuilder

Set the URI user-info.

V

valueIsNull() - Method in interface org.jboss.resteasy.jaxrs_api.i18n.Messages

valueOf(String) - Static method in class javax.ws.rs.core.CacheControl

Creates a new instance of CacheControl by parsing the supplied string.

valueOf(String) - Static method in class javax.ws.rs.core.Cookie

Creates a new instance of Cookie by parsing the supplied string.

valueOf(String) - Static method in class javax.ws.rs.core.EntityTag

Creates a new instance of EntityTag by parsing the supplied string.

valueOf(String) - Static method in class javax.ws.rs.core.MediaType

Creates a new instance of MediaType by parsing the supplied string.

valueOf(String) - Static method in class javax.ws.rs.core.NewCookie

Creates a new instance of NewCookie by parsing the supplied string.

valueOf(String) - Static method in enum javax.ws.rs.core.Response.Status.Family

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum javax.ws.rs.core.Response.Status

Returns the enum constant of this type with the specified name.

values() - Static method in enum javax.ws.rs.core.Response.Status.Family

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum javax.ws.rs.core.Response.Status

Returns an array containing the constants of this enum type, in the order they are declared.

variant(Variant) - Method in class javax.ws.rs.core.Response.ResponseBuilder

Set representation metadata on the ResponseBuilder.

Variant - Class in javax.ws.rs.core

Abstraction for a resource representation variant.

Variant(MediaType, Locale, String) - Constructor for class javax.ws.rs.core.Variant

Create a new instance of Variant

Variant.VariantListBuilder - Class in javax.ws.rs.core

A builder for a list of representation variants.

Variant.VariantListBuilder() - Constructor for class javax.ws.rs.core.Variant.VariantListBuilder

Protected constructor, use the static newInstance method to obtain an instance.

variants(List<Variant>) - Method in class javax.ws.rs.core.Response.ResponseBuilder

Add a Vary header that lists the available variants.

VARY - Static variable in interface javax.ws.rs.core.HttpHeaders

See HTTP/1.1 documentation.

W

WebApplicationException - Exception in javax.ws.rs

Runtime exception for applications.

WebApplicationException() - Constructor for exception javax.ws.rs.WebApplicationException

Construct a new instance with a blank message and default HTTP status code of 500

WebApplicationException(Response) - Constructor for exception javax.ws.rs.WebApplicationException

Construct a new instance using the supplied response

WebApplicationException(int) - Constructor for exception javax.ws.rs.WebApplicationException

Construct a new instance with a blank message and specified HTTP status code

WebApplicationException(Response.Status) - Constructor for exception javax.ws.rs.WebApplicationException

Construct a new instance with a blank message and specified HTTP status code

WebApplicationException(Throwable) - Constructor for exception javax.ws.rs.WebApplicationException

Construct a new instance with a blank message and default HTTP status code of 500

WebApplicationException(Throwable, Response) - Constructor for exception javax.ws.rs.WebApplicationException

Construct a new instance using the supplied response

WebApplicationException(Throwable, int) - Constructor for exception javax.ws.rs.WebApplicationException

Construct a new instance with a blank message and specified HTTP status code

WebApplicationException(Throwable, Response.Status) - Constructor for exception javax.ws.rs.WebApplicationException

Construct a new instance with a blank message and specified HTTP status code

WILDCARD - Static variable in class javax.ws.rs.core.MediaType

"*/*"

WILDCARD_TYPE - Static variable in class javax.ws.rs.core.MediaType

"*/*"

write(OutputStream) - Method in interface javax.ws.rs.core.StreamingOutput

Called to write the message body.

writeTo(T, Class<?>, Type, Annotation[], MediaType, MultivaluedMap<String, Object>, OutputStream) - Method in interface javax.ws.rs.ext.MessageBodyWriter

Write a type to an HTTP response.

WWW_AUTHENTICATE - Static variable in interface javax.ws.rs.core.HttpHeaders

See HTTP/1.1 documentation.

A B C D E F G H I J L M N O P Q R S T U V W