Examples of javax.ws.rs.container.TimeoutHandler

javax.ws.rs.container.TimeoutHandler
Asynchronous response suspend time-out handler. JAX-RS users may utilize this callback interface to provide custom resolution of time-out events.
By default, JAX-RS runtime generates a {@link javax.ws.rs.WebApplicationException}with a {@link javax.ws.rs.core.Response.Status#SERVICE_UNAVAILABLE HTTP 503(Service unavailable)} error response status code. A custom time-out handlermay be {@link AsyncResponse#setTimeoutHandler(TimeoutHandler) set} on anasynchronous response instance to provide custom time-out event resolution.

In case of a suspend time-out event, a custom time-out handler takes typically one of the following actions:
- Resumes the suspended asynchronous response using a {@link AsyncResponse#resume(Object) custom response} or a {@link AsyncResponse#resume(Throwable) custom exception}
- Cancels the response by calling one of the {@link AsyncResponse} {@code cancel(...)}methods.
- Extends the suspend period of the response by {@link AsyncResponse#setTimeout(long,java.util.concurrent.TimeUnit) setting a new suspend time-out}
If the registered time-out handler does not take any of the actions above, the default time-out event processing continues and the response is resumed with a generated {@code WebApplicationException} containing the HTTP 503 status code.

Following example illustrates the use of a custom {@code TimeoutHandler}:
```
 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); } … } 
```
@author Marek Potociar @since 2.0

                        .build());
    }


    public AsyncResponseHandler withTimeout(Duration timeout, final Response timeoutResponse)
    {
        asyncResponse.setTimeoutHandler(new TimeoutHandler()
        {
            @Override
            public void handleTimeout(AsyncResponse asyncResponse)
            {
                asyncResponse.resume(timeoutResponse);

View Full Code Here

        return withTimeout(timeout, Suppliers.ofInstance(timeoutResponse));
    }


    public AsyncResponseHandler withTimeout(Duration timeout, final Supplier<Response> timeoutResponse)
    {
        asyncResponse.setTimeoutHandler(new TimeoutHandler()
        {
            @Override
            public void handleTimeout(AsyncResponse asyncResponse)
            {
                asyncResponse.resume(timeoutResponse.get());

View Full Code Here

            responder.completionCallbackRunner.register(this);
        }


        @Override
        public void onTimeout(final ContainerResponseWriter responseWriter) {
            final TimeoutHandler handler = timeoutHandler;
            try {
                synchronized (stateLock) {
                    if (state == SUSPENDED) {
                        handler.handleTimeout(this);
                    }
                }
            } catch (final Throwable throwable) {
                resume(throwable);
            }

View Full Code Here

            responder.completionCallbackRunner.register(this);
        }


        @Override
        public void onTimeout(ContainerResponseWriter responseWriter) {
            final TimeoutHandler handler = timeoutHandler;
            try {
                synchronized (stateLock) {
                    if (state == SUSPENDED) {
                        handler.handleTimeout(this);
                    }
                }
            } catch (Throwable throwable) {
                try {
                    resume(throwable);

View Full Code Here

    @Resource(name = "DefaultManagedThreadFactory")
    ManagedThreadFactory threadFactory;
    
    @GET
    public void getList(@Suspended final AsyncResponse ar) {
        ar.setTimeoutHandler(new TimeoutHandler() {


            @Override
            public void handleTimeout(AsyncResponse ar) {
                ar.resume("Operation timed out");
            }

View Full Code Here

0 1

TOP

Related Classes of javax.ws.rs.container.TimeoutHandler

com.proofpoint.http.server.AsyncResponseHandler

io.airlift.http.server.AsyncResponseHandler

io.fathom.cloud.storage.api.os.resources.WatchResource

org.glassfish.jersey.apache.connector.AsyncTest$AsyncResource

org.glassfish.jersey.grizzly.connector.AsyncTest$AsyncResource

org.glassfish.jersey.jetty.AsyncTest$AsyncResource

org.glassfish.jersey.jetty.connector.AsyncTest$AsyncResource

org.glassfish.jersey.server.ServerRuntime$AsyncResponder

org.glassfish.jersey.tests.e2e.client.httpurlconnector.AsyncTest$AsyncResource

org.glassfish.jersey.tests.integration.servlet_3_async.AsyncCancelTimeoutResource

All source code are property of their respective owners. Java is a trademark of Sun Microsystems, Inc and owned by ORACLE Inc. Contact coftware#gmail.com.