com.google.identitytoolkit

Class GitkitClient

java.lang.Object

com.google.identitytoolkit.GitkitClient

public class GitkitClient
extends Object

Google Identity Toolkit client library. This class is the only interface that third party developers needs to know to integrate Gitkit with their backend server. Main features are Gitkit token verification and Gitkit remote API wrapper.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GitkitClient.Builder Builder class to construct Gitkit client instance.
static class	GitkitClient.OobAction Gitkit out-of-band actions.
class	GitkitClient.OobResponse Wrapper class containing the out-of-band responses.

Constructor Summary

Constructors

Constructor and Description
GitkitClient(String clientId, String serviceAccountEmail, InputStream keyStream, String widgetUrl, String cookieName, HttpSender httpSender, String serverApiKey) Constructs a Gitkit client.

Method Summary

Methods

Modifier and Type	Method and Description
static GitkitClient	createFromJson(String configPath) Constructs a Gitkit client from a JSON config file
void	deleteUser(GitkitUser user) Deletes a user account at Gitkit server.
void	deleteUser(String localId) Deletes a user account at Gitkit server.
Iterator<GitkitUser>	getAllUsers() Gets all user info of this web site.
Iterator<GitkitUser>	getAllUsers(Integer resultsPerRequest) Gets all user info of this web site.
GitkitClient.OobResponse	getOobResponse(javax.servlet.http.HttpServletRequest req) Gets out-of-band response.
GitkitClient.OobResponse	getOobResponse(javax.servlet.http.HttpServletRequest req, String gitkitToken) Gets out-of-band response.
GitkitUser	getUserByEmail(String email) Gets user info given an email.
GitkitUser	getUserByLocalId(String localId) Gets user info given a user id.
GitkitUser	getUserByToken(String token) Gets user info from GITkit service using Gitkit token.
static GitkitClient.Builder	newBuilder()
GitkitUser	updateUser(GitkitUser user) Updates a user info at Gitkit server.
void	uploadUsers(String hashAlgorithm, byte[] hashKey, List<GitkitUser> users) Uploads multiple user accounts to Gitkit server.
GitkitUser	validateToken(String token) Verifies a Gitkit token.
GitkitUser	validateTokenInRequest(javax.servlet.http.HttpServletRequest request) Verifies Gitkit token in http request.

Methods inherited from class java.lang.Object

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

Constructor Detail

GitkitClient

public GitkitClient(String clientId,
            String serviceAccountEmail,
            InputStream keyStream,
            String widgetUrl,
            String cookieName,
            HttpSender httpSender,
            String serverApiKey)

Constructs a Gitkit client.

Parameters:

clientId - Google oauth2 web application client id. Audience in Gitkit token must match this client id.

serviceAccountEmail - Google service account email.

keyStream - Google service account private p12 key stream.

widgetUrl - Url of the Gitkit widget, must starting with /.

cookieName - Gitkit cookie name. Used to extract Gitkit token from incoming http request.

httpSender - Concrete http sender when Gitkit client needs to call Gitkit remote API.

serverApiKey - Server side API key in Google Developer Console.

Method Detail

createFromJson

public static GitkitClient createFromJson(String configPath)
                                   throws org.json.JSONException,
                                          IOException

Constructs a Gitkit client from a JSON config file

Parameters:

configPath - Path to JSON configuration file

Returns:

Gitkit client

Throws:

org.json.JSONException

IOException

validateToken

public GitkitUser validateToken(String token)
                         throws GitkitClientException

Verifies a Gitkit token.

Parameters:

token - token string to be verified.

Returns:

Gitkit user if token is valid.

Throws:

GitkitClientException - if token has invalid signature

validateTokenInRequest

public GitkitUser validateTokenInRequest(javax.servlet.http.HttpServletRequest request)
                                  throws GitkitClientException

Verifies Gitkit token in http request.

Parameters:

request - http request

Returns:

Gitkit user if valid token is found in the request.

Throws:

GitkitClientException - if there is token but signature is invalid

getUserByToken

