Jakarta WS RS API

https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/
Admin
The Jakarta WS RS API provides a specification for creating RESTful web services in Java.
Tokens:101,953
Snippets:1,545
Trust Score:9.5
Update:3 months ago
Show doc for...
Tokens:
Raw
### Start Application with Configuration

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/SeBootstrap.html

Starts a JAX-RS application instance using a specific configuration object.

```java
static CompletionStage<SeBootstrap.Instance> start(Application application,
                                                   SeBootstrap.Configuration configuration)
```

--------------------------------

### Start Application with Default Configuration

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/SeBootstrap.html

Starts a JAX-RS application instance using default configuration settings.

```java
static CompletionStage<SeBootstrap.Instance> start(Application application)
```

--------------------------------

### Start a JAX-RS Application

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/SeBootstrap.html

Initializes and starts a JAX-RS application using default configuration values.

```java
 Application app = new MyApplication();
 SeBootstrap.Configuration config = SeBootstrap.Configuration.builder().build();
 SeBootstrap.start(app, config).thenAccept(instance -> instance.configuration().port());
 
```

--------------------------------

### Asynchronous GET Request

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/client/AsyncInvoker.html

Example of the method signature for initiating an asynchronous GET request.

```java
Future<Response> get()
```

--------------------------------

### Start Application Class with Configuration

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/SeBootstrap.html

Starts an application from a class using a specific configuration. Injection is not supported for the application instance.

```java
static CompletionStage<SeBootstrap.Instance> start(Class<? extends Application> clazz,
                                                   SeBootstrap.Configuration configuration)
```

--------------------------------

### Start Application Class with Default Configuration

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/SeBootstrap.html

Starts an application from a class using default configuration. Injection is not supported for the application instance.

```java
static CompletionStage<SeBootstrap.Instance> start(Class<? extends Application> clazz)
```

--------------------------------

### SeBootstrap.start

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/index-all.html

Starts a JAX-RS application using the SeBootstrap interface.

```APIDOC
## SeBootstrap.start(Application)

### Description
Starts the provided application using a default configuration.

### Method
Static Method

### Parameters
- **application** (Application) - Required - The application instance to start.
```

--------------------------------

### SeBootstrap.start(Application, SeBootstrap.Configuration)

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/class-use/SeBootstrap.Configuration.html

Starts the provided application using the specified configuration.

```APIDOC
## SeBootstrap.start(Application application, SeBootstrap.Configuration configuration)

### Description
Starts the provided application using the specified configuration.

### Parameters
- **application** (Application) - The application to start.
- **configuration** (SeBootstrap.Configuration) - The configuration to use.

### Returns
- **CompletionStage<SeBootstrap.Instance>** - A completion stage that completes with the started instance.
```

--------------------------------

### SeBootstrap.start(Application application)

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/class-use/SeBootstrap.Instance.html

Starts the provided application using a default configuration.

```APIDOC
## static CompletionStage<SeBootstrap.Instance> SeBootstrap.start(Application application)

### Description
Starts the provided application using a default configuration.

### Parameters
- **application** (Application) - The JAX-RS application to start.
```

--------------------------------

### Example Media Type Array

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/Consumes.html

An example of defining multiple media types within the value element, demonstrating comma-separated strings.

```java
{ "image/jpeg, image/gif ", " image/png" }
```

--------------------------------

### get()

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/client/CompletionStageRxInvoker.html

Invokes an HTTP GET request for the current request and returns the response wrapped in a CompletionStage.

```APIDOC
## CompletionStage<Response> get()

### Description
Invoke HTTP GET method for the current request.

### Returns
- **CompletionStage<Response>** - The invocation response wrapped in the completion aware type.
```

--------------------------------

### SeBootstrap.start(Application application)

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/core/class-use/Application.html

Starts the provided JAX-RS application using a default configuration.

```APIDOC
## SeBootstrap.start(Application application)

### Description
Starts the provided application using a default configuration.

### Parameters
- **application** (Application) - Required - The application instance to start.
```

--------------------------------

### SeBootstrap.start(Application, Configuration)

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/SeBootstrap.html

Starts a JAX-RS application instance with the provided configuration. Returns a CompletionStage that resolves to the running instance.

```APIDOC
## SeBootstrap.start(Application app, Configuration config)

### Description
Starts a JAX-RS application in a Java SE environment. The method returns a CompletionStage that provides access to the running instance once it is ready.

### Signature
`static CompletionStage<Instance> start(Application app, Configuration config)`

### Parameters
- **app** (Application) - The JAX-RS application to be started.
- **config** (Configuration) - The configuration settings for the bootstrap process, including protocol, host, port, and SSL settings.
```

--------------------------------

### SeBootstrap.start(Class<? extends Application> clazz)

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/class-use/SeBootstrap.Instance.html

Starts the provided application class using a default configuration.

```APIDOC
## static CompletionStage<SeBootstrap.Instance> SeBootstrap.start(Class<? extends Application> clazz)

### Description
Starts the provided application class using a default configuration.

### Parameters
- **clazz** (Class<? extends Application>) - The JAX-RS application class to start.
```

--------------------------------

### SeBootstrap.start(Class<? extends Application> clazz, SeBootstrap.Configuration configuration)

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/class-use/SeBootstrap.Instance.html

Starts the provided application class using the specified configuration.

```APIDOC
## static CompletionStage<SeBootstrap.Instance> SeBootstrap.start(Class<? extends Application> clazz, SeBootstrap.Configuration configuration)

### Description
Starts the provided application class using the specified configuration.

### Parameters
- **clazz** (Class<? extends Application>) - The JAX-RS application class to start.
- **configuration** (SeBootstrap.Configuration) - The configuration to use for the bootstrap.
```

--------------------------------

### get()

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/client/SyncInvoker.html

Invoke HTTP GET method for the current request synchronously.

```APIDOC
## GET

### Description
Invoke HTTP GET method for the current request synchronously.

### Parameters
- **responseType** (Class<T> or GenericType<T>) - Optional - The Java type to convert the response entity into.

### Response
- **Response** (Object) - The invocation response object.
- **T** (Object) - The response entity converted to the specified type.
```

--------------------------------

### request

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/client/WebTarget.html

Starts building a request to the targeted web resource.

```APIDOC
## WebTarget.request()

### Description
Starts building a request to the targeted web resource.

### Returns
- **Invocation.Builder** - Builder for a request targeted at the URI referenced by this target instance.
```

--------------------------------

### Build and Open an SseEventSource

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/sse/SseEventSource.Builder.html

Example showing how to configure a reconnection delay, build the event source, register a consumer, and open the connection.

