com.jdroid.github.service

Class OrganizationService

java.lang.Object

com.jdroid.github.service.GitHubService

com.jdroid.github.service.OrganizationService

public class OrganizationService
extends GitHubService

Organization service class

See Also:

GitHub organization API documentation, GitHub organization membership API documentation

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OrganizationService.RoleFilter Filter for roles a member can have

Field Summary

Fields inherited from class com.jdroid.github.service.GitHubService

ACCEPT_FULL, ACCEPT_HTML, ACCEPT_PREVIEW_DRAX, ACCEPT_PREVIEW_IRONMAN, ACCEPT_PREVIEW_LOKI, ACCEPT_RAW, ACCEPT_TEXT, client

Constructor Summary

Constructors

Constructor and Description
OrganizationService() Create organization service
OrganizationService(GitHubClient client) Create organization service

Method Summary

Modifier and Type	Method and Description
protected PagedRequest<User>	createOrgRequest(java.lang.String user, int start, int size) Create org request
User	editOrganization(User organization) Edit given organization
java.util.List<User>	getMembers(java.lang.String organization) Get members of organization
java.util.List<User>	getMembers(java.lang.String organization, OrganizationService.RoleFilter roleFilter) Get members of organization
User	getOrganization(java.lang.String name) Get organization with the given name
java.util.List<User>	getOrganizations() Get organizations that the currently authenticated user is a member of
java.util.List<User>	getOrganizations(java.lang.String user) Get organizations that the given user is a member of
java.util.List<User>	getPublicMembers(java.lang.String organization) Get public members of organization
void	hideMembership(java.lang.String organization, java.lang.String user) Conceal membership of given user in given organization
boolean	isMember(java.lang.String organization, java.lang.String user) Check if the given user is a member of the given organization
boolean	isPublicMember(java.lang.String organization, java.lang.String user) Check if the given user is a public member of the given organization
void	removeMember(java.lang.String organization, java.lang.String user) Remove the given member from the given organization
void	showMembership(java.lang.String organization, java.lang.String user) Publicize membership of given user in given organization

Methods inherited from class com.jdroid.github.service.GitHubService

check, createPagedRequest, createPagedRequest, createPageIterator, createRequest, getAll, getAll, getClient, getId, verifyRepository

Methods inherited from class java.lang.Object

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

Constructor Detail

OrganizationService

public OrganizationService()

Create organization service

OrganizationService

public OrganizationService(GitHubClient client)

Create organization service

Parameters:

client -

Method Detail

createOrgRequest

protected PagedRequest<User> createOrgRequest(java.lang.String user,
                                              int start,
                                              int size)

Create org request

Parameters:

user -

start -

size -

Returns:

request

getOrganizations

public java.util.List<User> getOrganizations()
                                      throws java.io.IOException

Get organizations that the currently authenticated user is a member of

Returns:

list of organizations

Throws:

java.io.IOException

getOrganizations

public java.util.List<User> getOrganizations(java.lang.String user)
                                      throws java.io.IOException

Get organizations that the given user is a member of

Parameters:

user -

Returns:

list of organizations

Throws:

java.io.IOException

getOrganization

public User getOrganization(java.lang.String name)
                     throws java.io.IOException

Get organization with the given name

Parameters:

name -

Returns:

organization

Throws:

java.io.IOException

editOrganization

public User editOrganization(User organization)
                      throws java.io.IOException

Edit given organization

Parameters:

organization -

Returns:

edited organization

Throws:

java.io.IOException

getMembers

public java.util.List<User> getMembers(java.lang.String organization)
                                throws java.io.IOException

Get members of organization

Parameters:

organization - the name of the organization

Returns:

list of all organization members

Throws:

java.io.IOException

getMembers

public java.util.List<User> getMembers(java.lang.String organization,
                                       OrganizationService.RoleFilter roleFilter)
                                throws java.io.IOException

Get members of organization

Parameters:

organization - the name of the organization

roleFilter - only return members matching the OrganizationService.RoleFilter
To use this feature it is currently required to set the application/vnd.github.ironman-preview+json Accept header in the GitHubClient

Returns:

list of all organization members whose role matches the roleFilter

Throws:

java.io.IOException

Since:

4.2

getPublicMembers

public java.util.List<User> getPublicMembers(java.lang.String organization)
                                      throws java.io.IOException

Get public members of organization

Parameters:

organization -

Returns:

list of public organization members

Throws:

java.io.IOException

isMember

public boolean isMember(java.lang.String organization,
                        java.lang.String user)
                 throws java.io.IOException

Check if the given user is a member of the given organization

Parameters:

organization -

user -

Returns:

true if member, false if not member

Throws:

java.io.IOException

isPublicMember

public boolean isPublicMember(java.lang.String organization,
                              java.lang.String user)
                       throws java.io.IOException

Check if the given user is a public member of the given organization

Parameters:

organization -

user -

Returns:

true if public member, false if not public member

Throws:

java.io.IOException

showMembership

public void showMembership(java.lang.String organization,
                           java.lang.String user)
                    throws java.io.IOException

Publicize membership of given user in given organization

Parameters:

organization -

user -

Throws:

java.io.IOException

hideMembership

public void hideMembership(java.lang.String organization,
                           java.lang.String user)
                    throws java.io.IOException

Conceal membership of given user in given organization

Parameters:

organization -

user -

Throws:

java.io.IOException

removeMember

public void removeMember(java.lang.String organization,
                         java.lang.String user)
                  throws java.io.IOException

Remove the given member from the given organization

Parameters:

organization -

user -

Throws:

java.io.IOException