Merge branch 'AM-3581-social-login-v2' into issue-1140-twitter

Author: rbhojan

api/src/main/java/com/stormpath/sdk/application/ApplicationOptions.java

@@ -79,4 +79,14 @@ public interface ApplicationOptions<T> extends AccountStoreOptions<T> {
      * @since 1.0.0
      */
     T withWebConfig();
+
+    /**
+     * Ensures that when retrieving an Application, the Application's {@link Application#getSamlPolicy() samlPolicy}
+     * is also retrieved in the same request. This enhances performance by leveraging a single request to retrieve multiple
+     * related resources you know you will use.
+     *
+     * @return this instance for method chaining.
+     * @since 1.3.0
+     */
+    T withSamlPolicy();
 }

api/src/main/java/com/stormpath/sdk/phone/Phone.java

@@ -52,7 +52,7 @@ public interface Phone extends Resource, Saveable, Deletable, Auditable {
 
     /**
      * Sets the phone's name.
-     * @param name he phone's name.
+     * @param name the phone's name.
      *
      * @return this instance for method chaining.
      */
@@ -67,7 +67,7 @@ public interface Phone extends Resource, Saveable, Deletable, Auditable {
 
     /**
      * Sets the phone's description.
-     * @param description he phone's description.
+     * @param description the phone's description.
      *
      * @return this instance for method chaining.
      */

api/src/main/java/com/stormpath/sdk/phone/Phones.java

@@ -229,7 +229,7 @@ public static EqualsExpressionFactory verificationStatus() {
      * Phones.where(<b>Phones.createdAt()</b>.matches("[,2014-04-05T12:00:00]");
      * </pre>
      * The above example invokes the returned factory's <code>matches("[,2014-04-05T12:00:00]"))</code> method.  This
-     * produces a name-specific {@link Criterion} which is added to the criteria query (via the
+     * produces a createdAt-specific {@link Criterion} which is added to the criteria query (via the
      * {@link #where(Criterion) where} method).
      * <pre>
      * For example, the following code is equivalent:
@@ -254,7 +254,7 @@ public static DateExpressionFactory createdAt(){
      * Phones.where(<b>Phones.modifiedAt()</b>.matches("[,2014-04-05T12:00:00]");
      * </pre>
      * The above example invokes the returned factory's <code>matches("[,2014-04-05T12:00:00]"))</code> method.  This
-     * produces a name-specific {@link Criterion} which is added to the criteria query (via the
+     * produces a modifiedAt-specific {@link Criterion} which is added to the criteria query (via the
      * {@link #where(Criterion) where} method).
      * <pre>
      * For example, the following code is equivalent:
@@ -279,12 +279,12 @@ private static DateExpressionFactory newDateExpressionFactory(String propName) {
     }
 
     /**
-     * Creates a new {@link com.stormpath.sdk.phone.CreatePhoneRequestBuilder CreatePhoneRequestBuilder}
+     * Creates a new {@link com.stormpath.sdk.phone.CreatePhoneRequestBuilder createPhoneRequestBuilder}
      * instance reflecting the specified {@link com.stormpath.sdk.phone.Phone} instance. The builder can be used to customize any
      * creation request options as necessary.
      *
      * @param phone the phone to create a new record for within Stormpath
-     * @return a new {@link com.stormpath.sdk.phone.CreatePhoneRequestBuilder CreatePhoneRequestBuilder}
+     * @return a new {@link com.stormpath.sdk.phone.CreatePhoneRequestBuilder createPhoneRequestBuilder}
      *         instance reflecting the specified {@link com.stormpath.sdk.phone.Phone} instance.
      ** @see com.stormpath.sdk.account.Account#createPhone(CreatePhoneRequest)
      *

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();
 }

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

@@ -15,9 +15,10 @@
 */
 package com.stormpath.sdk.saml;
 
+import com.stormpath.sdk.resource.Deletable;
 import com.stormpath.sdk.resource.Resource;
+import com.stormpath.sdk.resource.Saveable;
 
-import java.util.Collection;
 import java.util.Set;
 
 /**
@@ -31,7 +32,7 @@
  *
  * @since 1.0.RC8
  */
-public interface AttributeStatementMappingRules extends Resource, Set<AttributeStatementMappingRule> {
+public interface AttributeStatementMappingRules extends Resource, Set<AttributeStatementMappingRule>, Saveable, Deletable{
 
     /**
      * Removes the {@link AttributeStatementMappingRule}(s) identified by {@code ruleNames}.

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

@@ -0,0 +1,46 @@
+package com.stormpath.sdk.saml;
+
+import com.stormpath.sdk.application.Application;
+import com.stormpath.sdk.resource.Resource;
+
+import java.util.Date;
+
+/**
+ * An AuthnVerification represents the successful results of verifying the signature of a SAML AuthnRequest targeted
+ * against a particular Stormpath {@link Application}.
+ *
+ * @since 1.3.0
+ */
+public interface AuthnVerification extends Resource {
+
+    /**
+     * Returns the relay state provided with the original SAML AuthnRequest, if any was provided.  Otherwise the default
+     * relay state configured for the {@link Application}.
+     *
+     * @return the relay state associated with the SAML AuthnRequest.
+     */
+    String getRelayState();
+
+    /**
+     * Returns the {@link RegisteredSamlServiceProvider} associated with the entityId of the original AuthnRequest.
+     *
+     * @return the {@link RegisteredSamlServiceProvider} associated with the entityId of the original AuthnRequest.
+     */
+    RegisteredSamlServiceProvider getServiceProvider();
+
+
+    /**
+     * Returns the request ID provided with the original SAML AuthnRequest.
+     *
+     * @return the request ID provided with the original SAML AuthnRequest.
+     */
+    String getRequestId();
+
+
+    /**
+     * Returns the issue instant of the original SAML AuthnRequest.
+     *
+     * @return the issue instant of the original SAML AuthnRequest.
+     */
+    Date getAuthnIssueInstant();
+}