Class ClientBuilder

java.lang.Object

org.mineskin.ClientBuilder

public class ClientBuilder
extends Object

Method Summary

Modifier and Type	Method	Description
ClientBuilder	apiKey(String apiKey)	Set the API key
ClientBuilder	baseUrl(String baseUrl)	Set the base URL for the API
MineSkinClient	build()	Build the MineSkinClient
static ClientBuilder	create()	Create a new ClientBuilder
ClientBuilder	generateExecutor(Executor generateExecutor)	Set the Executor for generate requests
ClientBuilder	generateQueueOptions(IQueueOptions queueOptions)	Set the options for submitting queue jobs defaults to 200ms interval and 1 concurrent request For example:
ClientBuilder	generateRequestScheduler(ScheduledExecutorService scheduledExecutor)	Deprecated. use generateQueueOptions(IQueueOptions) instead
ClientBuilder	getExecutor(Executor getExecutor)	Set the Executor for get requests
ClientBuilder	getQueueOptions(IQueueOptions queueOptions)	Set the options for get requests, e.g. getting skins defaults to 100ms interval and 5 concurrent requests For example:
ClientBuilder	getRequestScheduler(ScheduledExecutorService scheduledExecutor)	Deprecated. use getQueueOptions(IQueueOptions) instead
ClientBuilder	gson(com.google.gson.Gson gson)	Set the Gson instance
ClientBuilder	jobCheckOptions(IJobCheckOptions jobCheckOptions)	Set the options for checking job status defaults to 1000ms interval, 2000ms initial delay, and 10 max attempts For example:
ClientBuilder	jobCheckScheduler(ScheduledExecutorService scheduledExecutor)	Deprecated. use jobCheckOptions(IJobCheckOptions) instead
ClientBuilder	requestHandler(RequestHandlerConstructor requestHandlerConstructor)	Set the constructor for the RequestHandler
ClientBuilder	timeout(int timeout)	Set the timeout
ClientBuilder	userAgent(String userAgent)	Set the User-Agent

Methods inherited from class Object

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

Method Details

create

public static ClientBuilder create()

Create a new ClientBuilder

baseUrl

public ClientBuilder baseUrl(String baseUrl)

Set the base URL for the API

Parameters:

baseUrl - the base URL, e.g. "https://api.mineskin.org"

userAgent

public ClientBuilder userAgent(String userAgent)

Set the User-Agent

apiKey

public ClientBuilder apiKey(String apiKey)

Set the API key

timeout

public ClientBuilder timeout(int timeout)

Set the timeout

gson

public ClientBuilder gson(com.google.gson.Gson gson)

Set the Gson instance

getExecutor

public ClientBuilder getExecutor(Executor getExecutor)

Set the Executor for get requests

generateExecutor

public ClientBuilder generateExecutor(Executor generateExecutor)

Set the Executor for generate requests

generateRequestScheduler

@Deprecated
public ClientBuilder generateRequestScheduler(ScheduledExecutorService scheduledExecutor)

Deprecated.

use generateQueueOptions(IQueueOptions) instead

Set the ScheduledExecutorService for submitting queue jobs

generateQueueOptions

public ClientBuilder generateQueueOptions(IQueueOptions queueOptions)

Set the options for submitting queue jobs
defaults to 200ms interval and 1 concurrent request
For example:

GenerateQueueOptions.create()
        .withInterval(200, TimeUnit.MILLISECONDS)
        .withConcurrency(2)
 

See Also:

• GenerateQueueOptions
• QueueOptions

getRequestScheduler

@Deprecated
public ClientBuilder getRequestScheduler(ScheduledExecutorService scheduledExecutor)

Deprecated.

use getQueueOptions(IQueueOptions) instead

Set the ScheduledExecutorService for get requests, e.g. getting skins

getQueueOptions

public ClientBuilder getQueueOptions(IQueueOptions queueOptions)

Set the options for get requests, e.g. getting skins
defaults to 100ms interval and 5 concurrent requests
For example:

GetQueueOptions.create()
        .withInterval(500, TimeUnit.MILLISECONDS)
 

See Also:

• GetQueueOptions
• QueueOptions

jobCheckScheduler

@Deprecated
public ClientBuilder jobCheckScheduler(ScheduledExecutorService scheduledExecutor)

Deprecated.

use jobCheckOptions(IJobCheckOptions) instead

Set the ScheduledExecutorService for checking job status

jobCheckOptions

public ClientBuilder jobCheckOptions(IJobCheckOptions jobCheckOptions)

Set the options for checking job status
defaults to 1000ms interval, 2000ms initial delay, and 10 max attempts
For example:

JobCheckOptions.create()
        .withInitialDelay(1000, TimeUnit.MILLISECONDS)
        .withInterval(RequestInterval.exponential())
        .withMaxAttempts(50)

See Also:

• JobCheckOptions

requestHandler

public ClientBuilder requestHandler(RequestHandlerConstructor requestHandlerConstructor)

Set the constructor for the RequestHandler

build

public MineSkinClient build()

Build the MineSkinClient