Skip navigation links
A C F G I K M O R 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
 

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

F

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.

G

get() - Method in class org.starchartlabs.calamari.core.auth.ApplicationKey
 
get() - Method in class org.starchartlabs.calamari.core.auth.InstallationAccessToken
 
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

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
 
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
 

M

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

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.exception - package org.starchartlabs.calamari.core.exception
Typed exceptions for potential errors when interacting with GitHub
org.starchartlabs.calamari.core.webhook - package org.starchartlabs.calamari.core.webhook
Utilities for interacting with GitHub webhook events

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
 

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 F G I K M O R W 
Skip navigation links