review.classdesign.jammy.service.internal

Class GoogleLogger

java.lang.Object

review.classdesign.jammy.service.internal.GoogleLogger

All Implemented Interfaces:

IGoogleLogger

public final class GoogleLogger
extends java.lang.Object
implements IGoogleLogger

IGoogleLogger implementation.

Author:

fv

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	AUTHORIZATION_ERROR_MESSAGE Error message displayed when an error occurs during OAuth login.
private com.google.api.client.auth.oauth2.AuthorizationCodeFlow	flow AuthorizationCodeFlow instance used for managing OAuth login.
private static java.lang.String	JOB_NAME Name used for the job task that wait for the code reception.
private static com.google.api.client.json.JsonFactory	JSON_FACTORY Default factory used to parse JSON data.
private java.util.Collection<java.lang.Runnable>	listeners Listeners that are triggered when authorization is completed.
private com.google.api.client.extensions.jetty.auth.oauth2.LocalServerReceiver	receiver Jetty server uses for token response handling.
private java.lang.String	redirectUri Redirection URI generated by the code flow.
private static java.util.Collection<java.lang.String>	SCOPES Scopes of the created session.
private static java.lang.String	SECRET_PATH Default path of the JSON secret file.
private static java.lang.String	SERVER_STOP_ERROR_MESSAGE Error message displayed when an error occurs while stoping server.
private static java.lang.String	SERVER_WAIT_ERROR_MESSGAGE Error message displayed when an error occurs while server is waiting.
private java.util.function.Consumer<Session>	sessionConsumer Session consumer used when session is created.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	GoogleLogger(com.google.api.client.auth.oauth2.AuthorizationCodeFlow.Builder builder, java.util.function.Consumer<Session> sessionConsumer) Default constructor.

Method Summary

Modifier and Type	Method and Description
void	addListener(java.lang.Runnable listener) Adds the given runnable as a listener that will be triggered when the authorization process is finished.
private void	authorize(java.lang.String code) Finalizes OAuth login by executing token request using the given code.
void	cancel() Performs a cancel in the authorization process, which consists in stopping the waiting server.
static IGoogleLogger	createLogger(java.util.function.Consumer<Session> sessionConsumer) Creates and returns a valid IGoogleLogger instance.
private static com.google.api.client.googleapis.auth.oauth2.GoogleClientSecrets	getSecret() Static tool method that retrieves google client secret instance from internal JSON file.
java.lang.String	getURL() Returns a valid authorization URL that can be used for authorize this application to work with google API.
private org.eclipse.core.runtime.IStatus	waitForCode(org.eclipse.core.runtime.IProgressMonitor monitor) Functional method that aims to act as an IJobFunction.

Methods inherited from class java.lang.Object

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

Field Detail

SECRET_PATH

private static final java.lang.String SECRET_PATH

Default path of the JSON secret file.

See Also:

Constant Field Values

JSON_FACTORY

private static final com.google.api.client.json.JsonFactory JSON_FACTORY

Default factory used to parse JSON data.

SCOPES

private static final java.util.Collection<java.lang.String> SCOPES

Scopes of the created session.

SERVER_STOP_ERROR_MESSAGE

private static final java.lang.String SERVER_STOP_ERROR_MESSAGE

Error message displayed when an error occurs while stoping server.

See Also:

Constant Field Values

SERVER_WAIT_ERROR_MESSGAGE

private static final java.lang.String SERVER_WAIT_ERROR_MESSGAGE

Error message displayed when an error occurs while server is waiting.

See Also:

Constant Field Values

AUTHORIZATION_ERROR_MESSAGE

private static final java.lang.String AUTHORIZATION_ERROR_MESSAGE

Error message displayed when an error occurs during OAuth login.

See Also:

Constant Field Values

flow

private final com.google.api.client.auth.oauth2.AuthorizationCodeFlow flow

AuthorizationCodeFlow instance used for managing OAuth login.

receiver

private final com.google.api.client.extensions.jetty.auth.oauth2.LocalServerReceiver receiver

Jetty server uses for token response handling.

sessionConsumer

private final java.util.function.Consumer<Session> sessionConsumer

Session consumer used when session is created.

listeners

private final java.util.Collection<java.lang.Runnable> listeners

Listeners that are triggered when authorization is completed.

redirectUri

private java.lang.String redirectUri

Redirection URI generated by the code flow.

JOB_NAME

private static final java.lang.String JOB_NAME

Name used for the job task that wait for the code reception.

See Also:

Constant Field Values

Constructor Detail

GoogleLogger

private GoogleLogger(com.google.api.client.auth.oauth2.AuthorizationCodeFlow.Builder builder,
                     java.util.function.Consumer<Session> sessionConsumer)

Default constructor. Uses builder to create the flow, and initializes the internal server instance used as a receiver.

Parameters:

builder - Flow builder used to create flow instance.

sessionConsumer - Session consumer used when session is created.

Method Detail

addListener

public void addListener(java.lang.Runnable listener)

Adds the given runnable as a listener that will be triggered when the authorization process is finished.

Specified by:

addListener in interface IGoogleLogger

Parameters:

listener - Runnable instance that will be registered as a listener.

cancel

public void cancel()

Performs a cancel in the authorization process, which consists in stopping the waiting server.

Specified by:

cancel in interface IGoogleLogger

authorize

private void authorize(java.lang.String code)

Finalizes OAuth login by executing token request using the given code.

Parameters:

code - Code to use for retrieving the authorization token.

waitForCode

private org.eclipse.core.runtime.IStatus waitForCode(org.eclipse.core.runtime.IProgressMonitor monitor)

Functional method that aims to act as an IJobFunction. This function wait for code to be received and starts token request once it is done.

Parameters:

monitor - Monitor to use for tracking login progress.

Returns:

Status.OK_STATUS

getURL

public java.lang.String getURL()
                        throws java.io.IOException

Returns a valid authorization URL that can be used for authorize this application to work with google API. A local server is started in background using jetty in order to receive validation token once user has validated his identity.

Specified by:

getURL in interface IGoogleLogger

Returns:

OAuth URL.

Throws:

java.io.IOException - If any error occurs while creating URL or starting receiver server.

createLogger

public static IGoogleLogger createLogger(java.util.function.Consumer<Session> sessionConsumer)
                                  throws java.security.GeneralSecurityException,
                                         java.io.IOException

Creates and returns a valid IGoogleLogger instance.

Returns:

Created instance.

Throws:

java.security.GeneralSecurityException - If any error occurs while creating the HTTP transport.

java.io.IOException - If any error occurs while creating the HTTP transport, or reading the application secret.

getSecret

private static com.google.api.client.googleapis.auth.oauth2.GoogleClientSecrets getSecret()
                                                                                   throws java.io.IOException

Static tool method that retrieves google client secret instance from internal JSON file.

Returns:

GoogleClientSecrets instance created.

Throws:

java.io.IOException - If any error occurs while reading JSON file.