Merge branch '1.3.x' into AM-3581-social-login-v2

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

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

@@ -0,0 +1,82 @@
+package com.stormpath.sdk.saml;
+
+import com.stormpath.sdk.resource.Resource;
+
+/**
+ * An AuthnVerificationRequest encapsulates the fields of a SAML AuthnRequest targeted
+ * against a particular Stormpath Application.
+ *
+ * @since 1.3.0
+ */
+public interface AuthnVerificationRequest extends Resource {
+
+    /**
+     * Returns the value of the SAMLRequest parameter provided with the incoming AuthnRequest.
+     *
+     * @return the value of the SAMLRequest parameter provided with the incoming AuthnRequest.
+     */
+    String getSamlRequest();
+
+    /**
+     * Sets the value of the SAMLRequest parameter provided with the incoming AuthnRequest.
+     *
+     * @param samlRequest the value of the SAMLRequest parameter from the incoming AuthnRequest.
+     * @return this instance for method chaining.
+     */
+    AuthnVerificationRequest setSamlRequest(String samlRequest);
+
+    /**
+     * Returns the value of the RelayState parameter provided with the incoming AuthnRequest.
+     *
+     * @return the value of the RelayState parameter provided with the incoming AuthnRequest.
+     */
+    String getRelayState();
+
+    /**
+     * Sets the value of the RelayState parameter provided with the incoming AuthnRequest.
+     *
+     * @param relayState the value of the RelayState parameter from the incoming AuthnRequest.
+     * @return this instance for method chaining.
+     */
+    AuthnVerificationRequest setRelayState(String relayState);
+
+    /**
+     * Returns the value of the SigAlg parameter provided with the incoming AuthnRequest.
+     *
+     * @return the value of the SigAlg parameter provided with the incoming AuthnRequest.
+     */
+    String getSigAlg();
+
+    /**
+     * Sets the value of the SigAlg parameter provided with the incoming AuthnRequest.
+     *
+     * @param sigAlg the value of the SigAlg parameter from the incoming AuthnRequest.
+     * @return this instance for method chaining.
+     */
+    AuthnVerificationRequest setSigAlg(String sigAlg);
+
+    /**
+     * Returns the value of the Signature parameter provided with the incoming AuthnRequest.
+     *
+     * @return the value of the Signature parameter provided with the incoming AuthnRequest.
+     */
+    String getSignature();
+
+    /**
+     * Sets the value of the Signature parameter provided with the incoming AuthnRequest.
+     *
+     * @param signature the value of the Signature parameter from the incoming AuthnRequest.
+     * @return this instance for method chaining.
+     */
+    AuthnVerificationRequest setSignature(String signature);
+
+    /**
+     * When the AuthnRequest is submitted via HTTP GET, returns the query string of the incoming request.
+     * Otherwise null.
+     *
+     * @return the query string of the incoming AuthnRequest, or null if the AuthnRequest was submitted with HTTP POST.
+     */
+    String getQueryString();
+
+    AuthnVerificationRequest setQueryString(String queryString);
+}

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

@@ -0,0 +1,48 @@
+/*
+ * Copyright 2016 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;
+
+
+/**
+ * Represents an attempt to create a new {@link RegisteredSamlServiceProvider} record in Stormpath.
+ *
+ * @see com.stormpath.sdk.tenant.Tenant#createRegisterdSamlServiceProvider(RegisteredSamlServiceProvider)
+ * @since 1.3.0
+ */
+public interface CreateRegisteredSamlServiceProviderRequest {
+
+    /**
+     * Returns the RegisteredSamlServiceProvider instance for which a new record will be created in Stormpath.
+     *
+     * @return the RegisteredSamlServiceProvider instance for which a new record will be created in Stormpath.
+     */
+    RegisteredSamlServiceProvider getRegisteredSamlServiceProvider();
+
+    /**
+     * Returns true in case RegisteredSamlServiceProvider has options.
+     *
+     * @return true in case RegisteredSamlServiceProvider has options.
+     */
+    boolean hasRegisteredSamlServiceProviderOptions();
+
+    /**
+     * Returns the {@link RegisteredSamlServiceProviderOptions}.
+     *
+     * @return  {@link RegisteredSamlServiceProviderOptions}.
+     */
+    RegisteredSamlServiceProviderOptions getRegisteredSamlServiceProviderOptions() throws IllegalStateException;
+
+}

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

