Package edu.sustech.search.engine.github.API

Class RestAPI

java.lang.Object

edu.sustech.search.engine.github.API.RestAPI

Direct Known Subclasses:

ContentAPI, FileAPI, GitHubAPI, RateAPI, RepositoryAPI, SearchAPI, UserAPI

public class RestAPI
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final Duration	TIME_OUT_DURATION

Constructor Summary

Constructors

Constructor	Description
RestAPI()
RestAPI(String... OAuthTokens)	Initialize this API with multiple tokens for querying.
RestAPI(List<String> OAuthTokens)	Initialize this API with multiple tokens for querying.

Method Summary

Modifier and Type	Method	Description
void	addToken(String OAuthToken)
static <T> T	convert(String jsonContent, Class<T> clazz)	Convert the object using the internal objectMapper created at instantiation.
HttpResponse<String>	getHttpResponse(URI uri)
HttpResponse<String>	getHttpResponse(URI uri, String acceptSchema)
List<HttpResponse<String>>	getHttpResponseLoopFetching(URI rawUri, int targetPageCount)	Get the response in a loop-fetching style.
List<HttpResponse<String>>	getHttpResponseLoopFetching(URI rawUri, int targetPageCount, long timeIntervalMillis)	Get the response in a loop-fetching style
List<HttpResponse<String>>	getHttpResponseLoopFetching(URI rawUri, String acceptSchema, int targetPageCount)	Get the response in a loop-fetching style.
List<HttpResponse<String>>	getHttpResponseLoopFetching(URI rawUri, String acceptSchema, int targetPageCount, long timeIntervalMillis)	Get the response in a loop-fetching style
String	getHttpResponseRaw(URI uri)
String	getHttpResponseRaw(URI uri, String acceptSchema)
List<String>	getHttpResponseRawLoopFetching(URI rawUri, int targetPageCount)
List<String>	getHttpResponseRawLoopFetching(URI rawUri, int targetPageCount, long timeIntervalMillis)
List<String>	getHttpResponseRawLoopFetching(URI rawUri, String acceptSchema, int targetPageCount)
List<String>	getHttpResponseRawLoopFetching(URI rawUri, String acceptSchema, int targetPageCount, long timeIntervalMillis)
String	getNextToken()
RateLimitResult	getRateLimit()
int	getTokenCursor()
static int	parseEndPageCount(HttpResponse<String> response)	This method parse the end page count from the response header.
void	printRateLimit(HttpResponse<String> response)
void	setSuppressRateError(boolean isErrorSuppressed)	If set to true, error messages for rate limit exceeding in the response will be hidden.
void	setSuppressResponseError(boolean isErrorSuppressed)	If set to true, error messages for tries in the response will be hidden.
void	setTokenCursor(int newPosition)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

TIME_OUT_DURATION

public static final Duration TIME_OUT_DURATION

Constructor Details

RestAPI

public RestAPI(String... OAuthTokens)

Initialize this API with multiple tokens for querying.

Parameters:

OAuthTokens - Array containing OAuthTokens.

RestAPI

public RestAPI(List<String> OAuthTokens)

Initialize this API with multiple tokens for querying.

Parameters:

OAuthTokens - List containing OAuthTokens.

RestAPI

public RestAPI()

Method Details

getHttpResponseRaw

public String getHttpResponseRaw(URI uri)
                          throws IOException,
InterruptedException

Throws:

IOException

InterruptedException

getHttpResponseRaw

public String getHttpResponseRaw(URI uri,
 String acceptSchema)
                          throws IOException,
InterruptedException

Throws:

IOException

InterruptedException

getHttpResponseRawLoopFetching

public List<String> getHttpResponseRawLoopFetching(URI rawUri,
 int targetPageCount)
                                            throws IOException,
InterruptedException

Throws:

IOException

InterruptedException

getHttpResponseRawLoopFetching

public List<String> getHttpResponseRawLoopFetching(URI rawUri,
 String acceptSchema,
 int targetPageCount)
                                            throws IOException,
InterruptedException

Throws:

IOException

InterruptedException

