A C E F G H I K L M N O P R T W

A

APP_PREVIEW - Static variable in class org.starchartlabs.calamari.core.MediaTypes

Media type used by GitHub app's during the preview period

ApplicationKey - Class in org.starchartlabs.calamari.core.auth

Represents an authentication key used to validate web requests to GitHub as a GitHub App

ApplicationKey(String, Supplier<String>) - Constructor for class org.starchartlabs.calamari.core.auth.ApplicationKey

ApplicationKey(String, Supplier<String>, int) - Constructor for class org.starchartlabs.calamari.core.auth.ApplicationKey

C

checkRateLimit(Response) - Static method in class org.starchartlabs.calamari.core.ResponseConditions

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

checkRateLimit(T, Function<T, Integer>, BiFunction<T, String, Collection<String>>) - Static method in class org.starchartlabs.calamari.core.ResponseConditions

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

E

equals(Object) - Method in class org.starchartlabs.calamari.core.paging.PagingLinks

estimateSize() - Method in class org.starchartlabs.calamari.core.paging.GitHubPageIterator

F

FileContentException - Exception in org.starchartlabs.calamari.core.exception

Represents an error during the process of reading/deserializing file content stored on GitHub

FileContentException(String) - Constructor for exception org.starchartlabs.calamari.core.exception.FileContentException

FileContentException(String, Throwable) - Constructor for exception org.starchartlabs.calamari.core.exception.FileContentException

FileContentLoader - Class in org.starchartlabs.calamari.core.content

Represents handling for reading the contents of a configuration file from a GitHub repository

FileContentLoader(String) - Constructor for class org.starchartlabs.calamari.core.content.FileContentLoader

FileContentLoader(String, String) - Constructor for class org.starchartlabs.calamari.core.content.FileContentLoader

forRepository(String, ApplicationKey, String) - Static method in class org.starchartlabs.calamari.core.auth.InstallationAccessToken

Creates an installation access token for the installation on a given repository.

forRepository(String, ApplicationKey, String, String) - Static method in class org.starchartlabs.calamari.core.auth.InstallationAccessToken

Creates an installation access token for the installation on a given repository.

G

get() - Method in class org.starchartlabs.calamari.core.auth.ApplicationKey

get() - Method in class org.starchartlabs.calamari.core.auth.InstallationAccessToken

getFirstPageUrl() - Method in class org.starchartlabs.calamari.core.paging.PagingLinks

getInstallationUrl(String, ApplicationKey, String) - Static method in class org.starchartlabs.calamari.core.auth.InstallationAccessToken

Looks up the location of the resource describing the installation for a given repository

getLastPageUrl() - Method in class org.starchartlabs.calamari.core.paging.PagingLinks

getNextPageUrl() - Method in class org.starchartlabs.calamari.core.paging.PagingLinks

getPage(String) - Static method in class org.starchartlabs.calamari.core.paging.PagingLinks

Reads the page index from a link.

getPerPage(String) - Static method in class org.starchartlabs.calamari.core.paging.PagingLinks

Reads the number of elements request per-page from a link

getPreviousPageUrl() - Method in class org.starchartlabs.calamari.core.paging.PagingLinks

GitHubPageIterator<T> - Class in org.starchartlabs.calamari.core.paging

An implementation of PageIterator for traversing paged data read from GitHub APIs

GitHubPageIterator(String, Supplier<String>, String, Function<String, Collection<T>>) - Constructor for class org.starchartlabs.calamari.core.paging.GitHubPageIterator

Creates a new GitHubPageIterator

GitHubPageIterator(String, Supplier<String>, String, Function<String, Collection<T>>, String) - Constructor for class org.starchartlabs.calamari.core.paging.GitHubPageIterator

Creates a new GitHubPageIterator

GitHubResponseException - Exception in org.starchartlabs.calamari.core.exception

Represents an error during the process of communicating with GitHub APIs

GitHubResponseException(String) - Constructor for exception org.starchartlabs.calamari.core.exception.GitHubResponseException

GitHubResponseException(String, Throwable) - Constructor for exception org.starchartlabs.calamari.core.exception.GitHubResponseException

gson(String, Supplier<String>, String) - Static method in class org.starchartlabs.calamari.core.paging.GitHubPageIterator

Creates a new GitHubPageIterator configured to extract paged elements into Gson JsonElement instances

gson(String, Supplier<String>, String, String) - Static method in class org.starchartlabs.calamari.core.paging.GitHubPageIterator

