com.jdroid.github.service

Class GitHubService

java.lang.Object

com.jdroid.github.service.GitHubService

Direct Known Subclasses:

CollaboratorService, CommitService, ContentsService, DataService, DeployKeyService, DownloadService, EventService, GistService, IssueService, LabelService, MarkdownService, MilestoneService, OAuthService, OrganizationService, PullRequestService, ReleaseService, RepositoryService, StargazerService, TeamService, UserService, WatcherService

public abstract class GitHubService
extends java.lang.Object

Base GitHub service class.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACCEPT_FULL Accept header for full response (body, bodyText and bodyHtml)
static java.lang.String	ACCEPT_HTML Accept header for HTML response (only bodyHtml)
static java.lang.String	ACCEPT_PREVIEW_DRAX Accept header to use preview features of the 'drax' release.
static java.lang.String	ACCEPT_PREVIEW_IRONMAN Accept header to use preview features of the 'ironman' release.
static java.lang.String	ACCEPT_PREVIEW_LOKI Accept header to use preview features of the 'loki' release.
static java.lang.String	ACCEPT_RAW Accept header for raw response (only body)
static java.lang.String	ACCEPT_TEXT Accept header for text response (only bodyText)
protected GitHubClient	client Client field

Constructor Summary

Constructors

Constructor and Description
GitHubService() Create service using a default GitHubClient
GitHubService(GitHubClient client) Create service for client

Method Summary

Modifier and Type	Method and Description
protected boolean	check(java.lang.String uri) Check if the uri returns a non-404
protected <V> PagedRequest<V>	createPagedRequest() Unified paged request creation method that all sub-classes should use so overriding classes can extend and configure the default request.
protected <V> PagedRequest<V>	createPagedRequest(int start, int size) Unified paged request creation method that all sub-classes should use so overriding classes can extend and configure the default request.
protected <V> PageIterator<V>	createPageIterator(PagedRequest<V> request) Unified page iterator creation method that all sub-classes should use so overriding classes can extend and configure the default iterator.
protected GitHubRequest	createRequest() Unified request creation method that all sub-classes should use so overriding classes can extend and configure the default request.
protected <V> java.util.List<V>	getAll(PagedRequest<V> request) Get paged request by performing multiple requests until no more pages are available or an exception occurs.
protected <V> java.util.List<V>	getAll(PageIterator<V> iterator) Get paged request by performing multiple requests until no more pages are available or an exception occurs.
GitHubClient	getClient() Get configured client
protected java.lang.String	getId(IRepositoryIdProvider provider) Get id for repository
protected GitHubService	verifyRepository(java.lang.String user, java.lang.String repository) Verify user and repository name

Methods inherited from class java.lang.Object

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

Field Detail

ACCEPT_RAW

public static final java.lang.String ACCEPT_RAW

Accept header for raw response (only body)

See Also:

Constant Field Values

ACCEPT_HTML

public static final java.lang.String ACCEPT_HTML

Accept header for HTML response (only bodyHtml)

See Also:

Constant Field Values

ACCEPT_TEXT

public static final java.lang.String ACCEPT_TEXT

Accept header for text response (only bodyText)

See Also:

Constant Field Values

ACCEPT_FULL

public static final java.lang.String ACCEPT_FULL

Accept header for full response (body, bodyText and bodyHtml)

See Also:

Constant Field Values

ACCEPT_PREVIEW_IRONMAN

public static final java.lang.String ACCEPT_PREVIEW_IRONMAN

Accept header to use preview features of the 'ironman' release.

Since:

4.2

See Also:

https://developer.github.com/changes, Constant Field Values

ACCEPT_PREVIEW_LOKI

public static final java.lang.String ACCEPT_PREVIEW_LOKI

Accept header to use preview features of the 'loki' release.

Since:

4.2

See Also:

https://developer.github.com/changes, Constant Field Values

ACCEPT_PREVIEW_DRAX

public static final java.lang.String ACCEPT_PREVIEW_DRAX

Accept header to use preview features of the 'drax' release.

Since:

4.2

See Also:

https://developer.github.com/changes, Constant Field Values

client

protected final GitHubClient client

Client field

Constructor Detail

GitHubService

public GitHubService()

Create service using a default GitHubClient

GitHubService

public GitHubService(GitHubClient client)

Create service for client

Parameters:

client - must be non-null

Method Detail

getClient

public GitHubClient getClient()

Get configured client

Returns:

non-null client

createRequest

protected GitHubRequest createRequest()

Unified request creation method that all sub-classes should use so overriding classes can extend and configure the default request.

Returns:

request

createPagedRequest

protected <V> PagedRequest<V> createPagedRequest()

Unified paged request creation method that all sub-classes should use so overriding classes can extend and configure the default request.

Returns:

request

createPagedRequest

protected <V> PagedRequest<V> createPagedRequest(int start,
                                                 int size)

Unified paged request creation method that all sub-classes should use so overriding classes can extend and configure the default request.

Parameters:

start -

size -

Returns:

request

createPageIterator

protected <V> PageIterator<V> createPageIterator(PagedRequest<V> request)

Unified page iterator creation method that all sub-classes should use so overriding classes can extend and configure the default iterator.

Parameters:

request -

Returns:

iterator

getAll

protected <V> java.util.List<V> getAll(PagedRequest<V> request)
                                throws java.io.IOException

Get paged request by performing multiple requests until no more pages are available or an exception occurs.

Type Parameters:

V -

Parameters:

request -

Returns:

list of all elements

Throws:

java.io.IOException

getAll

protected <V> java.util.List<V> getAll(PageIterator<V> iterator)
                                throws java.io.IOException

Get paged request by performing multiple requests until no more pages are available or an exception occurs.

Type Parameters:

V -

Parameters:

iterator -

Returns:

list of all elements

Throws:

java.io.IOException

check

protected boolean check(java.lang.String uri)
                 throws java.io.IOException

Check if the uri returns a non-404

Parameters:

uri -

Returns:

true if no exception, false if 404

Throws:

java.io.IOException

getId

protected java.lang.String getId(IRepositoryIdProvider provider)

Get id for repository

Parameters:

provider -

Returns:

non-null id

verifyRepository

protected GitHubService verifyRepository(java.lang.String user,
                                         java.lang.String repository)

Verify user and repository name

Parameters:

user -

repository -

Returns:

this service