Skip to main content
aboutsummaryrefslogtreecommitdiffstats
blob: 563b3340eb1f3c01d37cdbf91df24205e4253725 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
/*******************************************************************************
 *  Copyright (c) 2011 GitHub Inc.
 *  All rights reserved. This program and the accompanying materials
 *  are made available under the terms of the Eclipse Public License 2.0
 *  which accompanies this distribution, and is available at
 *  https://www.eclipse.org/legal/epl-2.0/
 *
 *  SPDX-License-Identifier: EPL-2.0
 *
 *  Contributors:
 *    Kevin Sawicki (GitHub Inc.) - initial API and implementation
 *******************************************************************************/
package org.eclipse.egit.github.core.client;

import java.net.HttpURLConnection;

/**
 * GitHub API response class that provides the parsed response body as well as
 * any links to the first, previous, next, and last responses.
 */
public class GitHubResponse {

	/**
	 * HTTP response
	 */
	protected final HttpURLConnection response;

	/**
	 * Response body
	 */
	protected final Object body;

	/**
	 * Links to other pages
	 */
	protected PageLinks links;

	/**
	 * Create response
	 *
	 * @param response
	 * @param body
	 */
	public GitHubResponse(HttpURLConnection response, Object body) {
		this.response = response;
		this.body = body;
	}

	/**
	 * Get header value
	 *
	 * @param name
	 * @return value
	 */
	public String getHeader(String name) {
		return response.getHeaderField(name);
	}

	/**
	 * Get page links
	 *
	 * @return links
	 */
	protected PageLinks getLinks() {
		if (links == null)
			links = new PageLinks(this);
		return links;
	}

	/**
	 * Get link uri to first page
	 *
	 * @return possibly null uri
	 */
	public String getFirst() {
		return getLinks().getFirst();
	}

	/**
	 * Get link uri to previous page
	 *
	 * @return possibly null uri
	 */
	public String getPrevious() {
		return getLinks().getPrev();
	}

	/**
	 * Get link uri to next page
	 *
	 * @return possibly null uri
	 */
	public String getNext() {
		return getLinks().getNext();
	}

	/**
	 * Get link uri to last page
	 *
	 * @return possibly null uri
	 */
	public String getLast() {
		return getLinks().getLast();
	}

	/**
	 * Parsed response body
	 *
	 * @return body
	 */
	public Object getBody() {
		return body;
	}
}

Back to the top