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

import java.util.Set;

/**
 * @since 1.3.0
 */
public interface MappingRule {

    /**
     * Returns the attribute name for a Social Provider or SAML Provider, that when encountered, should have its value
     * applied as Account field values.
     * When this name is encountered when processing UserInfo from a Social Provider or SAML Attribute Statement,
     * its associated value will be set as the value for all Stormpath Account field names specified in the
     * {@link #getAccountAttributes() accountAttributes} collection.
     *
     * @return attribute name, that when encountered, should have its value set on the
     * {@link #getAccountAttributes() specified} Account fields.
     */
    String getName();

    /**
     * Returns the Stormpath account fields that should be updated when encountering {@link #getName() named}
     * attribute name.  If discovered, that attribute value will be set on all of the Stormpath account
     * fields named in this collection.
     *
     * @return the Stormpath account fields that should be updated when encountering {@link #getName() named}
     * attribute name.
     */
    Set getAccountAttributes();
}