```java
 SseEventSource es = SseEventSource.target(endpoint)
         .reconnectingEvery(5, SECONDS)
         .build();
 es.register(System.out::println);
 es.open();
```

--------------------------------

### Use the JAX-RS Client API

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta/ws/rs/client/ClientRequestFilter.html

Demonstrates initializing a client, configuring properties and providers, and executing a GET request to a target URI.

```java
    Client client = ClientBuilder.newClient();

    client.property("MyProperty", "MyValue")
          .register(MyProvider.class)
          .enable(MyFeature.class);

    Response res = client.target("http://example.org/hello").request("text/plain").get();
    String message = res.readEntity(String.class);
```

--------------------------------

### Opening the Event Source

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/sse/SseEventSource.html

Starts the connection to the SSE endpoint and begins processing events.

```java
void open()
```

--------------------------------

### Invocation.Builder.buildGet()

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/client/class-use/Invocation.html

Builds a GET request invocation.

```APIDOC
## Invocation.Builder.buildGet()

### Description
Build a GET request invocation.

### Returns
- **Invocation** - The built request invocation.
```

--------------------------------

### Initiate Request Building

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/client/WebTarget.html

Starts the process of building a request for the targeted web resource.

```java
Invocation.Builder request()
```

--------------------------------

### Initiate Request with Accepted Media Types

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/client/WebTarget.html

Starts building a request while defining accepted response media types. These methods are equivalent to calling request().accept(types).

```java
Invocation.Builder request(String... acceptedResponseTypes)
```

```java
Invocation.Builder request(MediaType... acceptedResponseTypes)
```

```java
webTarget.request().accept(types);
```

--------------------------------

### Get URI Information

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/container/ContainerRequestContext.html

Returns a live view of the request URI information.

```java
UriInfo getUriInfo()
```

--------------------------------

### Example of Entity Annotations in Resource Method

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/container/ContainerResponseContext.html

Demonstrates how annotations are collected from resource methods and explicit entity attachments.

```java
 @Path("my-resource")
 public class MyResource {
   private final Annotations[] extras = ... ;

   @GET
   @Custom
   public String getAnnotatedMe() {
     return Response.ok().entity("Annotated me", extras).build();
   }
   ...
 }
```

--------------------------------

### Build GET Request

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/client/Invocation.Builder.html

Builds a GET request invocation.

```java
Invocation buildGet()
```

--------------------------------

### Apply Path to Resource Class and Method

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/Path.html

Example showing how to use @Path on a class and a method to define URI routing.

```java
 @Path("widgets")
 public class WidgetsResource {
  @GET
  String getList() {...}

  @GET @Path("{id}")
  String getWidget(@PathParam("id") String id) {...}
 }
```

--------------------------------

### Define a Resource Class

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/core/UriInfo.html

Example resource classes used to demonstrate matched URI and resource retrieval.

```java
 public class BarResource {
  @GET
  public String getBar() {...}
 }
```

```java
 @Path("foo")
 public class FooResource {
  @GET
  public String getFoo() {...}

  @Path("bar")
  public BarResource getBarResource() {...}
 }

 public class BarResource {
  @GET
  public String getBar() {...}
 }
```

--------------------------------

### RuntimeDelegate.bootstrap(Application, SeBootstrap.Configuration)

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/class-use/SeBootstrap.Configuration.html

Perform startup of the application in Java SE environments.

```APIDOC
## RuntimeDelegate.bootstrap(Application application, SeBootstrap.Configuration configuration)

### Description
Perform startup of the application in Java SE environments.

### Parameters
- **application** (Application) - The application to start.
- **configuration** (SeBootstrap.Configuration) - The configuration to use.

### Returns
- **CompletionStage<SeBootstrap.Instance>** - A completion stage that completes with the started instance.
```

--------------------------------

### HTTP GET Method Invocations

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/client/CompletionStageRxInvoker.html

Methods for performing asynchronous HTTP GET requests returning CompletionStage.

```java
CompletionStage<Response> get()
```

```java
<T> CompletionStage<T> get(Class<T> responseType)
```

```java
<T> CompletionStage<T> get(GenericType<T> responseType)
```

--------------------------------

### Defining a GET request handler

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/GET.html

Apply this annotation to a method to indicate it should respond to HTTP GET requests.

```java
@Target(METHOD)
@Retention(RUNTIME)
@HttpMethod("GET")
@Documented
public @interface GET
```

--------------------------------

### RuntimeDelegate.bootstrap(Class<? extends Application> clazz, SeBootstrap.Configuration configuration)

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/class-use/SeBootstrap.Instance.html

Perform startup of the application class in Java SE environments.

```APIDOC
## abstract CompletionStage<SeBootstrap.Instance> RuntimeDelegate.bootstrap(Class<? extends Application> clazz, SeBootstrap.Configuration configuration)

### Description
Perform startup of the application class in Java SE environments.

### Parameters
- **clazz** (Class<? extends Application>) - The JAX-RS application class to start.
- **configuration** (SeBootstrap.Configuration) - The configuration to use for the bootstrap.
```

--------------------------------

### Implement and Inject BeanParam

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/BeanParam.html

Example showing a POJO with parameter annotations and its injection into a resource method.

```java
 public class MyBean {
   @FormParam("myData")
   private String data;

   @HeaderParam("myHeader")
   private String header;

   @PathParam("id")
   public void setResourceId(String id) {...}

   ...
 }

 @Path("myresources")
 public class MyResources {
   @POST
   @Path("{id}")
   public void post(@BeanParam MyBean myBean) {...}

   ...
 }
```

--------------------------------

### Bootstrap a Client instance

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/client/package-summary.html

Use ClientBuilder to create a new Client instance and configure it with properties and providers.

```java
 Client client = ClientBuilder.newClient();

 client.property("MyProperty", "MyValue")
         .register(MyProvider.class)
         .register(MyFeature.class);
```

--------------------------------

### Asynchronous GET Request Methods

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/client/AsyncInvoker.html

Methods for invoking HTTP GET asynchronously, returning a Future with the response or entity.

```java
<T> Future<T> get(Class<T> responseType)
```

```java
<T> Future<T> get(GenericType<T> responseType)
```

```java
<T> Future<T> get(InvocationCallback<T> callback)
```

--------------------------------

### Get Application Classes

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/core/Application.html

Retrieves the set of root resource, provider, and feature classes.

```java
public Set<Class<?>> getClasses()
```

--------------------------------

### Bootstrap an application

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/ext/RuntimeDelegate.html

Performs startup of the application in Java SE environments. Applications should use SeBootstrap.start() instead.

