Skip to content
GitLab
Switch branch/tag
Find file BlameHistoryPermalink
GitLabApiException.java 8.79 KiB
Open in Web IDE
1 
package org.gitlab4j.api;
2
3 
import java.util.ArrayList;
4 
import java.util.HashMap;
5 
import java.util.Iterator;
6 
import java.util.List;
7 
import java.util.Map;
8 
import java.util.Map.Entry;
9
10 
import javax.ws.rs.core.MediaType;
11 
import javax.ws.rs.core.Response;
12 
import javax.ws.rs.core.Response.StatusType;
13 
import javax.ws.rs.core.MultivaluedMap;
14
15 
import java.util.Objects;
16 
import org.gitlab4j.api.utils.JacksonJson;
17
18 
import com.fasterxml.jackson.databind.JsonNode;
19
20 
/**
21 
 * This is the exception that will be thrown if any exception occurs while communicating
22 
 * with a GitLab API endpoint.
23 
 */
24 
public class GitLabApiException extends Exception {
25
26 
    private static final long serialVersionUID = 1L;
27 
    private StatusType statusInfo;
28 
    private int httpStatus;
29 
    private String message;
30 
    private Map<String, List<String>> validationErrors;
31 
    private MultivaluedMap<String, String> headers;
32
33 
    /**
34 
     * Create a GitLabApiException instance with the specified message.
35 
     *
36 
     * @param message the message for the exception
37 
     */
38 
    public GitLabApiException(String message) {
39 
        super(message);
40 
        this.message = message;
41 
    }
42
43 
    /**
44 
     * Create a GitLabApiException instance with the specified message and HTTP status code.
45 
     *
46 
     * @param message the message for the exception
47 
     * @param httpStatus the HTTP status code for the exception
48 
     */
49 
    public GitLabApiException(String message, int httpStatus) {
50 
        super(message);
51 
        this.message = message;
52 
        this.httpStatus = httpStatus;
53 
    }
54
55 
    /**
56 
     * Create a GitLabApiException instance based on the ClientResponse.
57 
     *
58 
     * @param response the JAX-RS response that caused the exception
59 
     */
60 
    public GitLabApiException(Response response) {
61
62 
        super();
63 
        statusInfo = response.getStatusInfo();
64 
        httpStatus = response.getStatus();
65 
        headers = response.getStringHeaders();
66
67 
        if (response.hasEntity()) {
68
69 
            try {
70
7172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140
String message = response.readEntity(String.class); this.message = message; // Determine what is in the content of the response and process it accordingly MediaType mediaType = response.getMediaType(); if (mediaType != null && "json".equals(mediaType.getSubtype())) { JsonNode json = JacksonJson.toJsonNode(message); // First see if it is a "message", if so it is either a simple message, // or a Map<String, List<String>> of validation errors JsonNode jsonMessage = json.get("message"); if (jsonMessage != null) { // If the node is an object, then it is validation errors if (jsonMessage.isObject()) { StringBuilder buf = new StringBuilder(); validationErrors = new HashMap<>(); Iterator<Entry<String, JsonNode>> fields = jsonMessage.fields(); while(fields.hasNext()) { Entry<String, JsonNode> field = fields.next(); String fieldName = field.getKey(); List<String> values = new ArrayList<>(); validationErrors.put(fieldName, values); for (JsonNode value : field.getValue()) { values.add(value.asText()); } if (values.size() > 0) { buf.append((buf.length() > 0 ? ", " : "")).append(fieldName); } } if (buf.length() > 0) { this.message = "The following fields have validation errors: " + buf.toString(); } } else if (jsonMessage.isArray()) { List<String> values = new ArrayList<>(); for (JsonNode value : jsonMessage) { values.add(value.asText()); } if (values.size() > 0) { this.message = String.join("\n", values); } } else if (jsonMessage.isTextual()) { this.message = jsonMessage.asText(); } else { this.message = jsonMessage.toString(); } } else { JsonNode jsonError = json.get("error"); if (jsonError != null) { this.message = jsonError.asText(); } } } } catch (Exception ignore) { } } }
141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210
/** * Create a GitLabApiException instance based on the exception. * * @param e the Exception to wrap */ public GitLabApiException(Exception e) { super(e); message = e.getMessage(); } /** * Get the message associated with the exception. * * @return the message associated with the exception */ @Override public final String getMessage() { return (message != null ? message : getReason()); } /** * Returns the HTTP status reason message, returns null if the * causing error was not an HTTP related exception. * * @return the HTTP status reason message */ public final String getReason() { return (statusInfo != null ? statusInfo.getReasonPhrase() : null); } /** * Returns the HTTP status code that was the cause of the exception. returns 0 if the * causing error was not an HTTP related exception * * @return the HTTP status code, returns 0 if the causing error was not an HTTP related exception */ public final int getHttpStatus() { return (httpStatus); } /** * Returns true if this GitLabApiException was caused by validation errors on the GitLab server, * otherwise returns false. * * @return true if this GitLabApiException was caused by validation errors on the GitLab server, * otherwise returns false */ public boolean hasValidationErrors() { return (validationErrors != null); } /** * Returns a Map&lt;String, List&lt;String&gt;&gt; instance containing validation errors if this GitLabApiException * was caused by validation errors on the GitLab server, otherwise returns null. * * @return a Map&lt;String, List&lt;String&gt;&gt; instance containing validation errors if this GitLabApiException * was caused by validation errors on the GitLab server, otherwise returns null */ public Map<String, List<String>> getValidationErrors() { return (validationErrors); } /** * Returns the response headers. Returns null if the causing error was not a response related exception. * * @return the response headers or null. */ public final MultivaluedMap<String, String> getHeaders() { return (headers); }