public GitkitUser getUserByToken(String token)
                          throws GitkitClientException,
                                 GitkitServerException

Gets user info from GITkit service using Gitkit token. Can be used to verify a Gitkit token remotely.

Parameters:

token - the gitkit token.

Returns:

Gitkit user info if token is valid.

Throws:

GitkitClientException - if request is invalid

GitkitServerException - for Gitkit server error

getUserByEmail

public GitkitUser getUserByEmail(String email)
                          throws GitkitClientException,
                                 GitkitServerException

Gets user info given an email.

Parameters:

email - user email.

Returns:

Gitkit user info.

Throws:

GitkitClientException - if request is invalid

GitkitServerException - for Gitkit server error

getUserByLocalId

public GitkitUser getUserByLocalId(String localId)
                            throws GitkitClientException,
                                   GitkitServerException

Gets user info given a user id.

Parameters:

localId - user identifier at Gitkit.

Returns:

Gitkit user info.

Throws:

GitkitClientException - if request is invalid

GitkitServerException - for Gitkit server error

getAllUsers

public Iterator<GitkitUser> getAllUsers()

Gets all user info of this web site. Underlying requests are send with default pagination size.

Returns:

lazy iterator over all user accounts.

getAllUsers

public Iterator<GitkitUser> getAllUsers(Integer resultsPerRequest)

Gets all user info of this web site. Underlying requests are paginated and send on demand with given size.

Parameters:

resultsPerRequest - pagination size

Returns:

lazy iterator over all user accounts.

updateUser

public GitkitUser updateUser(GitkitUser user)
                      throws GitkitClientException,
                             GitkitServerException

Updates a user info at Gitkit server.

Parameters:

user - user info to be updated.

Returns:

the updated user info

Throws:

GitkitClientException - for invalid request

GitkitServerException - for server error

uploadUsers

public void uploadUsers(String hashAlgorithm,
               byte[] hashKey,
               List<GitkitUser> users)
                 throws GitkitServerException,
                        GitkitClientException

Uploads multiple user accounts to Gitkit server.

Parameters:

hashAlgorithm - hash algorithm. Supported values are HMAC_SHA256, HMAC_SHA1, HMAC_MD5, PBKDF_SHA1, MD5 and SCRYPT.

hashKey - key of hash algorithm

users - list of user accounts to be uploaded

Throws:

GitkitClientException - for invalid request

GitkitServerException - for server error

deleteUser

public void deleteUser(GitkitUser user)
                throws GitkitServerException,
                       GitkitClientException

Deletes a user account at Gitkit server.

Parameters:

user - user to be deleted.

Throws:

GitkitClientException - for invalid request

GitkitServerException - for server error

deleteUser

public void deleteUser(String localId)
                throws GitkitServerException,
                       GitkitClientException

Deletes a user account at Gitkit server.

Parameters:

localId - user id to be deleted.

Throws:

GitkitClientException - for invalid request

GitkitServerException - for server error

getOobResponse

public GitkitClient.OobResponse getOobResponse(javax.servlet.http.HttpServletRequest req)
                                        throws GitkitServerException

Gets out-of-band response. Used by oob endpoint for ResetPassword and ChangeEmail operation. The web site needs to send user an email containing the oobUrl in the response. The user needs to click the oobUrl to finish the operation.

Parameters:

req - http request for the oob endpoint

Returns:

the oob response.

Throws:

GitkitServerException

getOobResponse

public GitkitClient.OobResponse getOobResponse(javax.servlet.http.HttpServletRequest req,
                                      String gitkitToken)
                                        throws GitkitServerException

Gets out-of-band response. Used by oob endpoint for ResetPassword and ChangeEmail operation. The web site needs to send user an email containing the oobUrl in the response. The user needs to click the oobUrl to finish the operation.

Parameters:

req - http request for the oob endpoint

gitkitToken - Gitkit token of authenticated user, required for ChangeEmail operation

Returns:

the oob response.

Throws:

GitkitServerException

newBuilder

public static GitkitClient.Builder newBuilder()