```java
public abstract CompletionStage<SeBootstrap.Instance> bootstrap(Application application,
                                                                SeBootstrap.Configuration configuration)
```

--------------------------------

### get(GenericType<T> responseType)

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/client/CompletionStageRxInvoker.html

Invokes an HTTP GET request and converts the response entity to the specified generic type.

```APIDOC
## <T> CompletionStage<T> get(GenericType<T> responseType)

### Description
Invoke HTTP GET method for the current request and convert the response to the specified generic type.

### Parameters
- **responseType** (GenericType<T>) - Required - Representation of a generic Java type the response entity will be converted to.

### Returns
- **CompletionStage<T>** - The invocation response wrapped in the completion aware type.
```

--------------------------------

### get(Class<T> responseType)

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/client/CompletionStageRxInvoker.html

Invokes an HTTP GET request and converts the response entity to the specified class type.

```APIDOC
## <T> CompletionStage<T> get(Class<T> responseType)

### Description
Invoke HTTP GET method for the current request and convert the response to the specified class.

### Parameters
- **responseType** (Class<T>) - Required - The Java type the response entity will be converted to.

### Returns
- **CompletionStage<T>** - The invocation response wrapped in the completion aware type.
```

--------------------------------

### Invoke HTTP GET Request

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/client/RxInvoker.html

Executes an HTTP GET request and converts the response entity to the specified generic type.

```java
<R> T get(GenericType<R> responseType)
```

--------------------------------

### SeBootstrap.Instance.configuration()

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/class-use/SeBootstrap.Configuration.html

Provides access to the configuration actually used by the implementation used to create this instance.

```APIDOC
## SeBootstrap.Instance.configuration()

### Description
Provides access to the configuration actually used by the implementation used to create this instance.

### Returns
- **SeBootstrap.Configuration** - The configuration instance.
```

--------------------------------

### Invoke HTTP GET Method

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/client/RxInvoker.html

Methods for performing a GET request, returning the response wrapped in the reactive type T.

```java
T get()
```

```java
<R> T get(Class<R> responseType)
```

--------------------------------

### Access a Web resource

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/client/package-summary.html

Use the fluent API to target a URI, request a specific media type, and perform an HTTP GET.

```java
 Client client = ClientBuilder.newClient();
 Response res = client.target("http://example.org/hello").request("text/plain").get();
```

--------------------------------

### bootstrap

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/ext/RuntimeDelegate.html

Performs startup of the application in Java SE environments. This method is intended for internal use; applications should use SeBootstrap.start instead.

```APIDOC
## bootstrap

### Description
Perform startup of the application in Java SE environments. This method is not intended to be invoked by applications.

### Signature
`public abstract CompletionStage<SeBootstrap.Instance> bootstrap(Class<? extends Application> clazz, SeBootstrap.Configuration configuration)`

### Parameters
- **clazz** (Class<? extends Application>) - The application class to instantiate and start.
- **configuration** (SeBootstrap.Configuration) - The bootstrap configuration.

### Returns
- **CompletionStage<SeBootstrap.Instance>** - Asynchronously producing handle of the running application instance.
```

--------------------------------

### Create and Send Multipart Entity

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/core/EntityPart.html

Example demonstrating how to build a list of EntityPart objects and send them as a multipart/form-data request using the Jakarta REST Client API.

```java
 Client c = ClientBuilder.newClient();
WebTarget target = c.target(someURL);
List<EntityPart> parts = Arrays.asList(
     EntityPart.withName("name1").fileName("file1.doc").content(stream1).build(),
     EntityPart.withName("name2").fileName("file2.doc").content(stream2).build(),
     EntityPart.withName("name3").fileName("file3.xml").content(myObject, MyClass.class).mediaType("application/xml").build());
GenericEntity<List<EntityPart>> genericEntity = new GenericEntity<>(parts){};
Entity entity = Entity.entity(genericEntity, MediaType.MULTIPART_FORM_DATA);
Response r = target.request().post(entity);
```

--------------------------------

### Implement and Register a Custom TimeoutHandler

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/container/TimeoutHandler.html

Example showing the implementation of the TimeoutHandler interface and its registration within a JAX-RS resource method.

```java
 public class MyTimeoutHandler implements TimeoutHandler {
     …
     public void handleTimeout(AsyncResponse ar) {
         if (keepSuspended) {
             ar.setTimeout(10, SECONDS);
         } else if (cancel) {
             ar.cancel(retryPeriod);
         } else {
             ar.resume(defaultResponse);
         }
     }
     …
 }

 @Path("/messages/next")
 public class MessagingResource {
     …
     @GET
     public void readMessage(@Suspended AsyncResponse ar) {
         ar.setTimeoutHandler(new MyTimeoutHandler());
         suspended.put(ar);
     }
     …
 }
```

--------------------------------

### Iterate Over Enum Constants

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/core/NewCookie.SameSite.html

Example of iterating through all available SameSite enum values.

```java
for (NewCookie.SameSite c : NewCookie.SameSite.values())
	System.out.println(c);
```

--------------------------------

### Execute Synchronous GET Request

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/client/SyncInvoker.html

Methods for performing synchronous GET requests, returning either a raw Response or a mapped entity type.

```java
Response get()
```

```java
<T> T get(Class<T> responseType)
```

```java
<T> T get(GenericType<T> responseType)
```

--------------------------------

### SeBootstrap.Configuration.Builder.build()

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/class-use/SeBootstrap.Configuration.html

Builds a bootstrap configuration instance from the provided property values.

```APIDOC
## SeBootstrap.Configuration.Builder.build()

### Description
Builds a bootstrap configuration instance from the provided property values.

### Returns
- **SeBootstrap.Configuration** - The constructed configuration instance.
```

--------------------------------

### Get entity language

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/client/ClientRequestContext.html

Retrieves the language of the entity.

```java
Locale getLanguage()
```

--------------------------------

### SeBootstrap.Configuration.builder()

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/class-use/SeBootstrap.Configuration.Builder.html

Creates a new instance of the bootstrap configuration builder.

```APIDOC
### Method
static SeBootstrap.Configuration.Builder builder()

### Description
Creates a new bootstrap configuration builder instance used to define the configuration for a JAX-RS bootstrap.
```

--------------------------------

### Get Location

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/client/ClientResponseContext.html

Retrieves the location URI of the response.

```java
URI getLocation()
```

--------------------------------

### Get Metadata

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/core/Response.html

Retrieves the response metadata as a multivalued map.

```java
public abstract MultivaluedMap<String,Object> getMetadata()
```