@@ -0,0 +1,42 @@
+/*
+ * Copyright 2016 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;
+
+/**
+ * A Builder to construct {@link CreateRegisteredSamlServiceProviderRequest}s.
+ *
+ * @see com.stormpath.sdk.tenant.Tenant#createRegisterdSamlServiceProvider(RegisteredSamlServiceProvider)
+ * @since 1.3.0
+ */
+public interface CreateRegisteredSamlServiceProviderRequestBuilder {
+
+    /**
+     * Ensures that after a RegisteredSamlServiceProvider is created, the creation response is retrieved with the specified registeredSamlServiceProvider's
+     * options. This enhances performance by leveraging a single request to retrieve multiple related
+     * resources you know you will use.
+     *
+     * @return the builder instance for method chaining.
+     * @throws IllegalArgumentException if {@code options} is null.
+     */
+    CreateRegisteredSamlServiceProviderRequestBuilder withResponseOptions(RegisteredSamlServiceProviderOptions options) throws IllegalArgumentException;
+
+    /**
+     * Creates a new {@code CreateRegisteredSamlServiceProviderRequest} instance based on the current builder state.
+     *
+     * @return a new {@code CreateRegisteredSamlServiceProviderRequest} instance based on the current builder state.
+     */
+    CreateRegisteredSamlServiceProviderRequest build();
+}

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

@@ -0,0 +1,78 @@
+package com.stormpath.sdk.saml;
+
+import com.stormpath.sdk.account.Account;
+import com.stormpath.sdk.resource.Resource;
+
+import java.util.Date;
+
+/**
+ * A SamlResponseRequest encapsulates the information needed to prepare a SAML response according to the SAML specification.
+ *
+ * @since 1.3.0
+ */
+public interface CreateSamlResponseRequest extends Resource {
+
+    /**
+     * Returns the {@link Account} to be represented in this SAML response.
+     *
+     * @return the {@link Account} to be represented in this SAML response.
+     */
+    Account getAccount();
+
+    /**
+     * Sets the {@link Account} to be represented in this SAML response.
+     *
+     * @param account the {@link Account} to be represented in this SAML response.
+     * @return this instance for method chaining.
+     */
+    CreateSamlResponseRequest setAccount(Account account);
+
+    /**
+     * Returns the {@link RegisteredSamlServiceProvider} to be represented in this SAML response.
+     *
+     * @return the {@link RegisteredSamlServiceProvider} to be represented in this SAML response.
+     */
+    RegisteredSamlServiceProvider getServiceProvider();
+
+    /**
+     * Sets the {@link RegisteredSamlServiceProvider} to be represented in this SAML response.
+     *
+     * @param serviceProvider the {@link RegisteredSamlServiceProvider} to be represented in this SAML response.
+     * @return this instance for method chaining.
+     */
+    CreateSamlResponseRequest setServiceProvider(RegisteredSamlServiceProvider serviceProvider);
+
+    /**
+     * Returns the request ID to be represented in this SAML response, which should match the request ID
+     * that was provided in the initiating SAML AuthnRequest.
+     *
+     * @return the request ID to be represented in this SAML response.
+     */
+    String getRequestId();
+
+    /**
+     * Sets the request ID to be represented in this SAML response, which should match the request ID
+     * that was provided in the initiating SAML AuthnRequest.
+     *
+     * @param requestId the request ID to be represented in this SAML response.
+     * @return this instance for method chaining.
+     */
+    CreateSamlResponseRequest setRequestId(String requestId);
+
+    /**
+     * Returns the issue instant to be represented in this SAML response, which should match the issue instant
+     * that was provided in the initiating SAML AuthnRequest.
+     *
+     * @return the issue instant to be represented in this SAML response.
+     */
+    Date getAuthnIssueInstant();
+
+    /**
+     * Sets the issue instant to be represented in this SAML response, which should match the issue instant
+     * that was provided in the initiating SAML AuthnRequest.
+     *
+     * @param authnIssueInstant the issue instant to be represented in this SAML response.
+     * @return this instance for method chaining.
+     */
+    CreateSamlResponseRequest setAuthnIssueInstant(Date authnIssueInstant);
+}