org.starchartlabs.calamari.core

Class ResponseConditions

java.lang.Object

org.starchartlabs.calamari.core.ResponseConditions

public class ResponseConditions
extends java.lang.Object

Provides streamlined checking for common responses from GitHub

Since:

0.1.0

Constructor Summary

Constructors

Constructor and Description
ResponseConditions()

Method Summary

Modifier and Type	Method and Description
static void	checkRateLimit(okhttp3.Response response) Analyzes a web response to determine if it represents exceeding GitHub's rate limits
static <T> void	checkRateLimit(T response, java.util.function.Function<T,java.lang.Integer> codeLookup, java.util.function.BiFunction<T,java.lang.String,java.util.Collection<java.lang.String>> headerLookup) Analyzes a web response to determine if it represents exceeding GitHub's rate limits

Methods inherited from class java.lang.Object

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

Constructor Detail

ResponseConditions

public ResponseConditions()

Method Detail

checkRateLimit

public static void checkRateLimit(okhttp3.Response response)
                           throws RequestLimitExceededException

Analyzes a web response to determine if it represents exceeding GitHub's rate limits

If the response does represent exceeded rate limiting, throws a RequestLimitExceededException

To use this check with other web libraries, see checkRateLimit(Object, Function, BiFunction)

Parameters:

response - OkHttp3 representation of a web response

Throws:

RequestLimitExceededException

Since:

0.1.0

checkRateLimit

public static <T> void checkRateLimit(T response,
                                      java.util.function.Function<T,java.lang.Integer> codeLookup,
                                      java.util.function.BiFunction<T,java.lang.String,java.util.Collection<java.lang.String>> headerLookup)
                               throws RequestLimitExceededException

Analyzes a web response to determine if it represents exceeding GitHub's rate limits

If the response does represent exceeded rate limiting, throws a RequestLimitExceededException

Type Parameters:

T - Java type representing a web response

Parameters:

response - Representation of a web response

codeLookup - Function which reads the HTTP status code from the provided response

headerLookup - Function which takes a response and header value as input, and produces all instances of that header from the response

Throws:

RequestLimitExceededException - If the provided response represents exceeding GitHub's rate limiting

Since:

0.1.0