--------------------------------

### build()

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/client/ClientBuilder.html

Builds a new client instance using all the configuration previously specified in the builder.

```APIDOC
## build()

### Description
Build a new client instance using all the configuration previously specified in this client builder.

### Returns
- **Client** - A new client instance.
```

--------------------------------

### Get Links

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/core/Response.html

Retrieves the links attached to the message as headers.

```java
public abstract Set<Link> getLinks()
```

--------------------------------

### Create a Configuration.Builder instance

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/ext/RuntimeDelegate.html

Creates a new instance of a SeBootstrap.Configuration.Builder. Applications should use SeBootstrap.Configuration.builder() instead.

```java
public abstract SeBootstrap.Configuration.Builder createConfigurationBuilder()
```

--------------------------------

### Get Headers

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/ext/WriterInterceptorContext.html

Retrieves the mutable map of HTTP headers.

```java
MultivaluedMap<String,Object>	getHeaders()
```

--------------------------------

### SeBootstrap.Configuration.Builder Configuration Methods

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/class-use/SeBootstrap.Configuration.Builder.html

Methods for configuring the bootstrap builder instance.

```APIDOC
### Methods
- host(String host): Sets the host to be used.
- port(Integer port): Sets the port to be used.
- protocol(String protocol): Sets the protocol to be used.
- rootPath(String rootPath): Sets the root path to be used.
- property(String name, Object value): Sets a specific property by name and value.
- sslContext(SSLContext sslContext): Sets the SSLContext to be used.
- sslClientAuthentication(SeBootstrap.Configuration.SSLClientAuthentication sslClientAuthentication): Sets the SSL client authentication policy.
```

--------------------------------

### Get Request Information

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/container/ContainerRequestContext.html

Retrieves the injectable request information.

```java
Request getRequest()
```

--------------------------------

### Get request method

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/client/ClientRequestContext.html

Retrieves the HTTP method of the request.

```java
String getMethod()
```

--------------------------------

### build()

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/SeBootstrap.Configuration.Builder.html

Builds a bootstrap configuration instance from the provided property values.

```APIDOC
## SeBootstrap.Configuration.Builder.build()

### Description
Builds a bootstrap configuration instance from the provided property values.

### Returns
- **SeBootstrap.Configuration** - The configuration instance built from provided property values.
```

--------------------------------

### ClientBuilder.newClient()

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/client/package-summary.html

Bootstraps a new Client instance, which serves as the root object for managing communication infrastructure and accessing web resources.

```APIDOC
## ClientBuilder.newClient()

### Description
Creates a new Client instance used to bootstrap and configure the communication infrastructure.

### Usage
```java
Client client = ClientBuilder.newClient();
client.property("MyProperty", "MyValue").register(MyProvider.class);
```
```

--------------------------------

### Get request URI

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/client/ClientRequestContext.html

Retrieves the current request URI.

```java
URI getUri()
```

--------------------------------

### Handling Registration Conflicts

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/core/Configurable.html

Examples of registration attempts that will be rejected by the JAX-RS runtime due to existing registrations.

```java
 config.register(GzipInterceptor.class, WriterInterceptor.class);
 config.register(GzipInterceptor.class); // Rejected by runtime.
 config.register(new GzipInterceptor()); // Rejected by runtime.
 config.register(GzipInterceptor.class, 6500); // Rejected by runtime.

 config.register(new ClientLoggingFilter());
 config.register(ClientLoggingFilter.class); // rejected by runtime.
 config.register(ClientLoggingFilter.class,
         ClientResponseFilter.class); // Rejected by runtime.
 
```

--------------------------------

### Get Application Singletons

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/core/Application.html

Retrieves the set of root resource, provider, and feature instances. This method is deprecated in favor of automatic discovery or getClasses().

```java
@Deprecated
public Set<Object> getSingletons()
```

--------------------------------

### Get Link

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/client/ClientResponseContext.html

Retrieves the link associated with a specific relation.

```java
Link getLink(String relation)
```

--------------------------------

### Construct a RedirectionException

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/RedirectionException.html

Initializes a new instance with a detail message and a redirection response. The response must have a 3xx status code.

```java
public RedirectionException(String message,
                            Response response)
```

--------------------------------

### Convenience Methods

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/SeBootstrap.Configuration.Builder.html

Methods for setting common configuration properties like host, port, protocol, and root path.

```APIDOC
## Convenience Configuration Methods

### Methods
- **protocol(String protocol)**: Sets the protocol to be used.
- **host(String host)**: Sets the host (IP address or hostname) to be used.
- **port(Integer port)**: Sets the port to be used.
- **rootPath(String rootPath)**: Sets the rootPath to be used.
- **sslContext(SSLContext sslContext)**: Sets the SSLContext to be used.

### Description
These methods are convenience wrappers for the `property()` method, allowing for a more fluent configuration experience.
```

--------------------------------

### Create configuration builder

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/SeBootstrap.Configuration.html

Instantiates a new builder for bootstrap configuration.

```java
static SeBootstrap.Configuration.Builder builder()
```

--------------------------------

### Get Content Length

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/core/Response.html

Retrieves the Content-Length header value as an integer.

```java
public abstract int getLength()
```

--------------------------------

### Get Media Type

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/core/Response.html

Retrieves the media type of the message entity.

```java
public abstract MediaType getMediaType()
```

--------------------------------

### Get status code

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/core/Response.Status.html

Retrieves the associated numerical status code.

```java
public int getStatusCode()
```

--------------------------------

### Build and Invoke a Request

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/client/Invocation.Builder.html

Demonstrates building an Invocation object with custom headers and media types, then executing it synchronously.

```java
 Client client = ClientBuilder.newClient();
 WebTarget resourceTarget = client.target("http://examples.jaxrs.com/");

 // Build a HTTP GET request that accepts "text/plain" response type
 // and contains a custom HTTP header entry "Foo: bar".
 Invocation invocation = resourceTarget.request("text/plain")
         .header("Foo", "bar").buildGet();

 // Invoke the request using generic interface
 String response = invocation.invoke(String.class);
```

--------------------------------

### Get size of AbstractMultivaluedMap

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/core/AbstractMultivaluedMap.html

Returns the number of key-value mappings in the map.

```java
public int size()
```

--------------------------------

### RuntimeDelegate.createConfigurationBuilder()

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/class-use/SeBootstrap.Configuration.Builder.html

Creates a new instance of a SeBootstrap.Configuration.Builder via the RuntimeDelegate.

