com.stormpath.sdk.provider.GenericOAuth2CreateProviderRequestBuilder 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!

package com.stormpath.sdk.provider;

/**
 * {@link CreateProviderRequestBuilder} interface for any Generic OAuth2 provider.
 *
 * @since 1.3.0
 */
public interface GenericOAuth2CreateProviderRequestBuilder extends CreateProviderRequestBuilder {

    /**
     * Setter for the authorizationEndpoint for the OAuth2 provider.
     *
     * @param authorizationEndpoint the authorizationEndpoint for the OAuth2 provider.
     * @return the builder instance for method chaining.
     */
    GenericOAuth2CreateProviderRequestBuilder setAuthorizationEndpoint(String authorizationEndpoint);

    /**
     * Setter for the tokenEndpoint for the OAuth2 provider.
     *
     * @param tokenEndpoint the tokenEndpoint for the OAuth2 provider.
     * @return the builder instance for method chaining.
     */
    GenericOAuth2CreateProviderRequestBuilder setTokenEndpoint(String tokenEndpoint);

    /**
     * Setter for the resourceEndpoint for the OAuth2 provider.
     *
     * @param resourceEndpoint the resourceEndpoint for the OAuth2 provider.
     * @return the builder instance for method chaining.
     */
    GenericOAuth2CreateProviderRequestBuilder setResourceEndpoint(String resourceEndpoint);

    /**
     * Setter for the accessTokenType for the OAuth2 provider.
     *
     * @param accessTokenType the accessTokenType for the OAuth2 provider.
     * @return the builder instance for method chaining.
     */
    GenericOAuth2CreateProviderRequestBuilder setAccessTokenType(AccessTokenType accessTokenType);

    /**
     * Setter for the provider id of the OAuth2 provider(e.g. "amazon").
     *
     * @param providerId the provider id of the OAuth2 provider.
     * @return the builder instance for method chaining.
     */
    GenericOAuth2CreateProviderRequestBuilder setClientId(String providerId);

    GenericOAuth2CreateProviderRequestBuilder setProviderId(String providerId);
}