org.apache.shindig.gadgets.oauth2.persistence.OAuth2Cache Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of shindig-gadgets Show documentation
Renders gadgets, provides the gadget metadata service, and serves all javascript required by the OpenSocial specification.
The newest version!
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements. See the NOTICE file distributed with this
 * work for additional information regarding copyright ownership. The ASF
 * licenses this file to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */
package org.apache.shindig.gadgets.oauth2.persistence;

import java.util.Collection;

import org.apache.shindig.gadgets.oauth2.OAuth2Accessor;
import org.apache.shindig.gadgets.oauth2.OAuth2Store;
import org.apache.shindig.gadgets.oauth2.OAuth2Token;

/**
 * Used by {@link OAuth2Store} to cache OAuth2 data.
 * 
 * Default implementation is in-memory HashMaps for shindig.
 * 
 */
public interface OAuth2Cache {
  /**
   * Clears all cached {@link OAuth2Client}s.
   * 
   * @throws OAuth2CacheException
   */
  void clearClients() throws OAuth2CacheException;

  /**
   * Clears all cached {@link OAuth2Token}s.
   * 
   * @throws OAuth2CacheException
   */
  void clearTokens() throws OAuth2CacheException;

  /**
   * Find an {@link OAuth2Client} by {@link Integer} index.
   * 
   * @param index
   * @return OAuth2Client
   */
  OAuth2Client getClient(Integer index);

  /**
   * Generate an {@link OAuth2Client} index for the given mapping.
   * 
   * @param gadgetUri
   * @param serviceName
   * @return client index
   */
  Integer getClientIndex(String gadgetUri, String serviceName);

  /**
   * Find an {@link OAuth2Accessor} by index.
   * 
   * @param index
   * @return OAuth2Accessor
   */
  OAuth2Accessor getOAuth2Accessor(Integer index);

  /**
   * Generate in index for an {@link OAuth2Accessor} by the given parameters.
   * 
   * @param gadgetUri
   * @param serviceName
   * @param user
   * @param scope
   * @return index for the OAuth2Accessor
   */
  Integer getOAuth2AccessorIndex(String gadgetUri, String serviceName, String user, String scope);

  /**
   * Find an {@link OAuth2Token} based on index
   * 
   * @param index
   * @return an OAuth2Token
   */
  OAuth2Token getToken(Integer index);

  /**
   * Returns the {@link Integer} index for the given {@link OAuth2Token}.
   * 
   * @param token
   * @return index of the OAuth2Token
   */
  Integer getTokenIndex(OAuth2Token token);

  /**
   * Generate index for {@link OAuth2Token} based on parameters
   * 
   * @param gadgetUri
   * @param serviceName
   * @param user
   * @param scope
   * @param type
   * @return index of OAuth2Token
   */
  Integer getTokenIndex(String gadgetUri, String serviceName, String user, String scope,
      OAuth2Token.Type type);

  /**
   * Removes the {@link OAuth2Client} from the cache.
   * 
   * @param index
   * @return the removed client, or null if none was found
   * @throws OAuth2CacheException
   */
  OAuth2Client removeClient(Integer index) throws OAuth2CacheException;

  /**
   * Removes the given {@link OAuth2Accessor} from the cache.
   * 
   * @param index
   * @return the removed {@link OAuth2Accessor} or null if none was
   *         found
   */
  OAuth2Accessor removeOAuth2Accessor(Integer index);

  /**
   * Removes the given {@link OAuth2Token} from the cache.
   * 
   * @param index
   * @return the removed {@link OAuth2Token} or null if none was
   *         found
   * @throws OAuth2CacheException
   */
  OAuth2Token removeToken(Integer index) throws OAuth2CacheException;

  /**
   * Stores the given client.
   * 
   * @param index
   * @param client
   * @throws OAuth2CacheException
   */
  Integer storeClient(OAuth2Client client) throws OAuth2CacheException;

  /**
   * Store all clients in the collection.
   * 
   * @param clients
   * @throws OAuth2CacheException
   */
  void storeClients(Collection clients) throws OAuth2CacheException;

  /**
   * Stores the given accessor.
   * 
   * @param accessor
   */
  Integer storeOAuth2Accessor(OAuth2Accessor accessor);

  /**
   * Stores the given token and returns it's index.
   */
  Integer storeToken(OAuth2Token token) throws OAuth2CacheException;

  /**
   * Stores all tokens in the collection.
   * 
   * @param tokens
   * @throws OAuth2CacheException
   */
  void storeTokens(Collection tokens) throws OAuth2CacheException;
}