```APIDOC
### Method
SeBootstrap.Configuration.Builder createConfigurationBuilder()

### Description
Creates a new instance of a SeBootstrap.Configuration.Builder, typically used within the jakarta.ws.rs.ext package context.
```

--------------------------------

### Get Application Properties

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/core/Application.html

Retrieves a map of custom application-wide properties.

```java
public Map<String,Object> getProperties()
```

--------------------------------

### from(Object)

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/SeBootstrap.Configuration.Builder.html

Bulk-loads configuration from an external configuration object.

```APIDOC
## from(Object)

### Description
Optional convenience method to bulk-load external configuration. Support for this method is implementation-specific; if unsupported, the method performs no action.

### Parameters
- **externalConfig** (Object) - Required - The source of externally managed properties.

### Returns
- **SeBootstrap.Configuration.Builder** - The updated builder instance.
```

--------------------------------

### Get Links

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/client/ClientResponseContext.html

Retrieves the set of links attached to the response message.

```java
Set<Link> getLinks()
```

--------------------------------

### Asynchronous Request Processing with AsyncResponse

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/container/AsyncResponse.html

Demonstrates using AsyncResponse to suspend a GET request and resume it later via a POST request.

```java
 @Path("/messages/next")
 public class MessagingResource {
     private static final BlockingQueue<AsyncResponse> suspended = new ArrayBlockingQueue<AsyncResponse>(5);

     @GET
     public void readMessage(@Suspended AsyncResponse ar) throws InterruptedException {
         suspended.put(ar);
     }

     @POST
     public String postMessage(final String message) throws InterruptedException {
         final AsyncResponse ar = suspended.take();
         ar.resume(message); // resumes the processing of one GET request
         return "Message sent";
     }
 }
```

--------------------------------

### Get Entity Tag

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/client/ClientResponseContext.html

Retrieves the entity tag associated with the response.

```java
EntityTag getEntityTag()
```

--------------------------------

### Get Media Type

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/client/ClientResponseContext.html

Retrieves the media type of the response entity.

```java
MediaType getMediaType()
```

--------------------------------

### Get Last Modified Date

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/core/Response.html

Retrieves the last modified date of the entity.

```java
public abstract Date getLastModified()
```

--------------------------------

### build()

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/sse/SseEventSource.Builder.html

Constructs a new SseEventSource instance configured by the builder, ready to be opened.

```APIDOC
## Method: build

### Description
Builds a new SSE event source pointing at the configured SSE streaming web target. The returned instance is ready but not yet connected; the user must manually invoke open() to start receiving events.

### Returns
- **SseEventSource** - A new event source instance.
```

--------------------------------

### Get Output Stream

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/ext/WriterInterceptorContext.html

Retrieves the output stream used for writing the entity.

```java
OutputStream	getOutputStream()
```

--------------------------------

### ClientBuilder.newClient(Configuration)

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/client/ClientBuilder.html

Creates a new custom-configured Client instance.

```APIDOC
## ClientBuilder.newClient(Configuration configuration)

### Description
Creates a new custom-configured Client instance using the default client builder implementation class provided by the JAX-RS implementation provider.

### Parameters
- **configuration** (Configuration) - The configuration to apply to the new client.

### Returns
- **Client** - A new custom-configured client instance.
```

--------------------------------

### Get Entity

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/ext/WriterInterceptorContext.html

Retrieves the object currently set to be written as the HTTP entity.

```java
Object	getEntity()
```

--------------------------------

### getMediaType / setMediaType

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/ext/InterceptorContext.html

Methods to get or update the media type of the HTTP entity.

```APIDOC
## MediaType getMediaType()

### Description
Returns the media type of the HTTP entity.

## void setMediaType(MediaType mediaType)

### Description
Updates the media type of the HTTP entity.

### Parameters
- **mediaType** (MediaType) - The new media type for the HTTP entity.
```

--------------------------------

### Build Method

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/sse/SseEventSource.Builder.html

Constructs a new SseEventSource instance that is ready to be opened.

```java
public abstract SseEventSource build()
```

--------------------------------

### Get value from AbstractMultivaluedMap

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/core/AbstractMultivaluedMap.html

Returns the list of values to which the specified key is mapped.

```java
public List<V> get(Object key)
```

--------------------------------

### Constructing a NewCookie

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/core/NewCookie.Builder.html

Demonstrates the fluent builder pattern to configure and instantiate a new cookie.

```java
 NewCookie cookie = new NewCookie.Builder("name")
         .path("/")
         .domain("domain.com")
         .sameSite(SameSite.LAX)
         .build();
```

--------------------------------

### Get message date

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/client/ClientRequestContext.html

Retrieves the date associated with the message, or null if not present.

```java
Date getDate()
```

--------------------------------

### Get request headers

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/client/ClientRequestContext.html

Retrieves the mutable multivalued map of request headers.

```java
MultivaluedMap<String,Object> getHeaders()
```

--------------------------------

### Initialize WebApplicationException

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/WebApplicationException.html

Constructors for creating a WebApplicationException with various configurations including default status, custom messages, and response objects.

```java
public WebApplicationException()
```

```java
public WebApplicationException(String message)
```

```java
public WebApplicationException(Response response)
```

--------------------------------

### Get Link Builder

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/client/ClientResponseContext.html

Returns a builder for the link associated with a specific relation.

```java
Link.Builder getLinkBuilder(String relation)
```

--------------------------------

### configuration()

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/SeBootstrap.Instance.html

Retrieves the configuration actually used by the implementation to create the application instance, including updated properties like the port.

```APIDOC
## SeBootstrap.Instance.configuration()

### Description
Provides access to the configuration actually used by the implementation to create this instance. This may differ from the configuration passed during startup, as implementations may update properties such as the port.

### Returns
- **SeBootstrap.Configuration** - The configuration actually used to create this instance.
```

--------------------------------

### Get Last Modified Date

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/client/ClientResponseContext.html

Retrieves the last modified date of the response.

```java
Date getLastModified()
```

--------------------------------

### Build Client Instance

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/client/ClientBuilder.html

Creates a new Client instance based on the current configuration of the builder.

```java
public abstract Client build()
```

--------------------------------

### Get Cookies

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/client/ClientResponseContext.html

Retrieves a read-only map of new cookies set on the response.

```java
Map<String,NewCookie> getCookies()
```

--------------------------------

### Building a Cookie Instance

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/core/Cookie.Builder.html

Finalizes the configuration and returns a new Cookie instance.

```java
public	Cookie	build()
```

--------------------------------

### Get Hostname Verifier

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/client/Client.html

Retrieves the configured HostnameVerifier, or null if none is set.

```java
HostnameVerifier getHostnameVerifier()
```

