1137 - refactor class hierachy to collate common code for mapping rules for SAML, social provider

Author: rbhojan

api/src/main/java/com/stormpath/sdk/provider/MappingRule.java

@@ -0,0 +1,31 @@
+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<String> getAccountAttributes();
+}

api/src/main/java/com/stormpath/sdk/provider/social/UserInfoMappingRule.java

@@ -1,6 +1,6 @@
 package com.stormpath.sdk.provider.social;
 
-import java.util.Set;
+import com.stormpath.sdk.provider.MappingRule;
 
 /**
  * A rule that indicates how a userInfo attribute from a Social Provider should populate one or more Stormpath Account field values.  By
@@ -25,27 +25,6 @@
  *
  * @since 1.3.0
  */
-public interface UserInfoMappingRule {
+public interface UserInfoMappingRule extends MappingRule {
 
-    /**
-     * Returns the UserInfo attribute name for a Social 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, its associated value will be set
-     * as the value for all Stormpath Account field names specified in the
-     * {@link #getAccountAttributes() accountAttributes} collection.
-     *
-     * @return UserInfo 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}
-     * UserInfo attribute name.  If discovered, that UserInfo 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}
-     * UserInfo attribute name.
-     */
-    Set<String> getAccountAttributes();
 }

api/src/main/java/com/stormpath/sdk/provider/social/UserInfoMappingRuleBuilder.java

@@ -15,7 +15,7 @@
 */
 package com.stormpath.sdk.provider.social;
 
-import java.util.Set;
+import com.stormpath.sdk.provider.MappingRuleBuilder;
 
 /**
  * A Builder to construct {@link UserInfoMappingRule} resources.
@@ -30,42 +30,6 @@
  *
  * @since 1.3.0
  */
-public interface UserInfoMappingRuleBuilder {
+public interface UserInfoMappingRuleBuilder extends MappingRuleBuilder {
 
-    /**
-     * Sets the UserInfo attribute name, that when encountered, should have its value applied as Account field values.
-     * When this name is encountered when processing UserInfo from a Social Provider, its associated value will be set as the
-     * value for all Stormpath Account field names specified in the
-     * {@link UserInfoMappingRule#getAccountAttributes() accountAttributes} collection.
-     *
-     * @param name the UserInfo attribute name that when encountered, should have its value applied as Account field values.
-     */
-    UserInfoMappingRuleBuilder setName(String name);
-
-    /**
-     * Sets the Stormpath account fields that should be updated when encountering {@link UserInfoMappingRule#getName() named}
-     * field from the userInfo provided by the social provider.  If discovered, that UserInfo attribute value will be set on
-     * all of the Stormpath account fields named in this collection.
-     *
-     * @param accountAttributes the account fields that should be updated when there's a match with a field name in userInfo
-     * provided by the social provider.
-     */
-    UserInfoMappingRuleBuilder setAccountAttributes(String... accountAttributes);
-
-    /**
-     * Sets the Stormpath account fields that should be updated when encountering {@link UserInfoMappingRule#getName() named}
-     * field from the userInfo provided by the social provider.  If discovered, that UserInfo attribute value will be set on
-     * all of the Stormpath account fields named in this collection.
-     *
-     * @param accountAttributes the account fields that should be updated when there's a match with a field name in userInfo
-     * provided by the social provider.
-     */
-    UserInfoMappingRuleBuilder setAccountAttributes(Set<String> accountAttributes);
-
-    /**
-     * Builds a new {@link UserInfoMappingRule} based on the current state of this builder.
-     *
-     * @return a new {@link UserInfoMappingRule} to be included in the {@link UserInfoMappingRules} for a Social Provider.
-     */
-    UserInfoMappingRule build();
 }

api/src/main/java/com/stormpath/sdk/saml/AttributeStatementMappingRule.java

@@ -15,7 +15,7 @@
 */
 package com.stormpath.sdk.saml;
 
-import java.util.Set;
+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
@@ -40,18 +40,7 @@
  *
  * @since 1.0.RC8
  */
-public interface AttributeStatementMappingRule {
-
-    /**
-     * Returns the SAML Attribute name, that when encountered, should have its value applied as Account field values.
-     * When this name is encountered when processing a 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 SAML Attribute name, that when encountered, should have its value set on the
-     * {@link #getAccountAttributes() specified} Account fields.
-     */
-    String getName();
+public interface AttributeStatementMappingRule extends MappingRule {
 
     /**
      * Returns the format for the SAML Attribute identified by {@link #getName() getName()}.
@@ -60,13 +49,4 @@ public interface AttributeStatementMappingRule {
      */
     String getNameFormat();
 
-    /**
-     * Returns the Stormpath account fields that should be updated when encountering {@link #getName() named}
-     * SAML Attribute name.  If discovered, that SAML 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}
-     * SAML Attribute name.
-     */
-    Set<String> getAccountAttributes();
 }

api/src/main/java/com/stormpath/sdk/saml/AttributeStatementMappingRuleBuilder.java

@@ -15,7 +15,7 @@
 */
 package com.stormpath.sdk.saml;
 
-import java.util.Set;
+import com.stormpath.sdk.provider.MappingRuleBuilder;
 
 /**
  * A Builder to construct {@link AttributeStatementMappingRule} resources.
@@ -30,17 +30,7 @@
  *
  * @since 1.0.RC8
  */
-public interface AttributeStatementMappingRuleBuilder {
-
-    /**
-     * Sets the SAML Attribute name, that when encountered, should have its value applied as Account field values.
-     * When this name is encountered when processing a SAML Attribute Statement, its associated value will be set as the
-     * value for all Stormpath Account field names specified in the
-     * {@link AttributeStatementMappingRule#getAccountAttributes() accountAttributes} collection.
-     *
-     * @param name the SAML Attribute name that when encountered, should have its value applied as Account field values.
-     */
-    AttributeStatementMappingRuleBuilder setName(String name);
+public interface AttributeStatementMappingRuleBuilder extends MappingRuleBuilder {
 
     /**
      * Sets the format for the SAML Attribute specified by {@link com.stormpath.sdk.saml.AttributeStatementMappingRule#getName() getName()}.
@@ -55,28 +45,4 @@ public interface AttributeStatementMappingRuleBuilder {
      */
     AttributeStatementMappingRuleBuilder setNameFormat(String nameFormat);
 
-    /**
-     * Sets the Stormpath account fields that should be updated when encountering {@link AttributeStatementMappingRule#getName() named}
-     * SAML Attribute name.  If discovered, that SAML Attribute value will be set on all of the Stormpath account
-     * fields named in this collection.
-     *
-     * @param accountAttributes the account fields that should be updated when there's a match with SAML Attribute name.
-     */
-    AttributeStatementMappingRuleBuilder setAccountAttributes(String... accountAttributes);
-
-    /**
-     * Sets the Stormpath account fields that should be updated when encountering {@link AttributeStatementMappingRule#getName() named}
-     * SAML Attribute name.  If discovered, that SAML Attribute value will be set on all of the Stormpath account
-     * fields named in this collection.
-     *
-     * @param accountAttributes the account fields that should be updated when there's a match with SAML Attribute name.
-     */
-    AttributeStatementMappingRuleBuilder setAccountAttributes(Set<String> accountAttributes);
-
-    /**
-     * Builds a new {@link AttributeStatementMappingRule} based on the current state of this builder.
-     *
-     * @return a new {@link AttributeStatementMappingRule} to be included in the {@link AttributeStatementMappingRules} for a Saml Provider.
-     */
-    AttributeStatementMappingRule build();
 }

impl/src/main/java/com/stormpath/sdk/impl/provider/AbstractMappingRuleBuilder.java

@@ -0,0 +1,47 @@
+package com.stormpath.sdk.impl.provider;
+
+import com.stormpath.sdk.lang.Assert;
+import com.stormpath.sdk.provider.MappingRule;
+import com.stormpath.sdk.provider.MappingRuleBuilder;
+
+import java.util.LinkedHashSet;
+import java.util.Set;
+
+/**
+ * @since 1.3.0
+ */
+public abstract class AbstractMappingRuleBuilder implements MappingRuleBuilder {
+
+    protected String name;
+    protected Set<String> accountAttributes;
+
+    @Override
+    public MappingRuleBuilder setName(String name) {
+        Assert.hasText(name, "name argument cannot be null or empty.");
+        this.name = name;
+        return this;
+    }
+
+    @Override
+    public MappingRuleBuilder setAccountAttributes(String... accountAttributes) {
+        Assert.notEmpty(accountAttributes, "accountAttributes cannot be null or empty.");
+
+        Set<String> names = new LinkedHashSet<String>(accountAttributes.length);
+        for (String attrName : accountAttributes) {
+            Assert.hasText("individual accountAttributes cannot be null or empty.");
+            names.add(attrName);
+        }
+        this.accountAttributes = names;
+        return this;
+    }
+
+    @Override
+    public MappingRuleBuilder setAccountAttributes(Set<String> accountAttributes) {
+        Assert.notEmpty(accountAttributes, "accountAttributes cannot be null or empty.");
+
+        this.accountAttributes = accountAttributes;
+        return this;
+    }
+
+    public abstract MappingRule build();
+}

impl/src/main/java/com/stormpath/sdk/impl/provider/social/DefaultUserInfoMappingRuleBuilder.java

@@ -15,47 +15,19 @@
 */
 package com.stormpath.sdk.impl.provider.social;
 
+import com.stormpath.sdk.impl.provider.AbstractMappingRuleBuilder;
 import com.stormpath.sdk.lang.Assert;
-import com.stormpath.sdk.provider.social.UserInfoMappingRule;
+import com.stormpath.sdk.provider.MappingRule;
 import com.stormpath.sdk.provider.social.UserInfoMappingRuleBuilder;
 
-import java.util.LinkedHashSet;
-import java.util.Set;
-
 /**
  * @since 1.3.0
  */
-public class DefaultUserInfoMappingRuleBuilder implements UserInfoMappingRuleBuilder {
-
-    private String name;
-    private Set<String> accountAttributes;
-
-    public UserInfoMappingRuleBuilder setName(String name){
-        Assert.hasText(name, "name argument cannot be null or empty.");
-        this.name = name;
-        return this;
-    }
-
-    public UserInfoMappingRuleBuilder setAccountAttributes(String... accountAttributes){
-        Assert.notEmpty(accountAttributes, "accountAttributes cannot be null or empty.");
-
-        Set<String> names = new LinkedHashSet<String>(accountAttributes.length);
-        for (String attrName : accountAttributes) {
-            Assert.hasText("individual accountAttributes cannot be null or empty.");
-            names.add(attrName);
-        }
-        this.accountAttributes = names;
-        return this;
-    }
+public class DefaultUserInfoMappingRuleBuilder extends AbstractMappingRuleBuilder implements UserInfoMappingRuleBuilder {
 
-    public UserInfoMappingRuleBuilder setAccountAttributes(Set<String> accountAttributes){
-        Assert.notEmpty(accountAttributes, "accountAttributes cannot be null or empty.");
-
-        this.accountAttributes = accountAttributes;
-        return this;
-    }
+    @Override
+    public MappingRule build() {
 
-    public UserInfoMappingRule build(){
         Assert.hasText(name, "name argument cannot be null or empty.");
         Assert.notEmpty(accountAttributes, "accountAttributes cannot be null or empty.");
 

impl/src/main/java/com/stormpath/sdk/impl/saml/DefaultAttributeStatementMappingRuleBuilder.java

@@ -15,55 +15,35 @@
 */
 package com.stormpath.sdk.impl.saml;
 
+import com.stormpath.sdk.impl.provider.AbstractMappingRuleBuilder;
 import com.stormpath.sdk.lang.Assert;
+import com.stormpath.sdk.provider.MappingRule;
 import com.stormpath.sdk.saml.AttributeStatementMappingRuleBuilder;
-import com.stormpath.sdk.saml.AttributeStatementMappingRule;
 
-import java.util.LinkedHashSet;
 import java.util.Set;
 
 /**
  * @since 1.0.RC8
  */
-public class DefaultAttributeStatementMappingRuleBuilder implements AttributeStatementMappingRuleBuilder {
+public class DefaultAttributeStatementMappingRuleBuilder extends AbstractMappingRuleBuilder implements AttributeStatementMappingRuleBuilder {
 
-    private String name;
-    private Set<String> accountAttributes;
     private String nameFormat;
 
-    public AttributeStatementMappingRuleBuilder setName(String name){
-        Assert.hasText(name, "name argument cannot be null or empty.");
-        this.name = name;
-        return this;
-    }
-
     @Override
     public AttributeStatementMappingRuleBuilder setNameFormat(String nameFormat) {
         Assert.hasText(nameFormat, "nameFormat argument cannot be null or empty.");
         this.nameFormat = nameFormat;
         return this;
     }
 
-    public AttributeStatementMappingRuleBuilder setAccountAttributes(String... accountAttributes){
-        Assert.notEmpty(accountAttributes, "accountAttributes cannot be null or empty.");
-
-        Set<String> names = new LinkedHashSet<String>(accountAttributes.length);
-        for (String attrName : accountAttributes) {
-            Assert.hasText("individual accountAttributes cannot be null or empty.");
-            names.add(attrName);
-        }
-        this.accountAttributes = names;
-        return this;
-    }
-
     public AttributeStatementMappingRuleBuilder setAccountAttributes(Set<String> accountAttributes){
         Assert.notEmpty(accountAttributes, "accountAttributes cannot be null or empty.");
 
         this.accountAttributes = accountAttributes;
         return this;
     }
 
-    public AttributeStatementMappingRule build(){
+    public MappingRule build(){
         Assert.hasText(name, "name argument cannot be null or empty.");
         Assert.notEmpty(accountAttributes, "accountAttributes cannot be null or empty.");