getHttpResponseRawLoopFetching

public List<String> getHttpResponseRawLoopFetching(URI rawUri,
 int targetPageCount,
 long timeIntervalMillis)
                                            throws IOException,
InterruptedException

Throws:

IOException

InterruptedException

getHttpResponseRawLoopFetching

public List<String> getHttpResponseRawLoopFetching(URI rawUri,
 String acceptSchema,
 int targetPageCount,
 long timeIntervalMillis)
                                            throws IOException,
InterruptedException

Throws:

IOException

InterruptedException

getHttpResponseLoopFetching

public List<HttpResponse<String>> getHttpResponseLoopFetching(URI rawUri,
 int targetPageCount)
                                                       throws IOException,
InterruptedException

Get the response in a loop-fetching style. The default time interval between each request will be used.

Parameters:

rawUri - Raw uri without per_page settings and page numbers

targetPageCount - Target page count

Throws:

IOException

InterruptedException

getHttpResponseLoopFetching

public List<HttpResponse<String>> getHttpResponseLoopFetching(URI rawUri,
 String acceptSchema,
 int targetPageCount)
                                                       throws IOException,
InterruptedException

Get the response in a loop-fetching style. The default time interval between each request will be used.

Parameters:

rawUri - Raw uri without per_page settings and page numbers

acceptSchema - Accept schema

targetPageCount - Target page count

Throws:

IOException

InterruptedException

getHttpResponseLoopFetching

public List<HttpResponse<String>> getHttpResponseLoopFetching(URI rawUri,
 int targetPageCount,
 long timeIntervalMillis)
                                                       throws IOException,
InterruptedException

Get the response in a loop-fetching style

Parameters:

rawUri - Raw uri without per_page settings and page numbers

targetPageCount - Target page count

timeIntervalMillis - Time interval between each request made

Throws:

IOException

InterruptedException

getHttpResponseLoopFetching

public List<HttpResponse<String>> getHttpResponseLoopFetching(URI rawUri,
 String acceptSchema,
 int targetPageCount,
 long timeIntervalMillis)
                                                       throws IOException,
InterruptedException

Get the response in a loop-fetching style

Parameters:

rawUri - Raw uri without per_page settings and page numbers

acceptSchema - Accept schema

targetPageCount - Target page count

timeIntervalMillis - Time interval between each request made

Throws:

IOException

InterruptedException

getHttpResponse

public HttpResponse<String> getHttpResponse(URI uri)
                                     throws IOException,
InterruptedException

Throws:

IOException

InterruptedException

getHttpResponse

public HttpResponse<String> getHttpResponse(URI uri,
 String acceptSchema)
                                     throws IOException,
InterruptedException

Throws:

IOException

InterruptedException

setSuppressResponseError

public void setSuppressResponseError(boolean isErrorSuppressed)

If set to true, error messages for tries in the response will be hidden. This is usually used in loop fetching.

Parameters:

isErrorSuppressed -

setSuppressRateError

public void setSuppressRateError(boolean isErrorSuppressed)

If set to true, error messages for rate limit exceeding in the response will be hidden. This is usually used in searchAPI.

Parameters:

isErrorSuppressed -

printRateLimit

public void printRateLimit(HttpResponse<String> response)

getRateLimit

public RateLimitResult getRateLimit()
                             throws IOException,
InterruptedException

Throws:

IOException

InterruptedException

addToken

public void addToken(String OAuthToken)

getNextToken

public String getNextToken()

getTokenCursor

public int getTokenCursor()

setTokenCursor

public void setTokenCursor(int newPosition)

convert

public static <T> T convert(String jsonContent,
 Class<T> clazz)

Convert the object using the internal objectMapper created at instantiation.

Parameters:

jsonContent - JsonContent

clazz - Target class

Returns:

An instance of the target class parsed from the json content provided.

parseEndPageCount

public static int parseEndPageCount(HttpResponse<String> response)

This method parse the end page count from the response header.

Parameters:

response - Response to parse

Returns:

The end page count. Integer.MAX_VALUE will be assigned if not found.