org.kohsuke.github.GHOrganization Maven / Gradle / Ivy
package org.kohsuke.github;
import java.io.IOException;
import java.net.URL;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.TreeMap;
import static org.kohsuke.github.internal.Previews.INERTIA;
// TODO: Auto-generated Javadoc
/**
* The type GHOrganization.
*
* @author Kohsuke Kawaguchi
*/
public class GHOrganization extends GHPerson {
private boolean has_organization_projects;
/**
* Creates a new repository.
*
* @param name
* the name
* @param description
* the description
* @param homepage
* the homepage
* @param team
* the team
* @param isPublic
* the is public
* @return Newly created repository.
* @throws IOException
* the io exception
* @deprecated Use {@link #createRepository(String)} that uses a builder pattern to let you control every aspect.
*/
@Deprecated
public GHRepository createRepository(String name,
String description,
String homepage,
String team,
boolean isPublic) throws IOException {
GHTeam t = getTeams().get(team);
if (t == null)
throw new IllegalArgumentException("No such team: " + team);
return createRepository(name, description, homepage, t, isPublic);
}
/**
* Create repository gh repository.
*
* @param name
* the name
* @param description
* the description
* @param homepage
* the homepage
* @param team
* the team
* @param isPublic
* the is public
* @return the gh repository
* @throws IOException
* the io exception
* @deprecated Use {@link #createRepository(String)} that uses a builder pattern to let you control every aspect.
*/
@Deprecated
public GHRepository createRepository(String name,
String description,
String homepage,
GHTeam team,
boolean isPublic) throws IOException {
if (team == null)
throw new IllegalArgumentException("Invalid team");
return createRepository(name).description(description)
.homepage(homepage)
.private_(!isPublic)
.team(team)
.create();
}
/**
* Starts a builder that creates a new repository.
*
* You use the returned builder to set various properties, then call {@link GHCreateRepositoryBuilder#create()} to
* finally create a repository.
*
* @param name
* the name
* @return the gh create repository builder
*/
public GHCreateRepositoryBuilder createRepository(String name) {
return new GHCreateRepositoryBuilder(name, root(), "/orgs/" + login + "/repos");
}
/**
* Teams by their names.
*
* @return the teams
* @throws IOException
* the io exception
*/
public Map getTeams() throws IOException {
Map r = new TreeMap();
for (GHTeam t : listTeams()) {
r.put(t.getName(), t);
}
return r;
}
/**
* List up all the teams.
*
* @return the paged iterable
* @throws IOException
* the io exception
*/
public PagedIterable listTeams() throws IOException {
return root().createRequest()
.withUrlPath(String.format("/orgs/%s/teams", login))
.toIterable(GHTeam[].class, item -> item.wrapUp(this));
}
/**
* Gets a single team by ID.
*
* @param teamId
* id of the team that we want to query for
* @return the team
* @throws IOException
* the io exception
* @deprecated Use {@link GHOrganization#getTeam(long)}
*/
@Deprecated
public GHTeam getTeam(int teamId) throws IOException {
return getTeam((long) teamId);
}
/**
* Gets a single team by ID.
*
* @param teamId
* id of the team that we want to query for
* @return the team
* @throws IOException
* the io exception
* @see documentation
*/
public GHTeam getTeam(long teamId) throws IOException {
return root().createRequest()
.withUrlPath(String.format("/organizations/%d/team/%d", getId(), teamId))
.fetch(GHTeam.class)
.wrapUp(this);
}
/**
* Finds a team that has the given name in its {@link GHTeam#getName()}.
*
* @param name
* the name
* @return the team by name
* @throws IOException
* the io exception
*/
public GHTeam getTeamByName(String name) throws IOException {
for (GHTeam t : listTeams()) {
if (t.getName().equals(name))
return t;
}
return null;
}
/**
* Finds a team that has the given slug in its {@link GHTeam#getSlug()}.
*
* @param slug
* the slug
* @return the team by slug
* @throws IOException
* the io exception
* @see documentation
*/
public GHTeam getTeamBySlug(String slug) throws IOException {
return root().createRequest()
.withUrlPath(String.format("/orgs/%s/teams/%s", login, slug))
.fetch(GHTeam.class)
.wrapUp(this);
}
/**
* Member's role in an organization.
*/
public enum Role {
/** The admin. */
ADMIN,
/** The user is an owner of the organization. */
MEMBER /** The user is a non-owner member of the organization. */
}
/**
* Adds (invites) a user to the organization.
*
* @param user
* the user
* @param role
* the role
* @throws IOException
* the io exception
* @see documentation
*/
public void add(GHUser user, Role role) throws IOException {
root().createRequest()
.method("PUT")
.with("role", role.name().toLowerCase())
.withUrlPath("/orgs/" + login + "/memberships/" + user.getLogin())
.send();
}
/**
* Checks if this organization has the specified user as a member.
*
* @param user
* the user
* @return the boolean
*/
public boolean hasMember(GHUser user) {
try {
root().createRequest().withUrlPath("/orgs/" + login + "/members/" + user.getLogin()).send();
return true;
} catch (IOException ignore) {
return false;
}
}
/**
* Remove a member of the organisation - which will remove them from all teams, and remove their access to the
* organization’s repositories.
*
* @param user
* the user
* @throws IOException
* the io exception
*/
public void remove(GHUser user) throws IOException {
root().createRequest().method("DELETE").withUrlPath("/orgs/" + login + "/members/" + user.getLogin()).send();
}
/**
* Checks if this organization has the specified user as a public member.
*
* @param user
* the user
* @return the boolean
*/
public boolean hasPublicMember(GHUser user) {
try {
root().createRequest().withUrlPath("/orgs/" + login + "/public_members/" + user.getLogin()).send();
return true;
} catch (IOException ignore) {
return false;
}
}
/**
* Publicizes the membership.
*
* @param u
* the u
* @throws IOException
* the io exception
*/
public void publicize(GHUser u) throws IOException {
root().createRequest().method("PUT").withUrlPath("/orgs/" + login + "/public_members/" + u.getLogin()).send();
}
/**
* Gets members.
*
* @return the members
* @throws IOException
* the io exception
* @deprecated use {@link #listMembers()}
*/
public List getMembers() throws IOException {
return listMembers().toList();
}
/**
* All the members of this organization.
*
* @return the paged iterable
* @throws IOException
* the io exception
*/
public PagedIterable listMembers() throws IOException {
return listMembers("members");
}
/**
* All the public members of this organization.
*
* @return the paged iterable
* @throws IOException
* the io exception
*/
public PagedIterable listPublicMembers() throws IOException {
return listMembers("public_members");
}
/**
* All the outside collaborators of this organization.
*
* @return the paged iterable
* @throws IOException
* the io exception
*/
public PagedIterable listOutsideCollaborators() throws IOException {
return listMembers("outside_collaborators");
}
private PagedIterable listMembers(String suffix) throws IOException {
return listMembers(suffix, null, null);
}
/**
* List members with filter paged iterable.
*
* @param filter
* the filter
* @return the paged iterable
* @throws IOException
* the io exception
*/
public PagedIterable listMembersWithFilter(String filter) throws IOException {
return listMembers("members", filter, null);
}
/**
* List outside collaborators with filter paged iterable.
*
* @param filter
* the filter
* @return the paged iterable
* @throws IOException
* the io exception
*/
public PagedIterable listOutsideCollaboratorsWithFilter(String filter) throws IOException {
return listMembers("outside_collaborators", filter, null);
}
/**
* List members with specified role paged iterable.
*
* @param role
* the role
* @return the paged iterable
* @throws IOException
* the io exception
*/
public PagedIterable listMembersWithRole(String role) throws IOException {
return listMembers("members", null, role);
}
private PagedIterable listMembers(final String suffix, final String filter, String role)
throws IOException {
return root().createRequest()
.withUrlPath(String.format("/orgs/%s/%s", login, suffix))
.with("filter", filter)
.with("role", role)
.toIterable(GHUser[].class, null);
}
/**
* Conceals the membership.
*
* @param u
* the u
* @throws IOException
* the io exception
*/
public void conceal(GHUser u) throws IOException {
root().createRequest()
.method("DELETE")
.withUrlPath("/orgs/" + login + "/public_members/" + u.getLogin())
.send();
}
/**
* Are projects enabled for organization boolean.
*
* @return the boolean
*/
public boolean areOrganizationProjectsEnabled() {
return has_organization_projects;
}
/**
* Sets organization projects enabled status boolean.
*
* @param newStatus
* enable status
* @throws IOException
* the io exception
*/
public void enableOrganizationProjects(boolean newStatus) throws IOException {
edit("has_organization_projects", newStatus);
}
private void edit(String key, Object value) throws IOException {
root().createRequest()
.withUrlPath(String.format("/orgs/%s", login))
.method("PATCH")
.with(key, value)
.fetchInto(this);
}
/**
* Returns the projects for this organization.
*
* @param status
* The status filter (all, open or closed).
* @return the paged iterable
* @throws IOException
* the io exception
*/
public PagedIterable listProjects(final GHProject.ProjectStateFilter status) throws IOException {
return root().createRequest()
.withPreview(INERTIA)
.with("state", status)
.withUrlPath(String.format("/orgs/%s/projects", login))
.toIterable(GHProject[].class, null);
}
/**
* Returns all open projects for the organization.
*
* @return the paged iterable
* @throws IOException
* the io exception
*/
public PagedIterable listProjects() throws IOException {
return listProjects(GHProject.ProjectStateFilter.OPEN);
}
/**
* Creates a project for the organization.
*
* @param name
* the name
* @param body
* the body
* @return the gh project
* @throws IOException
* the io exception
*/
public GHProject createProject(String name, String body) throws IOException {
return root().createRequest()
.method("POST")
.withPreview(INERTIA)
.with("name", name)
.with("body", body)
.withUrlPath(String.format("/orgs/%s/projects", login))
.fetch(GHProject.class);
}
/**
* The enum Permission.
*
* @see RepositoryRole
*/
public enum Permission {
/** The admin. */
ADMIN,
/** The maintain. */
MAINTAIN,
/** The push. */
PUSH,
/** The triage. */
TRIAGE,
/** The pull. */
PULL
}
/**
* Repository permissions (roles) for teams and collaborators.
*/
public static class RepositoryRole {
private final String permission;
private RepositoryRole(String permission) {
this.permission = permission;
}
/**
* Custom.
*
* @param permission
* the permission
* @return the repository role
*/
public static RepositoryRole custom(String permission) {
return new RepositoryRole(permission);
}
/**
* From.
*
* @param permission
* the permission
* @return the repository role
*/
public static RepositoryRole from(Permission permission) {
return custom(permission.toString().toLowerCase());
}
/**
* To string.
*
* @return the string
*/
@Override
public String toString() {
return permission;
}
}
/**
* Creates a new team and assigns the repositories.
*
* @param name
* the name
* @param p
* the p
* @param repositories
* the repositories
* @return the gh team
* @throws IOException
* the io exception
* @deprecated https://developer.github.com/v3/teams/#create-team deprecates permission field use
* {@link #createTeam(String)}
*/
@Deprecated
public GHTeam createTeam(String name, Permission p, Collection repositories) throws IOException {
Requester post = root().createRequest().method("POST").with("name", name).with("permission", p);
List repo_names = new ArrayList();
for (GHRepository r : repositories) {
repo_names.add(login + "/" + r.getName());
}
post.with("repo_names", repo_names);
return post.withUrlPath("/orgs/" + login + "/teams").fetch(GHTeam.class).wrapUp(this);
}
/**
* Create team gh team.
*
* @param name
* the name
* @param p
* the p
* @param repositories
* the repositories
* @return the gh team
* @throws IOException
* the io exception
* @deprecated https://developer.github.com/v3/teams/#create-team deprecates permission field use
* {@link #createTeam(String)}
*/
@Deprecated
public GHTeam createTeam(String name, Permission p, GHRepository... repositories) throws IOException {
return createTeam(name, p, Arrays.asList(repositories));
}
/**
* Creates a new team and assigns the repositories.
*
* @param name
* the name
* @param repositories
* the repositories
* @return the gh team
* @throws IOException
* the io exception
* @deprecated Use {@link #createTeam(String)} that uses a builder pattern to let you control every aspect.
*/
@Deprecated
public GHTeam createTeam(String name, Collection repositories) throws IOException {
Requester post = root().createRequest().method("POST").with("name", name);
List repo_names = new ArrayList();
for (GHRepository r : repositories) {
repo_names.add(login + "/" + r.getName());
}
post.with("repo_names", repo_names);
return post.withUrlPath("/orgs/" + login + "/teams").fetch(GHTeam.class).wrapUp(this);
}
/**
* Create team gh team.
*
* @param name
* the name
* @param repositories
* the repositories
* @return the gh team
* @throws IOException
* the io exception
* @deprecated Use {@link #createTeam(String)} that uses a builder pattern to let you control every aspect.
*/
@Deprecated
public GHTeam createTeam(String name, GHRepository... repositories) throws IOException {
return createTeam(name, Arrays.asList(repositories));
}
/**
* Starts a builder that creates a new team.
*
* You use the returned builder to set various properties, then call {@link GHTeamBuilder#create()} to finally
* create a team.
*
* @param name
* the name
* @return the gh create repository builder
*/
public GHTeamBuilder createTeam(String name) {
return new GHTeamBuilder(root(), login, name);
}
/**
* List up repositories that has some open pull requests.
*
* This used to be an efficient method that didn't involve traversing every repository, but now it doesn't do any
* optimization.
*
* @return the repositories with open pull requests
* @throws IOException
* the io exception
*/
public List getRepositoriesWithOpenPullRequests() throws IOException {
List r = new ArrayList();
for (GHRepository repository : listRepositories(100)) {
List pullRequests = repository.getPullRequests(GHIssueState.OPEN);
if (pullRequests.size() > 0) {
r.add(repository);
}
}
return r;
}
/**
* Gets all the open pull requests in this organization.
*
* @return the pull requests
* @throws IOException
* the io exception
*/
public List getPullRequests() throws IOException {
List all = new ArrayList();
for (GHRepository r : getRepositoriesWithOpenPullRequests()) {
all.addAll(r.getPullRequests(GHIssueState.OPEN));
}
return all;
}
/**
* Lists events performed by a user (this includes private events if the caller is authenticated.
*
* @return the paged iterable
* @throws IOException
* Signals that an I/O exception has occurred.
*/
public PagedIterable listEvents() throws IOException {
return root().createRequest()
.withUrlPath(String.format("/orgs/%s/events", login))
.toIterable(GHEventInfo[].class, null);
}
/**
* Lists up all the repositories using the specified page size.
*
* @param pageSize
* size for each page of items returned by GitHub. Maximum page size is 100. Unlike
* {@link #getRepositories()}, this does not wait until all the repositories are returned.
* @return the paged iterable
*/
@Override
public PagedIterable listRepositories(final int pageSize) {
return root().createRequest()
.withUrlPath("/orgs/" + login + "/repos")
.toIterable(GHRepository[].class, null)
.withPageSize(pageSize);
}
/**
* Retrieves the currently configured hooks.
*
* @return the hooks
* @throws IOException
* the io exception
*/
public List getHooks() throws IOException {
return GHHooks.orgContext(this).getHooks();
}
/**
* Gets hook.
*
* @param id
* the id
* @return the hook
* @throws IOException
* the io exception
*/
public GHHook getHook(int id) throws IOException {
return GHHooks.orgContext(this).getHook(id);
}
/**
* Deletes hook.
*
* @param id
* the id
* @throws IOException
* the io exception
*/
public void deleteHook(int id) throws IOException {
GHHooks.orgContext(this).deleteHook(id);
}
/**
* See https://api.github.com/hooks for possible names and their configuration scheme. TODO: produce type-safe
* binding
*
* @param name
* Type of the hook to be created. See https://api.github.com/hooks for possible names.
* @param config
* The configuration hash.
* @param events
* Can be null. Types of events to hook into.
* @param active
* the active
* @return the gh hook
* @throws IOException
* the io exception
*/
public GHHook createHook(String name, Map config, Collection events, boolean active)
throws IOException {
return GHHooks.orgContext(this).createHook(name, config, events, active);
}
/**
* Create web hook gh hook.
*
* @param url
* the url
* @param events
* the events
* @return the gh hook
* @throws IOException
* the io exception
*/
public GHHook createWebHook(URL url, Collection events) throws IOException {
return createHook("web", Collections.singletonMap("url", url.toExternalForm()), events, true);
}
/**
* Create web hook gh hook.
*
* @param url
* the url
* @return the gh hook
* @throws IOException
* the io exception
*/
public GHHook createWebHook(URL url) throws IOException {
return createWebHook(url, null);
}
}