com.stormpath.sdk.impl.provider.AbstractProviderAccountRequestBuilder Maven / Gradle / Ivy

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

The Stormpath Java SDK core implemenation .jar is used at runtime to support API invocations. This implementation jar should be a runtime dependency only and should NOT be depended on at compile time by your code. The implementations within this jar can change at any time without warning - use it with runtime scope only.

There is a newer version: 2.0.4-okta

Show 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.impl.provider;

import com.stormpath.sdk.lang.Assert;
import com.stormpath.sdk.lang.Strings;
import com.stormpath.sdk.provider.ProviderAccountRequest;
import com.stormpath.sdk.provider.ProviderAccountRequestBuilder;

import java.util.Collections;
import java.util.LinkedHashMap;
import java.util.Map;

/**
 * Abstract class that each Provider-specific {@link ProviderAccountRequestBuilder} can extend to facilitate its work.
 *
 * @since 1.0.beta
 */
@SuppressWarnings("unchecked")
public abstract class AbstractProviderAccountRequestBuilder> implements ProviderAccountRequestBuilder {

    protected String accessToken;
    protected String code;
    protected String redirectUri;

    @Override
    public T setAccessToken(String accessToken) {
        this.accessToken = accessToken;
        return (T) this;
    }

    @Override
    public T setCode(String code) {
        this.code = code;
        return (T) this;
    }

    @Override
    public T setRedirectUri(String redirectUri) {
        this.redirectUri = redirectUri;
        return (T) this;
    }

    @Override
    public ProviderAccountRequest build() {
        final String providerId = getConcreteProviderId();
        Assert.state(Strings.hasText(providerId), "The providerId property is missing.");

        Map properties = new LinkedHashMap<>();
        properties.put("providerId", providerId);

        return doBuild(Collections.unmodifiableMap(properties));
    }

    /**
     * Abstract method to force subclass not to forget to provide the Stormpath ID for the provider.
     *
     * @return the Stormpath ID for the specific Provider the subclass represents.
     */
    protected abstract String getConcreteProviderId();

    /**
     * Hook method to give Provider-specific subclasses the responsibility to construct the {@link ProviderAccountRequest} with
     * their own properties.
     *
     * @param map Provider-wide properties that each Provider will need in order to construct the {@link ProviderAccountRequest}
     * @return the actual request each Provider-specific Builder constructs based on the set properties.
     */
    protected abstract ProviderAccountRequest doBuild(Map map);

}