Merge branch '1.3.x' of github.com:stormpath/stormpath-sdk-java into 1158_handlers_fix_using_spring_security_in_front_stormpath

Author: Mario

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

@@ -15,6 +15,8 @@
  */
 package com.stormpath.sdk.provider;
 
+import com.stormpath.sdk.provider.social.UserInfoMappingRules;
+
 /**
  * A Builder to construct {@link CreateProviderRequest}s.
  *
@@ -41,6 +43,17 @@ public interface CreateProviderRequestBuilder<T extends CreateProviderRequestBui
      */
     T setClientSecret(String clientSecret);
 
+    /**
+     * set rules for mapping fields from userInfo provided by the social provider to Stormpath Account attributes
+     * for Accounts created in the associated Stormpath Directory.
+     *
+     * @param userInfoMappingRules rules for mapping fields from userInfo provided by the social provider to Stormpath
+     *                             Account attributes.
+     * @return the current builder instance for method chaining.
+     * @since 1.3.0
+     */
+    T setUserInfoMappingRules(UserInfoMappingRules userInfoMappingRules);
+
     /**
      * Creates a new {@code CreateProviderRequest} instance based on the current builder state.
      *

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

@@ -23,9 +23,9 @@
 public interface FacebookProviderData extends ProviderData {
 
     /**
-     * Getter for the Facebook authorization code.
+     * Getter for the Facebook access token.
      *
-     * @return the Facebook authorization code.
+     * @return the Facebook access token.
      */
     String getAccessToken();
 

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

@@ -23,9 +23,9 @@
 public interface GithubProviderData extends ProviderData {
 
     /**
-     * Getter for the Github authorization code.
+     * Getter for the Github access token.
      *
-     * @return the Github authorization code.
+     * @return the Github access token.
      */
     String getAccessToken();
 

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

@@ -23,9 +23,9 @@
 public interface LinkedInProviderData extends ProviderData {
 
     /**
-     * Getter for the LinkedIn authorization code.
+     * Getter for the LinkedIn access token.
      *
-     * @return the LinkedIn authorization code.
+     * @return the LinkedIn access token.
      */
     String getAccessToken();
 

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/MappingRuleBuilder.java

@@ -0,0 +1,51 @@
+package com.stormpath.sdk.provider;
+
+import com.stormpath.sdk.provider.social.UserInfoMappingRules;
+import com.stormpath.sdk.saml.SamlAttributeStatementMappingRules;
+
+import java.util.Set;
+
+/**
+ * @since 1.3.0
+ */
+public interface MappingRuleBuilder {
+
+    /**
+     * Sets the 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 or SAML Attribute Statement,
+     * its associated value will be set as the value for all Stormpath Account field names specified in the
+     * {@link MappingRule#getAccountAttributes() accountAttributes} collection.
+     *
+     * @param name the attribute name that when encountered, should have its value applied as Account field values.
+     */
+    MappingRuleBuilder setName(String name);
+
+    /**
+     * Sets the Stormpath account fields that should be updated when encountering {@link MappingRule#getName() named}
+     * field from the userInfo provided by the social provider or SAML Attribute Statement.
+     * If discovered, that 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 or SAML Attribute Statement.
+     */
+    MappingRuleBuilder setAccountAttributes(String... accountAttributes);
+
+    /**
+     * Sets the Stormpath account fields that should be updated when encountering {@link MappingRule#getName() named}
+     * field from the userInfo provided by the social provider.  If discovered, that 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 or SAML Attribute Statement.
+     */
+    MappingRuleBuilder setAccountAttributes(Set<String> accountAttributes);
+
+    /**
+     * Builds a new {@link MappingRule} based on the current state of this builder.
+     *
+     * @return a new {@link MappingRule} to be included in the {@link UserInfoMappingRules} for a Social Provider or
+     * the {@link SamlAttributeStatementMappingRules} SAML Provider.
+     */
+    MappingRule build();
+}

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

@@ -15,6 +15,8 @@
  */
 package com.stormpath.sdk.provider;
 
+import com.stormpath.sdk.provider.social.UserInfoMappingRules;
+
 import java.util.List;
 
 /**
@@ -42,4 +44,11 @@ public interface OAuthProvider extends Provider {
      * @since 1.2.0
      */
     List<String> getScope();
+
+    /**
+     * Returns the userInfoMappingRules configured for the oauth provider
+     * @return the userInfoMappingRules configured for the oauth provider
+     * @since 1.3.0
+     */
+    UserInfoMappingRules getUserInfoMappingRules();
 }

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

@@ -84,5 +84,14 @@ private Providers() {
      * @since 1.0.RC8
      */
     public static final SamlRequestFactory SAML = (SamlRequestFactory) Classes.newInstance("com.stormpath.sdk.impl.provider.saml.DefaultSamlRequestFactory");
+
+    /**
+     * Returns a new {@link TwitterRequestFactory} instance, used to construct Twitter requests, like Twitter Account creation and retrieval.
+     *
+     * @return a new {@link TwitterRequestFactory} instance, used to construct Twitter requests, like Twitter Account creation and retrieval.
+     * @since 1.3.0
+     */
+    public static final TwitterRequestFactory TWITTER = (TwitterRequestFactory) Classes.newInstance("com.stormpath.sdk.impl.provider.DefaultTwitterRequestFactory");
+
 }
 

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

@@ -0,0 +1,17 @@
+package com.stormpath.sdk.provider;
+
+/**
+ * Twitter's specific {@link ProviderAccountRequestBuilder} interface.
+ *
+ * @since 1.3.0
+ */
+public interface TwitterAccountRequestBuilder extends ProviderAccountRequestBuilder<TwitterAccountRequestBuilder> {
+
+    /**
+     * Setter for the Provider App access token.
+     *
+     * @param accessToken the Provider App access token.
+     * @return the builder instance for method chaining.
+     */
+    TwitterAccountRequestBuilder setAccessTokenSecret(String accessToken);
+}

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

@@ -0,0 +1,10 @@
+package com.stormpath.sdk.provider;
+
+/**
+ * Twitter's specific {@link CreateProviderRequestBuilder} interface.
+ *
+ * @since 1.3.0
+ */
+public interface TwitterCreateProviderRequestBuilder extends CreateProviderRequestBuilder<TwitterCreateProviderRequestBuilder> {
+
+}