org.eurekaclinical.common.comm.clients.ClientException Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of eurekaclinical-common Show documentation

A library of classes shared across the Eureka! Clinical platform.

There is a newer version: 5.1-Alpha-1

Show newest version

/*
 * #%L
 * Eureka Common
 * %%
 * Copyright (C) 2012 - 2013 Emory University
 * %%
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */
package org.eurekaclinical.common.comm.clients;

import com.sun.jersey.api.client.ClientResponse;

/**
 * Thrown by a REST client when the response of a REST call signifies an error
 * condition.
 *
 * @author hrathod
 */
public final class ClientException extends Exception {

    private static final long serialVersionUID = 1L;

    private final ClientResponse.Status responseStatus;

    /**
     * Creates the exception using the provided response status and message.
     *
     * @param responseStatus the
     * com.sun.jersey.api.client.ClientResponse.Status. Cannot be
     * null.
     * @param message the exception's message.
     */
    public ClientException(ClientResponse.Status responseStatus,
            String message) {
        super(message);
        this.responseStatus = responseStatus;
    }

    /**
     * Returns the response status of the REST call that this exception
     * concerns.
     *
     * @return the com.sun.jersey.api.client.ClientResponse.Status.
     * Guaranteed not null.
     */
    public ClientResponse.Status getResponseStatus() {
        return responseStatus;
    }
}