org.gitlab.api.http

Class GitlabHTTPRequestor

java.lang.Object

org.gitlab.api.http.GitlabHTTPRequestor

public class GitlabHTTPRequestor
extends java.lang.Object

Gitlab HTTP Requestor Responsible for handling HTTP requests to the Gitlab API

Author:

@timols (Tim O)

Constructor Summary

Constructors

Constructor and Description
GitlabHTTPRequestor(GitlabAPI root)

Method Summary

Modifier and Type	Method and Description
<T> java.util.Iterator<T>	asIterator(java.lang.String tailApiUrl, java.lang.Class<T> type)
GitlabHTTPRequestor	authenticate(java.lang.String token, TokenType type, AuthMethod method) Sets authentication data for the request.
<T> java.util.List<T>	getAll(java.lang.String tailUrl, java.lang.Class<T[]> type)
GitlabHTTPRequestor	method(java.lang.String method) Sets the HTTP Request method for the request.
<T> T	to(java.lang.String tailAPIUrl, java.lang.Class<T> type)
<T> T	to(java.lang.String tailAPIUrl, java.lang.Class<T> type, T instance) Opens the HTTP(S) connection, submits any data and parses the response.
<T> T	to(java.lang.String tailAPIUrl, T instance)
GitlabHTTPRequestor	with(java.lang.String key, java.lang.Object value) Sets the HTTP Form Post parameters for the request Has a fluent api for method chaining
GitlabHTTPRequestor	withAttachment(java.lang.String key, java.io.File file) Sets the HTTP Form Post parameters for the request Has a fluent api for method chaining

Methods inherited from class java.lang.Object

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

Constructor Detail

GitlabHTTPRequestor

public GitlabHTTPRequestor(GitlabAPI root)

Method Detail

authenticate

public GitlabHTTPRequestor authenticate(java.lang.String token,
                                        TokenType type,
                                        AuthMethod method)

Sets authentication data for the request. Has a fluent api for method chaining.

Parameters:

token - The token value

type - The type of the token

method - The authentication method

Returns:

this

method

public GitlabHTTPRequestor method(java.lang.String method)

Sets the HTTP Request method for the request. Has a fluent api for method chaining.

Parameters:

method - The HTTP method

Returns:

this

with

public GitlabHTTPRequestor with(java.lang.String key,
                                java.lang.Object value)

Sets the HTTP Form Post parameters for the request Has a fluent api for method chaining

Parameters:

key - Form parameter Key

value - Form parameter Value

Returns:

this

withAttachment

public GitlabHTTPRequestor withAttachment(java.lang.String key,
                                          java.io.File file)

Sets the HTTP Form Post parameters for the request Has a fluent api for method chaining

Parameters:

key - Form parameter Key

value - Form parameter Value

Returns:

this

to

public <T> T to(java.lang.String tailAPIUrl,
                T instance)
         throws java.io.IOException

Throws:

java.io.IOException

to

public <T> T to(java.lang.String tailAPIUrl,
                java.lang.Class<T> type)
         throws java.io.IOException

Throws:

java.io.IOException

to

public <T> T to(java.lang.String tailAPIUrl,
                java.lang.Class<T> type,
                T instance)
         throws java.io.IOException

Opens the HTTP(S) connection, submits any data and parses the response. Will throw an error

Type Parameters:

T - The return type of the method

Parameters:

tailAPIUrl - The url to open a connection to (after the host and namespace)

type - The type of the response to be deserialized from

instance - The instance to update from the response

Returns:

An object of type T

Throws:

java.io.IOException - on gitlab api error

getAll

public <T> java.util.List<T> getAll(java.lang.String tailUrl,
                                    java.lang.Class<T[]> type)

asIterator

public <T> java.util.Iterator<T> asIterator(java.lang.String tailApiUrl,
                                            java.lang.Class<T> type)