org.kohsuke.github.GHAppInstallation Maven / Gradle / Ivy
package org.kohsuke.github;
import com.fasterxml.jackson.annotation.JsonProperty;
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import org.kohsuke.github.internal.EnumUtils;
import java.io.IOException;
import java.net.URL;
import java.util.Collections;
import java.util.Date;
import java.util.List;
import java.util.Map;
import java.util.stream.Collectors;
// TODO: Auto-generated Javadoc
/**
* A Github App Installation.
*
* @author Paulo Miguel Almeida
* @see GHApp#listInstallations() GHApp#listInstallations()
* @see GHApp#getInstallationById(long) GHApp#getInstallationById(long)
* @see GHApp#getInstallationByOrganization(String) GHApp#getInstallationByOrganization(String)
* @see GHApp#getInstallationByRepository(String, String) GHApp#getInstallationByRepository(String, String)
* @see GHApp#getInstallationByUser(String) GHApp#getInstallationByUser(String)
*/
public class GHAppInstallation extends GHObject {
/**
* Create default GHAppInstallation instance
*/
public GHAppInstallation() {
}
private GHUser account;
@JsonProperty("access_tokens_url")
private String accessTokenUrl;
@JsonProperty("repositories_url")
private String repositoriesUrl;
@JsonProperty("app_id")
private long appId;
@JsonProperty("target_id")
private long targetId;
@JsonProperty("target_type")
private GHTargetType targetType;
private Map permissions;
private List events;
@JsonProperty("single_file_name")
private String singleFileName;
@JsonProperty("repository_selection")
private GHRepositorySelection repositorySelection;
private String htmlUrl;
private String suspendedAt;
private GHUser suspendedBy;
/**
* Gets the html url.
*
* @return the html url
*/
public URL getHtmlUrl() {
return GitHubClient.parseURL(htmlUrl);
}
/**
* Gets account.
*
* @return the account
*/
@SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected behavior")
public GHUser getAccount() {
return account;
}
/**
* Gets access token url.
*
* @return the access token url
*/
public String getAccessTokenUrl() {
return accessTokenUrl;
}
/**
* Gets repositories url.
*
* @return the repositories url
*/
public String getRepositoriesUrl() {
return repositoriesUrl;
}
/**
* List repositories that this app installation can access.
*
* @return the paged iterable
* @deprecated This method cannot work on a {@link GHAppInstallation} retrieved from
* {@link GHApp#listInstallations()} (for example), except when resorting to unsupported hacks involving
* setRoot(GitHub) to switch from an application client to an installation client. This method will be
* removed. You should instead use an installation client (with an installation token, not a JWT),
* retrieve a {@link GHAuthenticatedAppInstallation} from {@link GitHub#getInstallation()}, then call
* {@link GHAuthenticatedAppInstallation#listRepositories()}.
*/
@Deprecated
public PagedSearchIterable listRepositories() {
GitHubRequest request;
request = root().createRequest().withUrlPath("/installation/repositories").build();
return new PagedSearchIterable<>(root(), request, GHAppInstallationRepositoryResult.class);
}
private static class GHAppInstallationRepositoryResult extends SearchResult {
private GHRepository[] repositories;
@Override
GHRepository[] getItems(GitHub root) {
return repositories;
}
}
/**
* Gets app id.
*
* @return the app id
*/
public long getAppId() {
return appId;
}
/**
* Gets target id.
*
* @return the target id
*/
public long getTargetId() {
return targetId;
}
/**
* Gets target type.
*
* @return the target type
*/
public GHTargetType getTargetType() {
return targetType;
}
/**
* Gets permissions.
*
* @return the permissions
*/
public Map getPermissions() {
return Collections.unmodifiableMap(permissions);
}
/**
* Gets events.
*
* @return the events
*/
public List getEvents() {
return events.stream()
.map(e -> EnumUtils.getEnumOrDefault(GHEvent.class, e, GHEvent.UNKNOWN))
.collect(Collectors.toList());
}
/**
* Gets single file name.
*
* @return the single file name
*/
public String getSingleFileName() {
return singleFileName;
}
/**
* Gets repository selection.
*
* @return the repository selection
*/
public GHRepositorySelection getRepositorySelection() {
return repositorySelection;
}
/**
* Gets suspended at.
*
* @return the suspended at
*/
public Date getSuspendedAt() {
return GitHubClient.parseDate(suspendedAt);
}
/**
* Gets suspended by.
*
* @return the suspended by
*/
@SuppressFBWarnings(value = { "EI_EXPOSE_REP" }, justification = "Expected behavior")
public GHUser getSuspendedBy() {
return suspendedBy;
}
/**
* Delete a Github App installation
*
* You must use a JWT to access this endpoint.
*
* @throws IOException
* on error
* @see Delete an installation
*/
public void deleteInstallation() throws IOException {
root().createRequest().method("DELETE").withUrlPath(String.format("/app/installations/%d", getId())).send();
}
/**
* Starts a builder that creates a new App Installation Token.
*
*
* You use the returned builder to set various properties, then call {@link GHAppCreateTokenBuilder#create()} to
* finally create an access token.
*
* @param permissions
* map of permissions for the created token
* @return a GHAppCreateTokenBuilder instance
* @deprecated Use {@link GHAppInstallation#createToken()} instead.
*/
@Deprecated
public GHAppCreateTokenBuilder createToken(Map permissions) {
return createToken().permissions(permissions);
}
/**
* Starts a builder that creates a new App Installation Token.
*
*
* You use the returned builder to set various properties, then call {@link GHAppCreateTokenBuilder#create()} to
* finally create an access token.
*
* @return a GHAppCreateTokenBuilder instance
*/
public GHAppCreateTokenBuilder createToken() {
return new GHAppCreateTokenBuilder(root(), String.format("/app/installations/%d/access_tokens", getId()));
}
/**
* Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub
* App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will
* also see the upcoming pending change.
*
*
* GitHub Apps must use a JWT to access this endpoint.
*
* OAuth Apps must use basic authentication with their client ID and client secret to access this endpoint.
*
* @return a GHMarketplaceAccountPlan instance
* @throws IOException
* it may throw an {@link IOException}
* @see Get
* a subscription plan for an account
*/
public GHMarketplaceAccountPlan getMarketplaceAccount() throws IOException {
return new GHMarketplacePlanForAccountBuilder(root(), account.getId()).createRequest();
}
}