Creates a new GitHubPageIterator configured to extract paged elements into Gson JsonElement instances

H

hashCode() - Method in class org.starchartlabs.calamari.core.paging.PagingLinks

hasNext() - Method in class org.starchartlabs.calamari.core.paging.GitHubPageIterator

I

InstallationAccessToken - Class in org.starchartlabs.calamari.core.auth

Represents an access token used to validate web requests to GitHub as a GitHub App installation

InstallationAccessToken(String, ApplicationKey, String) - Constructor for class org.starchartlabs.calamari.core.auth.InstallationAccessToken

InstallationAccessToken(String, ApplicationKey, String, String) - Constructor for class org.starchartlabs.calamari.core.auth.InstallationAccessToken

InstallationAccessToken(String, ApplicationKey, String, String, int) - Constructor for class org.starchartlabs.calamari.core.auth.InstallationAccessToken

isPayloadLegitimate(String, String) - Method in class org.starchartlabs.calamari.core.webhook.WebhookVerifier

Determines if a payload was sent by GitHub via an agreed-upon token and hashing strategy

K

KeyLoadingException - Exception in org.starchartlabs.calamari.core.exception

Represents an error during the process of generating keys for authentication in GitHub web requests

KeyLoadingException(String) - Constructor for exception org.starchartlabs.calamari.core.exception.KeyLoadingException

KeyLoadingException(String, Throwable) - Constructor for exception org.starchartlabs.calamari.core.exception.KeyLoadingException

L

loadContents(InstallationAccessToken, String, String, String) - Method in class org.starchartlabs.calamari.core.content.FileContentLoader

Reads contents of the configuration file specified at construction as per the GitHub file content API specification

M

map(Function<T, S>) - Method in class org.starchartlabs.calamari.core.paging.GitHubPageIterator

Transforms each element of paged data encountered via the provided function

MediaTypes - Class in org.starchartlabs.calamari.core

Represents various data format identifiers which may be sent or requested to/from GitHub via Accept/Content-Type headers in web requests

N

next() - Method in class org.starchartlabs.calamari.core.paging.GitHubPageIterator

O

org.starchartlabs.calamari.core - package org.starchartlabs.calamari.core

General utilities for interacting with GitHub as a GitHub App

org.starchartlabs.calamari.core.auth - package org.starchartlabs.calamari.core.auth

Utilities for authenticating with GitHub as a GitHub App

org.starchartlabs.calamari.core.content - package org.starchartlabs.calamari.core.content

Utilities for reading and manipulating file content on GitHub as a GitHub App

org.starchartlabs.calamari.core.exception - package org.starchartlabs.calamari.core.exception

Typed exceptions for potential errors when interacting with GitHub

org.starchartlabs.calamari.core.paging - package org.starchartlabs.calamari.core.paging

org.starchartlabs.calamari.core.webhook - package org.starchartlabs.calamari.core.webhook

Utilities for interacting with GitHub webhook events

P

PagingLinks - Class in org.starchartlabs.calamari.core.paging

Handles parsing of GitHub paging headers into distinct links for traversal of paged data

PagingLinks(Collection<String>) - Constructor for class org.starchartlabs.calamari.core.paging.PagingLinks

Parses one or more paging links from GitHub response headers

R

RequestLimitExceededException - Exception in org.starchartlabs.calamari.core.exception

Represents a request to GitHub which failed due to the calling application exceeding allotted its rate limits

RequestLimitExceededException(String, String) - Constructor for exception org.starchartlabs.calamari.core.exception.RequestLimitExceededException

RequestLimitExceededException(String, String, Throwable) - Constructor for exception org.starchartlabs.calamari.core.exception.RequestLimitExceededException

ResponseConditions - Class in org.starchartlabs.calamari.core

Provides streamlined checking for common responses from GitHub

ResponseConditions() - Constructor for class org.starchartlabs.calamari.core.ResponseConditions

T

toString() - Method in class org.starchartlabs.calamari.core.paging.PagingLinks

trySplit() - Method in class org.starchartlabs.calamari.core.paging.GitHubPageIterator

W

WebhookVerifier - Class in org.starchartlabs.calamari.core.webhook

Provides behavior to verify the source of a webhook event payload

WebhookVerifier(Supplier<String>) - Constructor for class org.starchartlabs.calamari.core.webhook.WebhookVerifier

A C E F G H I K L M N O P R T W