com.google.auth.oauth2.TokenStore Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of google-auth-library-oauth2-http Show documentation

There is a newer version: 1.33.1

Show newest version

/*
 * Copyright 2015, Google Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 *    * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *    * Redistributions in binary form must reproduce the above
 * copyright notice, this list of conditions and the following disclaimer
 * in the documentation and/or other materials provided with the
 * distribution.
 *
 *    * Neither the name of Google Inc. nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

package com.google.auth.oauth2;

import java.io.IOException;

/** Interface for long term storage of tokens */
public interface TokenStore {

  /**
   * Load the token data from storage for the given ID.
   *
   * @param id ID of token data to load.
   * @return The loaded token data.
   * @throws IOException An error loading the token data from storage.
   */
  String load(String id) throws IOException;

  /**
   * Put the token data into storage for the given ID.
   *
   * @param id ID of token data to store.
   * @param tokens The token data to store.
   * @throws IOException An error storing the token data.
   */
  void store(String id, String tokens) throws IOException;

  /**
   * Remove the token data from storage for the given ID.
   *
   * @param id ID of token data to store.
   * @throws IOException An error storing the token data.
   */
  void delete(String id) throws IOException;
}