com.amazonaws.auth.AWSIdentityProvider Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-core Show documentation

The AWS SDK for Java Mobile - Core module holds the classes that is used by the individual service clients to interact with Amazon Web Services. Users need to depend on aws-java-sdk artifact for accessing individual client classes.

There is a newer version: 2.6.19

Show newest version

/**
 * Copyright 2011-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * Licensed 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://aws.amazon.com/apache2.0
 *
 * This file 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 com.amazonaws.auth;

/**
 * A container of data pertinent to a single provider, and will handle most of
 * the interactions with said provider and the client. Note, this will only
 * implement token and identityId interactions. It should not be used for
 * implementing a custom IdentityProvider. Instead, extend
 * AbstractCognitoIdentityProvider.
 */
public interface AWSIdentityProvider {

    /**
     * Get the token from the relevant provider
     *
     * @return the token which was retrieved from the provider
     */
    public String getToken();

    /**
     * To be used to call the provider back end to get a token and identityId.
     * Once that has returned, a call to the superclass' update(String, Token)
     * method should be called
     *
     * @return token returns the token that was updated in the refresh
     */
    public String refresh();

}