org.starchartlabs.calamari.core.content

Class FileContentLoader

java.lang.Object

org.starchartlabs.calamari.core.content.FileContentLoader

public class FileContentLoader
extends java.lang.Object

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

It is intended for an application to create a single loader instance for a configuration file, and utilize loadContents(InstallationAccessToken, String, String, String) for each individual repository lookup desired

If used by a GitHub App, access to the GitHub APIs used requires "contents:read" or "single file:read" permission(s)

Since:

0.3.0

Constructor Summary

Constructors

Constructor and Description
FileContentLoader(java.lang.String userAgent)
FileContentLoader(java.lang.String userAgent, java.lang.String mediaType)

Method Summary

Modifier and Type	Method and Description
java.util.Optional<java.lang.String>	loadContents(InstallationAccessToken installationToken, java.lang.String repositoryUrl, java.lang.String ref, java.lang.String path) Reads contents of the configuration file specified at construction as per the GitHub file content API specification

Methods inherited from class java.lang.Object

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

Constructor Detail

FileContentLoader

public FileContentLoader(java.lang.String userAgent)

Parameters:

userAgent - The user agent to make web requests as, as required by GitHub

Since:

0.3.0

FileContentLoader

public FileContentLoader(java.lang.String userAgent,
                         java.lang.String mediaType)

Parameters:

userAgent - The user agent to make web requests as, as required by GitHub

mediaType - The media type to request from the server via Accept header

Since:

0.3.0

Method Detail

loadContents

public java.util.Optional<java.lang.String> loadContents(InstallationAccessToken installationToken,
                                                         java.lang.String repositoryUrl,
                                                         java.lang.String ref,
                                                         java.lang.String path)

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

Parameters:

installationToken - Token specific to an application/repository authorizing a GitHub App to take actions on GitHub

repositoryUrl - The URL of the repository to read configuration file contents from

ref - The branch/tag to read contents from

path - The repository-root relative path to the configuration file to read when loading contents

Returns:

Plain-text file contents, if the file existed in the repository on the given branch/tag

Since:

0.3.0