com.stormpath.sdk.saml.AttributeStatementMappingRule 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 2015 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.saml;

import com.stormpath.sdk.provider.MappingRule;

/**
 * A rule that indicates how a SAML Attribute Statement should populate one or more Stormpath Account field values.  By
 * creating rules, you configure which SAML Attribute values should be copied to Stormpath Account field values.
 * {@code AttributeStatementMappingRule}s are immutable.  If you want to change the mapping rules for Accounts in a
 * particular SAML Directory, you must remove and add new {@code AttributeStatementMappingRule} instances to the
 * Directory Provider's {@link AttributeStatementMappingRules} instance.
 *
 * 
How does it work?
 * Each {@code AttributeStatementMappingRule} has a {@code name} and a collection of Stormpath account
 * {@link #getAccountAttributes() attribute names}.
 * When a SAML Attribute Statement is encountered, every SAML Attribute with a matching name will have its value
 * copied to the corresponding specified Stormpath account fields.
 *
 * Example
 * For example, assume that a mapping rule's {@code name} is {@code foo}, and the rule's
 * {@link #getAccountAttributes() accountAttributes} collection contains the Stormpath Account field names
 * of {@code givenName} and {@code surname}.
 * If an Attribute Statement named {@code foo} is encountered on login to have a value of {@code bar}, then
 * {@code bar} will automatically be copied to the specified Stormpath Account fields for that user.  This user would
 * then automatically have a {@code givenName} of {@code bar} and a {@code surname} of {@code bar}.
 *
 * @since 1.0.RC8
 */
public interface AttributeStatementMappingRule extends MappingRule {

    /**
     * Returns the format for the SAML Attribute identified by {@link #getName() getName()}.
     *
     * @return SAML format for the SAML Attribute identified by {@link #getName() getName()}.
     */
    String getNameFormat();

}