com.mb3364.twitch.api.auth.grants.implicit

Class AuthenticationCallbackServer

java.lang.Object

com.mb3364.twitch.api.auth.grants.implicit.AuthenticationCallbackServer

All Implemented Interfaces:

AuthenticationListener

public class AuthenticationCallbackServer
extends java.lang.Object
implements AuthenticationListener

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_AUTH_PAGE Default HTML page that twitch.tv will send the access_token to
static java.lang.String	DEFAULT_FAILURE_PAGE Default HTML page that shows auth error's to user
static java.lang.String	DEFAULT_SUCCESS_PAGE Default HTML page that shows auth success to

Constructor Summary

Constructors

Constructor and Description
AuthenticationCallbackServer(int port) Constructor that will use default HTML views for output.
AuthenticationCallbackServer(int port, java.net.URL authPage, java.net.URL failurePage, java.net.URL successPage) Constructor with user specified HTML views to output.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAccessToken() Get the access token if one exists.
AuthenticationError	getAuthenticationError() Get the auth error if it failed.
boolean	hasAuthenticationError() Check if there was an authentication error
boolean	isRunning() Check to see if server is running.
void	onAccessTokenReceived(java.lang.String token) Called when a twitch.tv authentication access token has been received.
void	onAuthenticationError(java.lang.String error, java.lang.String description) An authentication error occurred.
void	start() Start the server and listen for auth callbacks from twitch.
void	stop() Stops the server.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_AUTH_PAGE

public static final java.lang.String DEFAULT_AUTH_PAGE

Default HTML page that twitch.tv will send the access_token to

See Also:

Constant Field Values

DEFAULT_FAILURE_PAGE

public static final java.lang.String DEFAULT_FAILURE_PAGE

Default HTML page that shows auth error's to user

See Also:

Constant Field Values

DEFAULT_SUCCESS_PAGE

public static final java.lang.String DEFAULT_SUCCESS_PAGE

Default HTML page that shows auth success to

See Also:

Constant Field Values

Constructor Detail

AuthenticationCallbackServer

public AuthenticationCallbackServer(int port)

Constructor that will use default HTML views for output.

Parameters:

port - Network port to receive requests on

AuthenticationCallbackServer

public AuthenticationCallbackServer(int port,
                                    java.net.URL authPage,
                                    java.net.URL failurePage,
                                    java.net.URL successPage)

Constructor with user specified HTML views to output.

Parameters:

port - Network port to receive requests on

authPage - HTML page that twitch.tv will send the access_token to

failurePage - HTML page that shows auth error to user

successPage - HTML page that shows auth success to user

Method Detail

start

public void start()
           throws java.io.IOException

Start the server and listen for auth callbacks from twitch.

Throws:

java.io.IOException - if an I/O error occurs while waiting for a connection.

stop

public void stop()

Stops the server.

isRunning

public boolean isRunning()

Check to see if server is running.

Returns:

true if server is running. false otherwise

onAccessTokenReceived

public void onAccessTokenReceived(java.lang.String token)

Description copied from interface: AuthenticationListener

Called when a twitch.tv authentication access token has been received.

Specified by:

onAccessTokenReceived in interface AuthenticationListener

Parameters:

token - twitch.tv authentication access token

onAuthenticationError

public void onAuthenticationError(java.lang.String error,
                                  java.lang.String description)

Description copied from interface: AuthenticationListener

An authentication error occurred. Usually due to user denying the request.

Specified by:

onAuthenticationError in interface AuthenticationListener

Parameters:

error - Error name

description - Error description

getAccessToken

public java.lang.String getAccessToken()

Get the access token if one exists.

Returns:

Access token if it exists, null otherwise

getAuthenticationError

public AuthenticationError getAuthenticationError()

Get the auth error if it failed.

Returns:

Error string if auth failed. null otherwise

hasAuthenticationError

public boolean hasAuthenticationError()

Check if there was an authentication error

Returns:

true if an error exists, false otherwise