--------------------------------

### Bulk-load Configuration from Provider

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/SeBootstrap.Configuration.Builder.html

Loads configuration properties using a provided function that maps property names and types to values.

```java
<T> SeBootstrap.Configuration.Builder from(BiFunction<String, Class<T>, Optional<T>> propertiesProvider)
```

--------------------------------

### Get SSL Context

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/client/Client.html

Retrieves the SSLContext configured for the current client runtime.

```java
SSLContext getSslContext()
```

--------------------------------

### ClientBuilder.newClient()

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/client/ClientBuilder.html

Creates a new Client instance using the default client builder implementation.

```APIDOC
## ClientBuilder.newClient()

### Description
Creates a new Client instance using the default client builder implementation class provided by the JAX-RS implementation provider.

### Returns
- **Client** - A new client instance.
```

--------------------------------

### Accessing Instance Configuration

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/SeBootstrap.Instance.html

Retrieves the configuration actually used by the implementation, which may differ from the initial configuration provided during startup.

```java
SeBootstrap.Configuration configuration()
```

--------------------------------

### Implement the configure method

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/container/DynamicFeature.html

The callback method signature used to register providers within the runtime configuration scope of a resource method.

```java
void configure(ResourceInfo resourceInfo,
               FeatureContext context)
```

--------------------------------

### getGenericType / setGenericType

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/ext/InterceptorContext.html

Methods to get or update the generic type of the object to be produced or written.

```APIDOC
## Type getGenericType()

### Description
Returns the type of the object to be produced or written.

## void setGenericType(Type genericType)

### Description
Updates the type of the object to be produced or written.

### Parameters
- **genericType** (Type) - The new type for the object.
```

--------------------------------

### Sse.newBroadcaster()

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/sse/Sse.html

Creates a new Server-sent event broadcaster.

```APIDOC
## SseBroadcaster newBroadcaster()

### Description
Get a new Server-sent event broadcaster.

### Returns
- **SseBroadcaster** - New Server-sent event broadcaster instance.
```

--------------------------------

### from(BiFunction<String, Class<T>, Optional<T>>)

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/SeBootstrap.Configuration.Builder.html

Bulk-loads configuration from a property supplier function.

```APIDOC
## from(BiFunction<String, Class<T>, Optional<T>>)

### Description
Convenience method for bulk-loading configuration from a property supplier. The implementation queries the provider for property values based on name and expected type.

### Parameters
- **propertiesProvider** (BiFunction<String, Class<T>, Optional<T>>) - Required - A function to retrieve externally managed properties.

### Returns
- **SeBootstrap.Configuration.Builder** - The updated builder instance.
```

--------------------------------

### Get generic type from InterceptorContext

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/ext/InterceptorContext.html

Retrieves the generic type of the object to be produced or written.

```java
Type getGenericType()
```

--------------------------------

### Get Input Stream

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/ext/ReaderInterceptorContext.html

Retrieves the current input stream associated with the entity being read.

```java
InputStream getInputStream()
```

--------------------------------

### Initialize MultivaluedHashMap

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/core/MultivaluedHashMap.html

Various constructors for creating a new MultivaluedHashMap instance with different initial configurations.

```java
public MultivaluedHashMap()
```

```java
public MultivaluedHashMap(int initialCapacity)
```

```java
public MultivaluedHashMap(int initialCapacity,
                          float loadFactor)
```

```java
public MultivaluedHashMap(MultivaluedMap<? extends K,? extends V> map)
```

```java
public MultivaluedHashMap(Map<? extends K,? extends V> map)
```

--------------------------------

### Get entry set of AbstractMultivaluedMap

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/core/AbstractMultivaluedMap.html

Returns a set view of the mappings contained in this map.

```java
public Set<Map.Entry<K,List<V>>> entrySet()
```

--------------------------------

### Initialize Link Builder from Link Object

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/core/Link.Builder.html

Initializes the builder using an existing Link instance, copying the URI and all parameters.

```java
Link.Builder link(Link link)
```

--------------------------------

### Get key set of AbstractMultivaluedMap

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/core/AbstractMultivaluedMap.html

Returns a set view of the keys contained in this map.

```java
public Set<K> keySet()
```

--------------------------------

### SeBootstrap.Configuration.Builder

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/SeBootstrap.html

A builder pattern used to construct the configuration for the SeBootstrap process, allowing customization of network and security settings.

```APIDOC
## SeBootstrap.Configuration.builder()

### Description
Provides a fluent API to configure the bootstrap environment, including protocol, host, port, root path, SSL context, and client authentication requirements.

### Methods
- **protocol(String)** - Sets the protocol (e.g., "HTTPS").
- **host(String)** - Sets the host address.
- **port(int)** - Sets the network port.
- **rootPath(String)** - Sets the base path for the application.
- **sslContext(SSLContext)** - Configures TLS/SSL settings.
- **sslClientAuthentication(SSLClientAuthentication)** - Enforces client authentication (e.g., MANDATORY).
- **property(String, Object)** - Sets implementation-specific properties.
```

--------------------------------

### Initialize Response

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/core/Response.html

Protected constructor for the Response class.

```java
protected Response()
```

--------------------------------

### SeBootstrap.Configuration Interface Definition

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/SeBootstrap.Configuration.html

The primary interface for defining JAX-RS bootstrap configuration parameters.

```java
public static interface SeBootstrap.Configuration
```

--------------------------------

### Get Length

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/container/ContainerResponseContext.html

Retrieves the Content-Length value as an integer, returning -1 if not present or invalid.

```java
int getLength()
```

--------------------------------

### Get acceptable media types

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/client/ClientRequestContext.html

Retrieves a list of media types acceptable for the response.

```java
List<MediaType> getAcceptableMediaTypes()
```

--------------------------------

### Initialize UriBuilder via Protected Constructor

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/core/UriBuilder.html

The constructor is protected; use static factory methods to obtain an instance.

```java
protected UriBuilder()
```

--------------------------------

### Get Entity Stream

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/client/ClientResponseContext.html

Retrieves the entity input stream, which the JAX-RS runtime will close.

```java
InputStream getEntityStream()
```

--------------------------------

### Build Cookie instance

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/core/Cookie.AbstractCookieBuilder.html

Finalizes the configuration and returns a new Cookie instance.

```java
public abstract Cookie build()
```

--------------------------------

### Create a Response with ResponseBuilder

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/core/Response.ResponseBuilder.html

Demonstrates using Response.created to build a response indicating the creation of a new resource.

