e2f52ff650eb042c57dcd99f1739faee7abdea9e
[facebook-errors] / src / main / java / de / juplo / facebook / errors / GraphApiErrorResponseErrorHandler.java
1 package de.juplo.facebook.errors;
2
3
4 import java.io.ByteArrayInputStream;
5 import java.io.IOException;
6 import java.io.InputStream;
7 import java.nio.charset.Charset;
8 import org.slf4j.Logger;
9 import org.slf4j.LoggerFactory;
10 import org.springframework.http.HttpHeaders;
11 import org.springframework.http.HttpStatus;
12 import org.springframework.http.client.ClientHttpResponse;
13 import org.springframework.util.FileCopyUtils;
14 import org.springframework.web.client.DefaultResponseErrorHandler;
15 import org.springframework.web.client.ResponseErrorHandler;
16
17
18
19 /**
20  * Error-Handler for error-messages from the Facebook Graph-API.
21  * <p>
22  * This error-handler handels responses withe the HTTP-status code
23  * {@code 400 BAD REQUEST}. It tries to extract and parse the error-message
24  * from the HTTP-body. Successfully extracted and parsed messages are mapped
25  * to a hierarchy of exceptions, that reflects the hierarchy of the error-
26  * codes and -types.
27  * <p>
28  * If the HTTP-status-code of the response is not {@code 400 BAD REQUEST} or
29  * the HTTP-body could not be extracted or parsed, this error-handler
30  * delegates the handling to its parent.
31  *
32  * @see <a href="https://developers.facebook.com/docs/graph-api/using-graph-api/v2.5#errors">Graph-API Documentation</a>
33  * @see <a href="http://fbdevwiki.com/wiki/Error_codes">Inofficial Wiki For Facebook-Developers</a>
34  * @author Kai Moritz
35  */
36 public class GraphApiErrorResponseErrorHandler implements ResponseErrorHandler
37 {
38   private final static Logger LOG =
39       LoggerFactory.getLogger(GraphApiErrorResponseErrorHandler.class);
40
41   private final ResponseErrorHandler parent;
42
43
44   public GraphApiErrorResponseErrorHandler()
45   {
46     this(null);
47   }
48
49   public GraphApiErrorResponseErrorHandler(ResponseErrorHandler errorHandler)
50   {
51     this.parent =
52         errorHandler == null
53             ? new DefaultResponseErrorHandler()
54             : errorHandler;
55   }
56
57
58   @Override
59   public boolean hasError(ClientHttpResponse response) throws IOException
60   {
61     return HttpStatus.Series.CLIENT_ERROR.equals(response.getStatusCode().series());
62   }
63
64   @Override
65   public void handleError(final ClientHttpResponse response) throws IOException
66   {
67     GraphApiErrorResponseErrorHandler.handleError(parent, response);
68   }
69
70   public static void handleError(
71       final ResponseErrorHandler parent,
72       final ClientHttpResponse response
73       )
74       throws
75         IOException
76   {
77     if (response.getBody() == null)
78     {
79       // There is no body to interpret in the HTTP-message
80       LOG.warn("Could not convert the response into an exception, because there is no message-body.");
81       parent.handleError(response);
82       return;
83     }
84
85     final byte[] body = FileCopyUtils.copyToByteArray(response.getBody());
86     GraphApiException error;
87
88     error = GraphApiException.create(response.getStatusCode(), response.getHeaders(), body);
89     if (LOG.isInfoEnabled())
90       LOG.info("error-response: {}", new String(body, Charset.forName("UTF-8")));
91     if (!error.getClass().equals(ErrorResponseParsingErrorException.class))
92     {
93       throw error;
94     }
95     else
96     {
97       // The body of the HTTP-message could not be parsed.
98       // Let the parent error-handler try to handle the response.
99       // To do so, we have to wrap the original response to fill in
100       // the buffered body, if needed
101       ClientHttpResponse buffered = new ClientHttpResponse()
102       {
103         @Override
104         public HttpStatus getStatusCode() throws IOException
105         {
106           return response.getStatusCode();
107         }
108
109         @Override
110         public synchronized InputStream getBody() throws IOException
111         {
112           return new ByteArrayInputStream(body);
113         }
114
115         @Override
116         public HttpHeaders getHeaders()
117         {
118           return response.getHeaders();
119         }
120
121         @Override
122         public String getStatusText() throws IOException
123         {
124           return response.getStatusText();
125         }
126
127         @Override
128         public void close()
129         {
130           response.close();
131         }
132
133         @Override
134         public int getRawStatusCode() throws IOException
135         {
136           return response.getRawStatusCode();
137         }
138       };
139
140       parent.handleError(buffered);
141       return;
142     }
143   }
144 }