review.classdesign.jammy.service

Interface IGoogleSessionService

All Known Implementing Classes:

GoogleSessionService

public interface IGoogleSessionService

This interface defines behavior of our Google Session service. Such service aims to manage HTTP client that are synchronized with a connected google account for accessing Google Services.

Author:

fv

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MESSAGE Message of the dialog displayed to notify user that connection is required.
static java.lang.String	TITLE Title of the dialog displayed to notify user that connection is required.

Method Summary

Modifier and Type	Method and Description
java.util.Optional<com.google.api.client.http.HttpRequestFactory>	createRequestFactory() Creates and returns a HttpRequestFactory using internal session.
static IGoogleSessionService	get() Static method that allows service instance quick access without dealing with the eclipse service APÏ.
void	login() Uses OAuth mechanism to create a persistent Google account session that will be used for interacting with google services.
void	logout() Destroy the current logged OAuth session.
static boolean	requireLogin() TODO : Optimizes method design.

Field Detail

TITLE

static final java.lang.String TITLE

Title of the dialog displayed to notify user that connection is required.

See Also:

Constant Field Values

MESSAGE

static final java.lang.String MESSAGE

Message of the dialog displayed to notify user that connection is required.

See Also:

Constant Field Values

Method Detail

login

void login()
    throws java.io.IOException,
           java.security.GeneralSecurityException

Uses OAuth mechanism to create a persistent Google account session that will be used for interacting with google services.

Throws:

java.io.IOException - If any error occurs while creating session.

java.security.GeneralSecurityException - If any error occurs during the OAuth phase.

logout

void logout()

Destroy the current logged OAuth session.

createRequestFactory

java.util.Optional<com.google.api.client.http.HttpRequestFactory> createRequestFactory()

Creates and returns a HttpRequestFactory using internal session.

Returns:

Created request factory.

Throws:

java.lang.IllegalStateException - If login step hasn't be performed before.

get

static IGoogleSessionService get()

Static method that allows service instance quick access without dealing with the eclipse service APÏ.

Returns:

Service instance.

requireLogin

static boolean requireLogin()

TODO : Optimizes method design.

Returns:

true if user is logged, false otherwise.