```java
 @POST
 Response addWidget(...) {
   Widget w = ...
   URI widgetId = UriBuilder.fromResource(Widget.class)...
   return Response.created(widgetId).build();
 }
```

--------------------------------

### Initialize Link Builder from String

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/core/Link.Builder.html

Initializes the builder using a string representation of a link, following RFC 5988 syntax.

```java
Link.Builder link(String link)
```

```text
 link ::= '<' uri 'gt;' (';' link-param)*
 link-param ::= name '=' quoted-string
```

--------------------------------

### Create EntityPart Builder

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/core/EntityPart.html

Methods for initializing an EntityPart builder instance.

```java
static EntityPart.Builder withName(String partName)
```

```java
static EntityPart.Builder withFileName(String partAndFileName)
```

--------------------------------

### Invalid Provider Constraint

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/ConstrainedTo.html

Example of an invalid configuration where a ClientRequestFilter is restricted to the server runtime.

```java
  // reported as invalid and ignored by JAX-RS runtime
  @ConstrainedTo(RuntimeType.SERVER)
  public class MyFilter implements ClientRequestFilter {
      ...
  }
```

--------------------------------

### SeBootstrap.Configuration.sslClientAuthentication()

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/class-use/SeBootstrap.Configuration.SSLClientAuthentication.html

Retrieves the current SSL client authentication policy from the configuration.

```APIDOC
## Method: SeBootstrap.Configuration.sslClientAuthentication()

### Description
Returns the secure socket client authentication policy configured for the SeBootstrap instance.

### Signature
`default SeBootstrap.Configuration.SSLClientAuthentication sslClientAuthentication()`
```

--------------------------------

### Bulk-load Configuration

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/SeBootstrap.html

Loads configuration properties from external systems, either explicitly or implicitly.

```java
 // Explicit use of particular configuration mechanics is portable
 SeBootstrap.Configuration.builder().from((name, type) -> externalConfigurationSystem.getValue(name, type)).build();

 // Implicitly relying on the support of particular configuration mechanics by
 // the actual JAX-RS implementation is not necessarily portable
 SeBootstrap.Configuration.builder().from(externalConfigurationSystem).build();
 
```

--------------------------------

### Restrict Provider to Server Runtime

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/ConstrainedTo.html

Example of restricting a WriterInterceptor to the JAX-RS server runtime.

```java
  @ConstrainedTo(RuntimeType.SERVER)
  public class MyWriterInterceptor implements WriterInterceptor {
      ...
  }
```

--------------------------------

### Restrict Provider to Client Runtime

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/ConstrainedTo.html

Example of restricting a MessageBodyReader to the JAX-RS client runtime.

```java
  @ConstrainedTo(RuntimeType.CLIENT)
  public class MyReader implements MessageBodyReader {
      ...
  }
```

--------------------------------

### options()

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/client/SyncInvoker.html

Invokes the HTTP OPTIONS method synchronously and returns the raw Response object.

```APIDOC
## options()

### Description
Invokes the HTTP OPTIONS method for the current request synchronously.

### Returns
- **Response** - The invocation response.

### Throws
- **ResponseProcessingException** - If processing the received HTTP response fails.
- **ProcessingException** - If request processing or I/O fails.
```

--------------------------------

### Get Allowed Methods

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/core/Response.html

Retrieves the allowed HTTP methods from the Allow header as uppercase strings.

```java
public abstract Set<String> getAllowedMethods()
```

--------------------------------

### getInstance()

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/ext/RuntimeDelegate.html

Obtains a RuntimeDelegate instance. If no instance has been set via setInstance, it uses a discovery algorithm to locate and instantiate the implementation class.

```APIDOC
## public static RuntimeDelegate getInstance()

### Description
Obtain a RuntimeDelegate instance. If an instance had not already been created and set via setInstance(RuntimeDelegate), the first invocation will create an instance which will then be cached for future use.

### Returns
- **RuntimeDelegate** - an instance of RuntimeDelegate.
```

--------------------------------

### getType / setType

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/ext/InterceptorContext.html

Methods to get or update the Java type supported by the message body provider.

```APIDOC
## Class<?> getType()

### Description
Returns the Java type supported by the corresponding message body provider.

## void setType(Class<?> type)

### Description
Updates the Java type before calling the message body provider.

### Parameters
- **type** (Class<?>) - The Java type for the provider.
```

--------------------------------

### Constructor with Response

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/RedirectionException.html

Constructs a new redirection exception using a full Response object.

```java
public	RedirectionException(Response	response)
```

--------------------------------

### getConfiguration()

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/core/Configurable.html

Retrieves a live view of the internal configuration state of the configurable instance.

```APIDOC
## Configuration getConfiguration()

### Description
Returns a live view of the internal configuration state. Changes made to the parent configurable object are reflected in this view.

### Returns
- **Configuration** - A live view of the internal configuration state.
```

--------------------------------

### Get Property Value

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/core/Configuration.html

Retrieves the value of a specific property by name, returning null if not found.

```java
Object getProperty(String name)
```

--------------------------------

### OutboundSseEvent.Builder.build()

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/sse/class-use/OutboundSseEvent.html

Builds an instance of an OutboundSseEvent.

```APIDOC
## OutboundSseEvent.Builder.build()

### Description
Builds an OutboundSseEvent instance.

### Method
build()

### Returns
- **OutboundSseEvent** - The constructed event instance.
```

--------------------------------

### Iterate Over Enum Constants

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/core/Response.Status.Family.html

Example usage of the values() method to iterate through all defined status families.

```java
for (Response.Status.Family c : Response.Status.Family.values())
	System.out.println(c);
```

--------------------------------

### Example of Entity Annotations with Class-Level Annotations

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/container/ContainerResponseContext.html

Illustrates that annotations on the entity class itself are not included in the context.

```java
 @Custom
 public class AnnotatedMe { ... }

 @Path("my-resource")
 public class MyResource {
   private final Annotations[] extras = ... ;

   @GET
   public AnnotatedMe getMe() {
     return Response.ok().entity(new AnnotatedMe(), extras).build();
   }
   ...
 }
```

--------------------------------

### Create OK ResponseBuilder

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/core/Response.html

Initializes a ResponseBuilder with an OK status, optionally including an entity, media type, or variant.

```java
public static Response.ResponseBuilder ok()
```

```java
public static Response.ResponseBuilder ok(Object entity)
```

```java
public static Response.ResponseBuilder ok(Object entity,
                                          MediaType type)
```

```java
public static Response.ResponseBuilder ok(Object entity,
                                          String type)
```

```java
public static Response.ResponseBuilder ok(Object entity,
                                          Variant variant)
```

--------------------------------

