/*
 * Copyright (c) 2012, 2019 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0, which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the
 * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
 * version 2 with the GNU Classpath Exception, which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 */

package jakarta.ws.rs;

import static jakarta.ws.rs.core.HttpHeaders.RETRY_AFTER;
import static jakarta.ws.rs.core.Response.Status.SERVICE_UNAVAILABLE;

import java.util.Date;

import jakarta.ws.rs.core.HttpHeaders;
import jakarta.ws.rs.core.Response;
import jakarta.ws.rs.ext.RuntimeDelegate;

A runtime exception indicating that the requested resource cannot be served.
Author:Marek Potociar
Since:2.0
/** * A runtime exception indicating that the requested resource * {@link jakarta.ws.rs.core.Response.Status#SERVICE_UNAVAILABLE cannot be served}. * * @author Marek Potociar * @since 2.0 */
public class ServiceUnavailableException extends ServerErrorException { private static final long serialVersionUID = 3821068205617492633L;
Construct a new "service unavailable" exception without any "Retry-After" information specified for the failed request.
/** * Construct a new "service unavailable" exception without any "Retry-After" information specified for the failed * request. */
public ServiceUnavailableException() { super(Response.status(SERVICE_UNAVAILABLE).build()); }
Construct a new "service unavailable" exception without any "Retry-After" information specified for the failed request.
Params:
/** * Construct a new "service unavailable" exception without any "Retry-After" information specified for the failed * request. * * @param message the detail message (which is saved for later retrieval by the {@link #getMessage()} method). */
public ServiceUnavailableException(final String message) { super(message, Response.status(SERVICE_UNAVAILABLE).build()); }
Construct a new "service unavailable" exception with an interval specifying the "Retry-After" information for the failed request.
Params:
  • retryAfter – decimal interval in seconds after which the failed request may be retried.
/** * Construct a new "service unavailable" exception with an interval specifying the "Retry-After" information for the * failed request. * * @param retryAfter decimal interval in seconds after which the failed request may be retried. */
public ServiceUnavailableException(final Long retryAfter) { super(Response.status(SERVICE_UNAVAILABLE).header(RETRY_AFTER, retryAfter).build()); }
Construct a new "service unavailable" exception with an interval specifying the "Retry-After" information for the failed request.
Params:
  • message – the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
  • retryAfter – decimal interval in seconds after which the failed request may be retried.
/** * Construct a new "service unavailable" exception with an interval specifying the "Retry-After" information for the * failed request. * * @param message the detail message (which is saved for later retrieval by the {@link #getMessage()} method). * @param retryAfter decimal interval in seconds after which the failed request may be retried. */
public ServiceUnavailableException(final String message, final Long retryAfter) { super(message, Response.status(SERVICE_UNAVAILABLE).header(RETRY_AFTER, retryAfter).build()); }
Construct a new "service unavailable" exception with an interval specifying the "Retry-After" information for the failed request.
Params:
  • retryAfter – a date/time after which the failed request may be retried.
/** * Construct a new "service unavailable" exception with an interval specifying the "Retry-After" information for the * failed request. * * @param retryAfter a date/time after which the failed request may be retried. */
public ServiceUnavailableException(final Date retryAfter) { super(Response.status(SERVICE_UNAVAILABLE).header(RETRY_AFTER, retryAfter).build()); }
Construct a new "service unavailable" exception with an interval specifying the "Retry-After" information for the failed request.
Params:
  • message – the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
  • retryAfter – a date/time after which the failed request may be retried.
/** * Construct a new "service unavailable" exception with an interval specifying the "Retry-After" information for the * failed request. * * @param message the detail message (which is saved for later retrieval by the {@link #getMessage()} method). * @param retryAfter a date/time after which the failed request may be retried. */
public ServiceUnavailableException(final String message, final Date retryAfter) { super(message, Response.status(SERVICE_UNAVAILABLE).header(RETRY_AFTER, retryAfter).build()); }
Construct a new "service unavailable" exception.
Params:
  • response – error response.
Throws:
/** * Construct a new "service unavailable" exception. * * @param response error response. * @throws IllegalArgumentException in case the status code set in the response is not HTTP {@code 503}. */
public ServiceUnavailableException(final Response response) { super(validate(response, SERVICE_UNAVAILABLE)); }
Construct a new "service unavailable" exception.
Params:
  • message – the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
  • response – error response.
Throws:
/** * Construct a new "service unavailable" exception. * * @param message the detail message (which is saved for later retrieval by the {@link #getMessage()} method). * @param response error response. * @throws IllegalArgumentException in case the status code set in the response is not HTTP {@code 503}. */
public ServiceUnavailableException(final String message, final Response response) { super(message, validate(response, SERVICE_UNAVAILABLE)); }
Construct a new "service unavailable" exception with a date specifying the "Retry-After" information for the failed request and an underlying request failure cause.
Params:
  • retryAfter – a date/time after which the failed request may be retried.
  • cause – the underlying cause of the exception.
/** * Construct a new "service unavailable" exception with a date specifying the "Retry-After" information for the failed * request and an underlying request failure cause. * * @param retryAfter a date/time after which the failed request may be retried. * @param cause the underlying cause of the exception. */
public ServiceUnavailableException(final Date retryAfter, final Throwable cause) { super(Response.status(SERVICE_UNAVAILABLE).header(RETRY_AFTER, retryAfter).build(), cause); }
Construct a new "service unavailable" exception with a date specifying the "Retry-After" information for the failed request and an underlying request failure cause.
Params:
  • message – the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
  • retryAfter – a date/time after which the failed request may be retried.
  • cause – the underlying cause of the exception.
/** * Construct a new "service unavailable" exception with a date specifying the "Retry-After" information for the failed * request and an underlying request failure cause. * * @param message the detail message (which is saved for later retrieval by the {@link #getMessage()} method). * @param retryAfter a date/time after which the failed request may be retried. * @param cause the underlying cause of the exception. */
public ServiceUnavailableException(final String message, final Date retryAfter, final Throwable cause) { super(message, Response.status(SERVICE_UNAVAILABLE).header(RETRY_AFTER, retryAfter).build(), cause); }
Construct a new "service unavailable" exception with an interval specifying the "Retry-After" information for the failed request and an underlying request failure cause.
Params:
  • retryAfter – decimal interval in seconds after which the failed request may be retried.
  • cause – the underlying cause of the exception.
/** * Construct a new "service unavailable" exception with an interval specifying the "Retry-After" information for the * failed request and an underlying request failure cause. * * @param retryAfter decimal interval in seconds after which the failed request may be retried. * @param cause the underlying cause of the exception. */
public ServiceUnavailableException(final Long retryAfter, final Throwable cause) { super(Response.status(SERVICE_UNAVAILABLE).header(RETRY_AFTER, retryAfter).build(), cause); }
Construct a new "service unavailable" exception with an interval specifying the "Retry-After" information for the failed request and an underlying request failure cause.
Params:
  • message – the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
  • retryAfter – decimal interval in seconds after which the failed request may be retried.
  • cause – the underlying cause of the exception.
/** * Construct a new "service unavailable" exception with an interval specifying the "Retry-After" information for the * failed request and an underlying request failure cause. * * @param message the detail message (which is saved for later retrieval by the {@link #getMessage()} method). * @param retryAfter decimal interval in seconds after which the failed request may be retried. * @param cause the underlying cause of the exception. */
public ServiceUnavailableException(final String message, final Long retryAfter, final Throwable cause) { super(message, Response.status(SERVICE_UNAVAILABLE).header(RETRY_AFTER, retryAfter).build(), cause); }
Construct a new "service unavailable" exception.
Params:
  • response – error response.
  • cause – the underlying cause of the exception.
Throws:
/** * Construct a new "service unavailable" exception. * * @param response error response. * @param cause the underlying cause of the exception. * @throws IllegalArgumentException in case the status code set in the response is not HTTP {@code 503}. */
public ServiceUnavailableException(final Response response, final Throwable cause) { super(validate(response, SERVICE_UNAVAILABLE), cause); }
Construct a new "service unavailable" exception.
Params:
  • message – the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
  • response – error response.
  • cause – the underlying cause of the exception.
Throws:
/** * Construct a new "service unavailable" exception. * * @param message the detail message (which is saved for later retrieval by the {@link #getMessage()} method). * @param response error response. * @param cause the underlying cause of the exception. * @throws IllegalArgumentException in case the status code set in the response is not HTTP {@code 503}. */
public ServiceUnavailableException(final String message, final Response response, final Throwable cause) { super(message, validate(response, SERVICE_UNAVAILABLE), cause); }
Check if the underlying response contains the information on when is it possible to retry the request.
Returns:true in case the retry time is specified in the underlying response, false otherwise.
/** * Check if the underlying response contains the information on when is it possible to {@link HttpHeaders#RETRY_AFTER * retry the request}. * * @return {@code true} in case the retry time is specified in the underlying response, {@code false} otherwise. */
public boolean hasRetryAfter() { return getResponse().getHeaders().containsKey(RETRY_AFTER); }
Get the retry time for the failed request.
Params:
  • requestTime – time of sending the original request that may be used to compute the retry time (in case the retry time information specified as a decimal interval in seconds).
Throws:
Returns:time when the request may be retried or null if there is no retry information available.
/** * Get the retry time for the failed request. * * @param requestTime time of sending the original request that may be used to compute the retry time (in case the retry * time information specified as a decimal interval in seconds). * @return time when the request may be retried or {@code null} if there is no retry information available. * @throws NullPointerException in case the {@code requestTime} parameter is {@code null}. */
public Date getRetryTime(final Date requestTime) { final String value = getResponse().getHeaderString(RETRY_AFTER); if (value == null) { return null; } try { Long interval = Long.parseLong(value); return new Date(requestTime.getTime() + interval * 1000); } catch (NumberFormatException ex) { // not an decimal value; ignoring exception and parsing as date } final RuntimeDelegate.HeaderDelegate<Date> dateDelegate = RuntimeDelegate.getInstance().createHeaderDelegate(Date.class); return dateDelegate.fromString(value); } }