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


import com.stormpath.sdk.resource.Auditable;
import com.stormpath.sdk.resource.Resource;
import com.stormpath.sdk.resource.Saveable;

import java.util.List;

/**
 * A collection of rules that indicates how a userInfo attribute from a Social Provider should populate one or more
 * Stormpath Account field values.
 * By creating rules, you configure which userInfo attribute values from the Social Provider should be copied to the
 * Stormpath Account field values.
 *
 *  Also see {@link UserInfoMappingRule} 
 *
 * @since 1.3.0
 */
public interface UserInfoMappingRules extends Resource, Saveable, Auditable {

    /**
     * Specifies the Set of all {@link UserInfoMappingRule}s that indicate how UserInfo attribute should
     * populate one or more Stormpath Account field values after a successful Social (provider) login.
     *
     * @param userInfoMappingRules the set of {@link UserInfoMappingRule userInfoMappingRules}s to build a Social provider.
     *
     * @return this instance for method chaining.
     */
    void setItems(List userInfoMappingRules);

    /**
     * Returns the Set of all {@link UserInfoMappingRule}s that indicate how UserInfo attribute should
     * populate one or more Stormpath Account field values after a successful Social (provider) login.
     *
     * @return the Set of all {@link UserInfoMappingRule}s that indicate how UserInfo attribute should
     * populate one or more Stormpath Account field values after a successful Social (provider) login.
     */
    List getItems();
}