### Use Suspended with AsyncResponse

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/container/Suspended.html

Example of injecting AsyncResponse to handle long-running operations asynchronously with a timeout.

```java
  @Stateless
  @Path("/")
  public class MyEjbResource {
    …
    @GET
    @Asynchronous
    public void longRunningOperation(@Suspended AsyncResponse ar) {
      ar.setTimeoutHandler(customHandler);
      ar.setTimeout(10, TimeUnit.SECONDS);
      final String result = executeLongRunningOperation();
      ar.resume(result);
    }

    private String executeLongRunningOperation() { … }
  }
```

--------------------------------

### Iterate Over Enum Constants

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/SeBootstrap.Configuration.SSLClientAuthentication.html

Example usage of the values() method to iterate over all defined authentication policies.

```java
for (SeBootstrap.Configuration.SSLClientAuthentication c : SeBootstrap.Configuration.SSLClientAuthentication.values())
	   System.out.println(c);
```

--------------------------------

### queryParam

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/client/WebTarget.html

Creates a new WebTarget instance by configuring a query parameter on the URI.

```APIDOC
## WebTarget.queryParam(String name, Object... values)

### Description
Creates a new WebTarget instance by configuring a query parameter on the URI. If a single null value is provided, parameters with that name are removed.

### Parameters
- **name** (String) - Required - The query parameter name.
- **values** (Object...) - Optional - The query parameter value(s).

### Returns
- **WebTarget** - A new target instance.
```

--------------------------------

### Iterate Over RuntimeType Constants

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/RuntimeType.html

Example usage of the values() method to iterate through all defined runtime types.

```java
for (RuntimeType c : RuntimeType.values())
	   System.out.println(c);
```

--------------------------------

### SseEventSource.open

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/sse/SseEventSource.html

Opens the connection to the SSE endpoint and begins processing events.

```APIDOC
## void open()

### Description
Opens the connection to the supplied SSE underlying web target and starts processing incoming events.
```

--------------------------------

### newInstance()

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/core/Variant.VariantListBuilder.html

Creates a new instance of the VariantListBuilder.

```APIDOC
## static VariantListBuilder newInstance()

### Description
Creates a new builder instance for constructing a list of representation variants.

### Returns
- **VariantListBuilder** - A new instance of the builder.
```

--------------------------------

### Get Java type from InterceptorContext

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/ext/InterceptorContext.html

Retrieves the Java type supported by the corresponding message body provider.

```java
Class<?> getType()
```

--------------------------------

### Get annotations from InterceptorContext

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/ext/InterceptorContext.html

Retrieves the annotations declared on the artifact that initiated the intercepted entity provider invocation.

```java
Annotation[] getAnnotations()
```

--------------------------------

### Retrieve Matched URIs

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/core/UriInfo.html

Method to get a list of URIs for matched resources in reverse matching order.

```java
List<String> getMatchedURIs()
```

```java
@Path("foo")
 public class FooResource {
  @GET
  public String getFoo() {...}

  @Path("bar")
  public BarResource getBarResource() {...}
 }
```

--------------------------------

### Get Allowed Methods

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/container/ContainerResponseContext.html

Retrieves the allowed HTTP methods from the Allow header as a set of uppercase strings.

```java
Set<String> getAllowedMethods()
```

--------------------------------

### Initialize Link Builder from URI

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/core/Link.html

Creates a new builder instance initialized from a URI or a URI string.

```java
public static Link.Builder fromUri(URI uri)
```

```java
public static Link.Builder fromUri(String uri)
```

--------------------------------

### WebTarget.request()

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/client/WebTarget.html

Initiates the building of a request to the targeted web resource.

```APIDOC
## request

### Description
Starts building a request to the targeted web resource.

### Returns
- **Invocation.Builder** - An invocation builder for the targeted resource.
```

--------------------------------

### Add Variant Combinations

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/core/Variant.VariantListBuilder.html

Methods to add current metadata to the builder and examples of generating variant combinations.

```java
public abstract Variant.VariantListBuilder add()
```

```java
 List<Variant> list = VariantListBuilder.newInstance()
         .languages(Locale.ENGLISH, Locale.FRENCH).encodings("zip", "identity").add()
         .languages(Locale.GERMAN).mediaTypes(MediaType.TEXT_PLAIN_TYPE).add()
         .build()
```

```java
 List<Variant> list = VariantListBuilder.newInstance()
         .languages(Locale.ENGLISH, Locale.FRENCH).encodings("zip", "identity").add()
         .languages(Locale.GERMAN).mediaTypes(MediaType.TEXT_PLAIN_TYPE)
         .build()
```

--------------------------------

### Creating an SseEventSource Builder

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/sse/SseEventSource.html

Initializes a builder for configuring an SseEventSource instance for a specific WebTarget.

```java
static SseEventSource.Builder target(WebTarget endpoint)
```

--------------------------------

### Client Target Creation

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/client/class-use/WebTarget.html

Methods provided by the Client interface to initialize a new WebTarget instance.

```APIDOC
## Client.target

### Description
Initializes a new web resource target from various input types.

### Methods
- **target(String uri)**: Creates a WebTarget from a URI string.
- **target(URI uri)**: Creates a WebTarget from a URI object.
- **target(UriBuilder uriBuilder)**: Creates a WebTarget from a UriBuilder.
- **target(Link link)**: Creates a WebTarget from a Link object.
```

--------------------------------

### SeBootstrap.Instance.stop()

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/class-use/SeBootstrap.Instance.StopResult.html

Initiates an immediate shutdown of the running application instance and returns a CompletionStage containing the StopResult.

```APIDOC
## Method: SeBootstrap.Instance.stop()

### Description
Initiate immediate shutdown of running application instance.

### Returns
- **CompletionStage<SeBootstrap.Instance.StopResult>** - A completion stage that completes when the shutdown process is finished.
```

--------------------------------

### Manage entity output stream

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/client/ClientRequestContext.html

Methods to get or set the entity output stream, managed by the JAX-RS runtime.

```java
OutputStream getEntityStream()
```

```java
void setEntityStream(OutputStream outputStream)
```

--------------------------------

### Override Configuration Parameters

Source: https://javadoc.io/doc/jakarta.ws.rs/jakarta.ws.rs-api/3.1.0/jakarta.ws.rs/jakarta/ws/rs/SeBootstrap.html

Explicitly sets the protocol, host, port, and root path for the bootstrap configuration.

```java
 SeBootstrap.Configuration.builder().protocol("HTTPS").host("0.0.0.0").port(8443).rootPath("api").build();
 
```
Tokens:
Raw