jakarta.ws.rs.ServiceUnavailableException Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of jaxrs-ri Show documentation
A bundle project producing JAX-RS RI bundles. The primary artifact is an "all-in-one" OSGi-fied JAX-RS RI bundle (jaxrs-ri.jar). Attached to that are two compressed JAX-RS RI archives. The first archive (jaxrs-ri.zip) consists of binary RI bits and contains the API jar (under "api" directory), RI libraries (under "lib" directory) as well as all external RI dependencies (under "ext" directory). The secondary archive (jaxrs-ri-src.zip) contains buildable JAX-RS RI source bundle and contains the API jar (under "api" directory), RI sources (under "src" directory) as well as all external RI dependencies (under "ext" directory). The second archive also contains "build.xml" ANT script that builds the RI sources. To build the JAX-RS RI simply unzip the archive, cd to the created jaxrs-ri directory and invoke "ant" from the command line.
There is a newer version: 3.1.6
Show newest version
/*
 * 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
 * {@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.
     */
    public ServiceUnavailableException() {
        super(Response.status(SERVICE_UNAVAILABLE).build());
    }

    /**
     * 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.
     *
     * @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.
     *
     * @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.
     *
     * @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.
     *
     * @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.
     *
     * @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.
     *
     * @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.
     *
     * @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.
     *
     * @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.
     *
     * @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.
     *
     * @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.
     *
     * @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.
     *
     * @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 {@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.
     *
     * @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 dateDelegate = RuntimeDelegate.getInstance().createHeaderDelegate(Date.class);
        return dateDelegate.fromString(value);
    }
}