com.stormpath.sdk.oauth.IdSiteAuthenticator Maven / Gradle / Ivy

Go to download
/*
* Copyright 2015 Stormpath, Inc.
*
* 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://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 com.stormpath.sdk.oauth;

/**
 * Interface denoting an Id Site-specific {@link Oauth2Authenticator}. It is used to exchange Id Site credentials
 * for a valid OAuth 2.0 token. For example:
 *  * Application app = obtainApplication();
 *
 * IdSiteAuthenticationRequest exchangeRequest = Oauth2Requests.IDSITE_AUTHENTICATION_REQUEST.builder()
 *      .setToken(idSiteToken)
 *      .build();
 *
 * OauthGrantAuthenticationResult result = Authenticators.ID_SITE_AUTHENTICATOR
 *       .forApplication(app)
 *       .authenticate(exchangeRequest);
 * 
 *
 * @since 1.0.RC8.2
 */
public interface IdSiteAuthenticator extends Oauth2Authenticator {
}