com.stormpath.sdk.provider.CreateProviderRequestBuilder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of stormpath-sdk-api Show documentation

The Stormpath Java SDK API .jar provides a Java API that your code can use to make calls to the Stormpath API. This .jar is the only compile-time dependency within the Stormpath SDK project that your code should depend on. Implementations of this API (implementation .jars) should be runtime dependencies only.

The newest version!

/*
 * Copyright 2014 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.provider;

import com.stormpath.sdk.provider.social.UserInfoMappingRules;

/**
 * A Builder to construct {@link CreateProviderRequest}s.
 *
 * @see com.stormpath.sdk.provider.ProviderRequestFactory#builder()
 * @see com.stormpath.sdk.provider.Providers#FACEBOOK
 * @see com.stormpath.sdk.provider.Providers#GOOGLE
 * @since 1.0.beta
 */
public interface CreateProviderRequestBuilder {

    /**
     * Setter for the the App ID of your Provider application (e.g. for "google" it looks similar to "143482128708.apps.googleusercontent.com").
     *
     * @param clientId the App ID for your Provider application.
     * @return the builder instance for method chaining.
     */
    T setClientId(String clientId);

    /**
     * Setter for the the App Secret of your Provider application (e.g. for "google" it looks similar to "U-IdloztzwLn2_2M4QjpulPq").
     *
     * @param clientSecret the App Secret for your Provider application.
     * @return the current builder instance for method chaining.
     */
    T setClientSecret(String clientSecret);

    /**
     * set rules for mapping fields from userInfo provided by the social provider to Stormpath Account attributes
     * for Accounts created in the associated Stormpath Directory.
     *
     * @param userInfoMappingRules rules for mapping fields from userInfo provided by the social provider to Stormpath
     *                             Account attributes.
     * @return the current builder instance for method chaining.
     * @since 1.3.0
     */
    T setUserInfoMappingRules(UserInfoMappingRules userInfoMappingRules);

    /**
     * Creates a new {@code CreateProviderRequest} instance based on the current builder state.
     *
     * @return a new {@code CreateProviderRequest} instance based on the current builder state.
     */
    CreateProviderRequest build();
}