Module Mal4J

Package dev.katsute.mal4j

Class MyAnimeListAuthenticator.LocalServerBuilder

java.lang.Object

dev.katsute.mal4j.MyAnimeListAuthenticator.LocalServerBuilder

Enclosing class:

MyAnimeListAuthenticator

public static final class MyAnimeListAuthenticator.LocalServerBuilder
extends Object

Creates a MyAnimeList Authenticator by deploying a local server to authenticate the user.

Since:

1.1.0

Version:

2.4.0

Author:

Katsute

See Also:

• MyAnimeListAuthenticator

Constructor Summary

Constructors

Constructor	Description
LocalServerBuilder(String client_id, int port)	Instantiates a local server builder with a client id and port.
LocalServerBuilder(String client_id, String client_secret, int port)	Instantiates a local server builder with a client id, client secret, and port.

Method Summary

Modifier and Type	Method	Description
final MyAnimeListAuthenticator	build()	Returns the built authenticator.
final MyAnimeListAuthenticator.LocalServerBuilder	openBrowser()	Indicates that the authorization page should be opened in the user's browser automatically.
final MyAnimeListAuthenticator.LocalServerBuilder	openBrowser(boolean openBrowser)	If true, a browser will automatically be opened to the authorization page.
final MyAnimeListAuthenticator.LocalServerBuilder	setRedirectURI(String redirectURI)	Sets the application redirect URI.
final MyAnimeListAuthenticator.LocalServerBuilder	setResponseHandler(AuthResponseHandler responseHandler)	Sets the response handler.
final MyAnimeListAuthenticator.LocalServerBuilder	setTimeout(int timeout)	Sets how long (in seconds) that the server will expire in.
final MyAnimeListAuthenticator.LocalServerBuilder	setURLCallback(Consumer<String> consumer)	Sets the auth URL callback method.
final String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

LocalServerBuilder

public LocalServerBuilder(String client_id,
 int port)

Instantiates a local server builder with a client id and port.

Parameters:

client_id - client id

port - port

Since:

1.1.0

See Also:

• LocalServerBuilder(String, String, int)

LocalServerBuilder

public LocalServerBuilder(String client_id,
 String client_secret,
 int port)

Instantiates a local server builder with a client id, client secret, and port.

Parameters:

client_id - client id

client_secret - client secret

port - port

Since:

1.1.0

See Also:

• LocalServerBuilder(String, int)

Method Details

openBrowser

public final MyAnimeListAuthenticator.LocalServerBuilder openBrowser()

Indicates that the authorization page should be opened in the user's browser automatically.

Returns:

builder

Since:

1.1.0

See Also:

• openBrowser(boolean)

openBrowser

public final MyAnimeListAuthenticator.LocalServerBuilder openBrowser(boolean openBrowser)

If true, a browser will automatically be opened to the authorization page. Note that if this is false you will have to go to the page manually using MyAnimeListAuthenticator.getAuthorizationURL(String, String), MyAnimeListAuthenticator.getAuthorizationURL(String, String, String), or MyAnimeListAuthenticator.getAuthorizationURL(String, String, String, String).

Parameters:

openBrowser - if browser should be opened

Returns:

builder

Since:

1.1.0

See Also:

• openBrowser()

setTimeout

public final MyAnimeListAuthenticator.LocalServerBuilder setTimeout(int timeout)

Sets how long (in seconds) that the server will expire in. Once the timeout has passed a new authentication builder must be used.

Parameters:

timeout - server timeout

Returns:

builder

Since:

1.1.0

setRedirectURI

public final MyAnimeListAuthenticator.LocalServerBuilder setRedirectURI(String redirectURI)

Sets the application redirect URI. Only required if your application has more than one redirect URI registered.

Parameters:

redirectURI - redirect URI

Returns:

builder

Since:

1.1.0

setResponseHandler

public final MyAnimeListAuthenticator.LocalServerBuilder setResponseHandler(AuthResponseHandler responseHandler)

Sets the response handler.

Parameters:

responseHandler - response handler

Returns:

builder

Since:

1.1.0

See Also:

• AuthResponseHandler

setURLCallback

public final MyAnimeListAuthenticator.LocalServerBuilder setURLCallback(Consumer<String> consumer)

Sets the auth URL callback method. Used to retrieve the URL that generates the authorization code. Runs in its own thread.
This method can be used to handle the auth URL in the case that the system doesn't support the openBrowser() method.

Parameters:

consumer - consumer

Returns:

builder

Since:

2.0.0

See Also:

• Consumer

build

public final MyAnimeListAuthenticator build()
                                     throws IOException

Returns the built authenticator.

Returns:

authenticator

Throws:

IllegalArgumentException - if port was invalid, or client id or redirect URI was malformed

BindException - if port was blocked

NullPointerException - if server was closed before the client could be authorized

IOException

Since:

1.1.0

See Also:

• MyAnimeListAuthenticator

toString

public final String toString()

Overrides:

toString in class Object