1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
3 <head><meta http-equiv="content-type" content="text/html; charset=UTF-8" />
4 <title>GraphApiErrorHandler xref</title>
5 <link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
8 <div id="overview"><a href="../../../../../apidocs/de/juplo/facebook/client/GraphApiErrorHandler.html">View Javadoc</a></div><pre>
9 <a class="jxr_linenumber" name="L1" href="#L1">1</a> <strong class="jxr_keyword">package</strong> de.juplo.facebook.client;
10 <a class="jxr_linenumber" name="L2" href="#L2">2</a>
11 <a class="jxr_linenumber" name="L3" href="#L3">3</a> <strong class="jxr_keyword">import</strong> de.juplo.facebook.exceptions.GraphApiException;
12 <a class="jxr_linenumber" name="L4" href="#L4">4</a> <strong class="jxr_keyword">import</strong> java.io.ByteArrayInputStream;
13 <a class="jxr_linenumber" name="L5" href="#L5">5</a> <strong class="jxr_keyword">import</strong> java.io.IOException;
14 <a class="jxr_linenumber" name="L6" href="#L6">6</a> <strong class="jxr_keyword">import</strong> java.io.InputStream;
15 <a class="jxr_linenumber" name="L7" href="#L7">7</a> <strong class="jxr_keyword">import</strong> java.nio.charset.Charset;
16 <a class="jxr_linenumber" name="L8" href="#L8">8</a> <strong class="jxr_keyword">import</strong> org.slf4j.Logger;
17 <a class="jxr_linenumber" name="L9" href="#L9">9</a> <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory;
18 <a class="jxr_linenumber" name="L10" href="#L10">10</a> <strong class="jxr_keyword">import</strong> org.springframework.http.HttpHeaders;
19 <a class="jxr_linenumber" name="L11" href="#L11">11</a> <strong class="jxr_keyword">import</strong> org.springframework.http.HttpStatus;
20 <a class="jxr_linenumber" name="L12" href="#L12">12</a> <strong class="jxr_keyword">import</strong> org.springframework.http.client.ClientHttpResponse;
21 <a class="jxr_linenumber" name="L13" href="#L13">13</a> <strong class="jxr_keyword">import</strong> org.springframework.util.FileCopyUtils;
22 <a class="jxr_linenumber" name="L14" href="#L14">14</a> <strong class="jxr_keyword">import</strong> org.springframework.web.client.ResponseErrorHandler;
23 <a class="jxr_linenumber" name="L15" href="#L15">15</a>
24 <a class="jxr_linenumber" name="L16" href="#L16">16</a>
25 <a class="jxr_linenumber" name="L17" href="#L17">17</a>
26 <a class="jxr_linenumber" name="L18" href="#L18">18</a> <em class="jxr_javadoccomment">/**</em>
27 <a class="jxr_linenumber" name="L19" href="#L19">19</a> <em class="jxr_javadoccomment"> * Error-Handler for error-messages from the Facebook Graph-API.</em>
28 <a class="jxr_linenumber" name="L20" href="#L20">20</a> <em class="jxr_javadoccomment"> * <p></em>
29 <a class="jxr_linenumber" name="L21" href="#L21">21</a> <em class="jxr_javadoccomment"> * This error-handler handels responses withe the HTTP-status code</em>
30 <a class="jxr_linenumber" name="L22" href="#L22">22</a> <em class="jxr_javadoccomment"> * {@code 400 BAD REQUEST}. It tries to extract and parse the error-message</em>
31 <a class="jxr_linenumber" name="L23" href="#L23">23</a> <em class="jxr_javadoccomment"> * from the HTTP-body. Successfully extracted and parsed messages are mapped</em>
32 <a class="jxr_linenumber" name="L24" href="#L24">24</a> <em class="jxr_javadoccomment"> * to a hierarchy of exceptions, that reflects the hierarchy of the error-</em>
33 <a class="jxr_linenumber" name="L25" href="#L25">25</a> <em class="jxr_javadoccomment"> * codes and -types.</em>
34 <a class="jxr_linenumber" name="L26" href="#L26">26</a> <em class="jxr_javadoccomment"> * <p></em>
35 <a class="jxr_linenumber" name="L27" href="#L27">27</a> <em class="jxr_javadoccomment"> * If the HTTP-status-code of the response is not {@code 400 BAD REQUEST} or</em>
36 <a class="jxr_linenumber" name="L28" href="#L28">28</a> <em class="jxr_javadoccomment"> * the HTTP-body could not be extracted or parsed, this error-handler</em>
37 <a class="jxr_linenumber" name="L29" href="#L29">29</a> <em class="jxr_javadoccomment"> * delegates the handling to its parent.</em>
38 <a class="jxr_linenumber" name="L30" href="#L30">30</a> <em class="jxr_javadoccomment"> *</em>
39 <a class="jxr_linenumber" name="L31" href="#L31">31</a> <em class="jxr_javadoccomment"> * @see <a href="https://developers.facebook.com/docs/graph-api/using-graph-api/v2.5#errors">Graph-API Documentation</a></em>
40 <a class="jxr_linenumber" name="L32" href="#L32">32</a> <em class="jxr_javadoccomment"> * @see <a href="<a href="http://fbdevwiki.com/wiki/Error_codes" target="alexandria_uri">http://fbdevwiki.com/wiki/Error_codes</a>">Inofficial Wiki For Facebook-Developers</a></em>
41 <a class="jxr_linenumber" name="L33" href="#L33">33</a> <em class="jxr_javadoccomment"> * @author Kai Moritz</em>
42 <a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment"> */</em>
43 <a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../de/juplo/facebook/client/GraphApiErrorHandler.html">GraphApiErrorHandler</a> <strong class="jxr_keyword">implements</strong> ResponseErrorHandler
44 <a class="jxr_linenumber" name="L36" href="#L36">36</a> {
45 <a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">static</strong> Logger LOG =
46 <a class="jxr_linenumber" name="L38" href="#L38">38</a> LoggerFactory.getLogger(GraphApiErrorHandler.<strong class="jxr_keyword">class</strong>);
47 <a class="jxr_linenumber" name="L39" href="#L39">39</a>
48 <a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> ResponseErrorHandler parent;
49 <a class="jxr_linenumber" name="L41" href="#L41">41</a>
50 <a class="jxr_linenumber" name="L42" href="#L42">42</a>
51 <a class="jxr_linenumber" name="L43" href="#L43">43</a> <strong class="jxr_keyword">public</strong> <a href="../../../../de/juplo/facebook/client/GraphApiErrorHandler.html">GraphApiErrorHandler</a>(ResponseErrorHandler errorHandler)
52 <a class="jxr_linenumber" name="L44" href="#L44">44</a> {
53 <a class="jxr_linenumber" name="L45" href="#L45">45</a> <strong class="jxr_keyword">this</strong>.parent = errorHandler;
54 <a class="jxr_linenumber" name="L46" href="#L46">46</a> }
55 <a class="jxr_linenumber" name="L47" href="#L47">47</a>
56 <a class="jxr_linenumber" name="L48" href="#L48">48</a>
57 <a class="jxr_linenumber" name="L49" href="#L49">49</a> @Override
58 <a class="jxr_linenumber" name="L50" href="#L50">50</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> hasError(ClientHttpResponse response) <strong class="jxr_keyword">throws</strong> IOException
59 <a class="jxr_linenumber" name="L51" href="#L51">51</a> {
60 <a class="jxr_linenumber" name="L52" href="#L52">52</a> <strong class="jxr_keyword">return</strong>
61 <a class="jxr_linenumber" name="L53" href="#L53">53</a> HttpStatus.Series.CLIENT_ERROR.equals(response.getStatusCode().series())
62 <a class="jxr_linenumber" name="L54" href="#L54">54</a> || <strong class="jxr_keyword">this</strong>.parent.hasError(response);
63 <a class="jxr_linenumber" name="L55" href="#L55">55</a> }
64 <a class="jxr_linenumber" name="L56" href="#L56">56</a>
65 <a class="jxr_linenumber" name="L57" href="#L57">57</a> @Override
66 <a class="jxr_linenumber" name="L58" href="#L58">58</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> handleError(<strong class="jxr_keyword">final</strong> ClientHttpResponse response) <strong class="jxr_keyword">throws</strong> IOException
67 <a class="jxr_linenumber" name="L59" href="#L59">59</a> {
68 <a class="jxr_linenumber" name="L60" href="#L60">60</a> <strong class="jxr_keyword">if</strong> (!HttpStatus.BAD_REQUEST.equals(response.getStatusCode()))
69 <a class="jxr_linenumber" name="L61" href="#L61">61</a> {
70 <a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_comment">// We will only handle 400 BAD REQUEST</em>
71 <a class="jxr_linenumber" name="L63" href="#L63">63</a> LOG.debug(<span class="jxr_string">"ignoring response with status-code {}."</span>, response.getStatusCode());
72 <a class="jxr_linenumber" name="L64" href="#L64">64</a> parent.handleError(response);
73 <a class="jxr_linenumber" name="L65" href="#L65">65</a> <strong class="jxr_keyword">return</strong>;
74 <a class="jxr_linenumber" name="L66" href="#L66">66</a> }
75 <a class="jxr_linenumber" name="L67" href="#L67">67</a>
76 <a class="jxr_linenumber" name="L68" href="#L68">68</a>
77 <a class="jxr_linenumber" name="L69" href="#L69">69</a> <strong class="jxr_keyword">if</strong> (response.getBody() == <strong class="jxr_keyword">null</strong>)
78 <a class="jxr_linenumber" name="L70" href="#L70">70</a> {
79 <a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_comment">// There is no body to interpret in the HTTP-message</em>
80 <a class="jxr_linenumber" name="L72" href="#L72">72</a> LOG.warn(<span class="jxr_string">"Could not convert the response into an exception, because there is no message-body."</span>);
81 <a class="jxr_linenumber" name="L73" href="#L73">73</a> parent.handleError(response);
82 <a class="jxr_linenumber" name="L74" href="#L74">74</a> <strong class="jxr_keyword">return</strong>;
83 <a class="jxr_linenumber" name="L75" href="#L75">75</a> }
84 <a class="jxr_linenumber" name="L76" href="#L76">76</a>
85 <a class="jxr_linenumber" name="L77" href="#L77">77</a> <strong class="jxr_keyword">final</strong> byte[] body = FileCopyUtils.copyToByteArray(response.getBody());
86 <a class="jxr_linenumber" name="L78" href="#L78">78</a> <a href="../../../../de/juplo/facebook/exceptions/GraphApiException.html">GraphApiException</a> error;
87 <a class="jxr_linenumber" name="L79" href="#L79">79</a>
88 <a class="jxr_linenumber" name="L80" href="#L80">80</a> <strong class="jxr_keyword">try</strong>
89 <a class="jxr_linenumber" name="L81" href="#L81">81</a> {
90 <a class="jxr_linenumber" name="L82" href="#L82">82</a> error = GraphApiException.create(body);
91 <a class="jxr_linenumber" name="L83" href="#L83">83</a> <strong class="jxr_keyword">if</strong> (LOG.isInfoEnabled())
92 <a class="jxr_linenumber" name="L84" href="#L84">84</a> LOG.info(<span class="jxr_string">"error-response: {}"</span>, <strong class="jxr_keyword">new</strong> String(body, Charset.forName(<span class="jxr_string">"UTF-8"</span>)));
93 <a class="jxr_linenumber" name="L85" href="#L85">85</a> }
94 <a class="jxr_linenumber" name="L86" href="#L86">86</a> <strong class="jxr_keyword">catch</strong> (Exception e)
95 <a class="jxr_linenumber" name="L87" href="#L87">87</a> {
96 <a class="jxr_linenumber" name="L88" href="#L88">88</a> <em class="jxr_comment">// The body of the HTTP-message could not be parsed.</em>
97 <a class="jxr_linenumber" name="L89" href="#L89">89</a> <em class="jxr_comment">// Let the parent error-handler try to handle the response.</em>
98 <a class="jxr_linenumber" name="L90" href="#L90">90</a>
99 <a class="jxr_linenumber" name="L91" href="#L91">91</a> LOG.warn(<span class="jxr_string">"Could not convert the response into an exception, because the body is unparsable: {}"</span>, body);
100 <a class="jxr_linenumber" name="L92" href="#L92">92</a>
101 <a class="jxr_linenumber" name="L93" href="#L93">93</a> <em class="jxr_comment">// To do so, we have to wrap the original response to fill in</em>
102 <a class="jxr_linenumber" name="L94" href="#L94">94</a> <em class="jxr_comment">// the buffered body, if needed</em>
103 <a class="jxr_linenumber" name="L95" href="#L95">95</a> ClientHttpResponse buffered = <strong class="jxr_keyword">new</strong> ClientHttpResponse()
104 <a class="jxr_linenumber" name="L96" href="#L96">96</a> {
105 <a class="jxr_linenumber" name="L97" href="#L97">97</a> @Override
106 <a class="jxr_linenumber" name="L98" href="#L98">98</a> <strong class="jxr_keyword">public</strong> HttpStatus getStatusCode() <strong class="jxr_keyword">throws</strong> IOException
107 <a class="jxr_linenumber" name="L99" href="#L99">99</a> {
108 <a class="jxr_linenumber" name="L100" href="#L100">100</a> <strong class="jxr_keyword">return</strong> response.getStatusCode();
109 <a class="jxr_linenumber" name="L101" href="#L101">101</a> }
110 <a class="jxr_linenumber" name="L102" href="#L102">102</a>
111 <a class="jxr_linenumber" name="L103" href="#L103">103</a> @Override
112 <a class="jxr_linenumber" name="L104" href="#L104">104</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">synchronized</strong> InputStream getBody() <strong class="jxr_keyword">throws</strong> IOException
113 <a class="jxr_linenumber" name="L105" href="#L105">105</a> {
114 <a class="jxr_linenumber" name="L106" href="#L106">106</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> ByteArrayInputStream(body);
115 <a class="jxr_linenumber" name="L107" href="#L107">107</a> }
116 <a class="jxr_linenumber" name="L108" href="#L108">108</a>
117 <a class="jxr_linenumber" name="L109" href="#L109">109</a> @Override
118 <a class="jxr_linenumber" name="L110" href="#L110">110</a> <strong class="jxr_keyword">public</strong> HttpHeaders getHeaders()
119 <a class="jxr_linenumber" name="L111" href="#L111">111</a> {
120 <a class="jxr_linenumber" name="L112" href="#L112">112</a> <strong class="jxr_keyword">return</strong> response.getHeaders();
121 <a class="jxr_linenumber" name="L113" href="#L113">113</a> }
122 <a class="jxr_linenumber" name="L114" href="#L114">114</a>
123 <a class="jxr_linenumber" name="L115" href="#L115">115</a> @Override
124 <a class="jxr_linenumber" name="L116" href="#L116">116</a> <strong class="jxr_keyword">public</strong> String getStatusText() <strong class="jxr_keyword">throws</strong> IOException
125 <a class="jxr_linenumber" name="L117" href="#L117">117</a> {
126 <a class="jxr_linenumber" name="L118" href="#L118">118</a> <strong class="jxr_keyword">return</strong> response.getStatusText();
127 <a class="jxr_linenumber" name="L119" href="#L119">119</a> }
128 <a class="jxr_linenumber" name="L120" href="#L120">120</a>
129 <a class="jxr_linenumber" name="L121" href="#L121">121</a> @Override
130 <a class="jxr_linenumber" name="L122" href="#L122">122</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> close()
131 <a class="jxr_linenumber" name="L123" href="#L123">123</a> {
132 <a class="jxr_linenumber" name="L124" href="#L124">124</a> response.close();
133 <a class="jxr_linenumber" name="L125" href="#L125">125</a> }
134 <a class="jxr_linenumber" name="L126" href="#L126">126</a>
135 <a class="jxr_linenumber" name="L127" href="#L127">127</a> @Override
136 <a class="jxr_linenumber" name="L128" href="#L128">128</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> getRawStatusCode() <strong class="jxr_keyword">throws</strong> IOException
137 <a class="jxr_linenumber" name="L129" href="#L129">129</a> {
138 <a class="jxr_linenumber" name="L130" href="#L130">130</a> <strong class="jxr_keyword">return</strong> response.getRawStatusCode();
139 <a class="jxr_linenumber" name="L131" href="#L131">131</a> }
140 <a class="jxr_linenumber" name="L132" href="#L132">132</a> };
141 <a class="jxr_linenumber" name="L133" href="#L133">133</a>
142 <a class="jxr_linenumber" name="L134" href="#L134">134</a> parent.handleError(buffered);
143 <a class="jxr_linenumber" name="L135" href="#L135">135</a> <strong class="jxr_keyword">return</strong>;
144 <a class="jxr_linenumber" name="L136" href="#L136">136</a> }
145 <a class="jxr_linenumber" name="L137" href="#L137">137</a>
146 <a class="jxr_linenumber" name="L138" href="#L138">138</a> <strong class="jxr_keyword">throw</strong> error;
147 <a class="jxr_linenumber" name="L139" href="#L139">139</a> }
148 <a class="jxr_linenumber" name="L140" href="#L140">140</a> }
151 <div id="footer">Copyright © 2015. All rights reserved.</div>