com.stormpath.sdk.provider.ProviderAccountRequestBuilder 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;

/**
 * A Builder to construct {@link ProviderAccountRequest}s.
 *
 * @param  the specific builder class (e.g {@link FacebookAccountRequestBuilder} or {@link GoogleAccountRequestBuilder}.
 * @since 1.0.beta
 */
public interface ProviderAccountRequestBuilder> {

    /**
     * Setter for the Provider App access token.
     *
     * @param accessToken the Provider App access token.
     * @return the builder instance for method chaining.
     */
    T setAccessToken(String accessToken);

    /**
     * Setter for the Provider App authorization code.
     *
     * @param code the Provider App authorization code.
     * @return the builder instance for method chaining.
     * @since 1.2.0
     */
    T setCode(String code);

    /**
     * Setter for the uri to use when validating the authorization code.
     *
     * @param redirectUri the uri to use when validating the authorization code.
     * @return the builder instance for method chaining.
     * @since 1.2.0
     */
    T setRedirectUri(String redirectUri);

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

}