CodeQL library for Java
Search

Module JaxWS

Definitions relating to JAX-WS (Java/Jakarta API for XML Web Services) and JAX-RS (Java/Jakarta API for RESTful Web Services).

Import path

import semmle.code.java.frameworks.JaxWS

Imports

java

Provides all default Java QL imports.

Predicates

getAJaxRsPackage

Gets a name for the root package of JAX-RS.

getAJaxRsPackage

Gets a name for package subpackage within the JAX-RS hierarchy.

getContentTypeString

Gets a constant content-type described by expression e (either a string constant or a Jax-RS MediaType field access).

Classes

JaxRSAnnotation

An annotation from the javax.ws.rs or jakarta.ws.rs package hierarchy.

JaxRSConsumesAnnotation

An @Consumes annotation that describes content types can be consumed by this resource.

JaxRSProducesAnnotation

An @Produces annotation that describes which content types can be produced by this resource.

JaxRsBeanParamConstructor

A constructor that may be called by a JaxRS container to construct an instance to inject into a resource method or resource class constructor.

JaxRsClient

The class javax.ws.rs.client.Client.

JaxRsInjectionAnnotation

An annotation that is used by JaxRS containers to determine a value to inject into the annotated element.

JaxRsResourceClass

A JaxRs resource class, annotated with @Path or referred to from a sub-resource locator on another resource class.

JaxRsResourceMethod

A method which is annotated with one or more JaxRS resource type annotations e.g. @GET, @POST etc.

JaxRsResponse

The class javax.ws.rs.core.Response.

JaxRsResponseBuilder

The class javax.ws.rs.core.Response$ResponseBuilder.

JaxWsEndpoint

A JAX WS endpoint is constructed by the container, and its methods are – where annotated – called remotely.

MessageBodyReader

The class javax.ws.rs.ext.MessageBodyReader.

MessageBodyReaderRead

A method that overrides readFrom in MessageBodyReader.

MessageBodyReaderReadFrom

The method readFrom in MessageBodyReader.