Merge branch 'master' 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/lang/Instants.java

@@ -15,6 +15,7 @@
 */
 package com.stormpath.sdk.lang;
 
+import java.text.SimpleDateFormat;
 import java.util.Calendar;
 import java.util.Date;
 import java.util.GregorianCalendar;
@@ -29,10 +30,34 @@ public class Instants {
 
     public static final TimeZone UTC_TIMEZONE = TimeZone.getTimeZone("UTC");
 
+    /**
+     * @since 1.3.0
+     */
+    private static final ThreadLocal<SimpleDateFormat> DATE_FORMAT = new ThreadLocal<SimpleDateFormat>() {
+        @Override
+        protected SimpleDateFormat initialValue() {
+            SimpleDateFormat df = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss.SSS'Z'");
+            df.setTimeZone(UTC_TIMEZONE);
+            return df;
+        }
+    };
+
+    /**
+     * Returns the UTC-normalized ISO 8601 representation of the specified date instance.
+     *
+     * @param date the date to format.
+     * @return the UTC-normalized ISO 8601 representation of the specified date instance.
+     * @since 1.3.0
+     */
+    public static String toUtcIso8601(Date date) {
+        return DATE_FORMAT.get().format(date);
+    }
+
     /**
      * Converts a given time from UTC (Coordinated Universal Time) to the corresponding time in the specified {@link TimeZone}
+     *
      * @param time the UTC instant to convert, represented as the number of milliseconds that have elapsed since midnight, January 1, 1970
-     * @param to the target {@link TimeZone} for the conversion
+     * @param to   the target {@link TimeZone} for the conversion
      * @return the long representation of the instant converted to the specified {@link TimeZone}
      */
     public static long convertDateToLocalTime(long time, TimeZone to) {
@@ -41,6 +66,7 @@ public static long convertDateToLocalTime(long time, TimeZone to) {
 
     /**
      * Converts a given time from the specified {@link TimeZone} to the corresponding UTC (Coordinated Universal Time) time
+     *
      * @param time the instant to convert, represented as the number of milliseconds that have elapsed since midnight, January 1, 1970
      * @param from the original {@link TimeZone}
      * @return the UTC instant, represented as the number of milliseconds that have elapsed since midnight, January 1, 1970
@@ -51,9 +77,10 @@ public static long convertDateToUTC(long time, TimeZone from) {
 
     /**
      * Converts a given time from a {@link TimeZone} to another
+     *
      * @param time the instant to convert, represented as the number of milliseconds that have elapsed since midnight, January 1, 1970 in the {@code from} {@link TimeZone}
      * @param from the original {@link TimeZone}
-     * @param to the target {@link TimeZone} for the conversion
+     * @param to   the target {@link TimeZone} for the conversion
      * @return the long representation of the instant converted to the specified {@code to} {@link TimeZone}
      */
     public static long convertDate(long time, TimeZone from, TimeZone to) {
@@ -64,10 +91,10 @@ public static long convertDate(long time, TimeZone from, TimeZone to) {
      * Creates an UTC-based {@Link Date} using the provided {@code year}.
      * Uses the current date and time, sets the specified {@code year} and returns the Date converted to a UTC timestamp.
      *
-     * @param year  the year to represent
+     * @param year the year to represent
      * @return the UTC-based {@link Date}
      */
-    public static Date of(int year){
+    public static Date of(int year) {
         GregorianCalendar cal = new GregorianCalendar();
         cal.set(Calendar.YEAR, year);
         TimeZone fromTimeZone = cal.getTimeZone();
@@ -79,10 +106,10 @@ public static Date of(int year){
      * Uses the current date and time, sets the specified {@code year} and {@code month}, and returns the Date converted to a UTC timestamp.
      *
      * @param year  the year to represent
-     * @param month  the month-of-year to represent, from 0 (January) to 11 (December)
+     * @param month the month-of-year to represent, from 0 (January) to 11 (December)
      * @return the UTC-based {@link Date}
      */
-    public static Date of(int year, int month){
+    public static Date of(int year, int month) {
         Assert.isTrue(0 <= month && month <= 11, "month param must be a value from 0 (January) to 11 (December)");
         GregorianCalendar cal = new GregorianCalendar();
         cal.set(Calendar.YEAR, year);
@@ -96,11 +123,11 @@ public static Date of(int year, int month){
      * Uses the current date and time, sets the specified {@code year}, {@code month} and {@code day}, and returns the Date converted to a UTC timestamp.
      *
      * @param year  the year to represent
-     * @param month  the month-of-year to represent, from 0 (January) to 11 (December)
-     * @param day  the day-of-month to represent, from 1 to 31
+     * @param month the month-of-year to represent, from 0 (January) to 11 (December)
+     * @param day   the day-of-month to represent, from 1 to 31
      * @return the UTC-based {@link Date}
      */
-    public static Date of(int year, int month, int day){
+    public static Date of(int year, int month, int day) {
         Assert.isTrue(0 <= month && month <= 11, "month param must be a value from 0 (January) to 11 (December)");
         Assert.isTrue(1 <= day && day <= 31, "day param must be a value from 1 to 31");
         GregorianCalendar cal = new GregorianCalendar();
@@ -116,12 +143,12 @@ public static Date of(int year, int month, int day){
      * Uses the current date and time, sets the specified {@code year}, {@code month}, {@code day} and {@code hour}, and returns the Date converted to a UTC timestamp.
      *
      * @param year  the year to represent
-     * @param month  the month-of-year to represent, from 0 (January) to 11 (December)
-     * @param day  the day-of-month to represent, from 1 to 31
+     * @param month the month-of-year to represent, from 0 (January) to 11 (December)
+     * @param day   the day-of-month to represent, from 1 to 31
      * @param hour  the hour-of-day to represent, from 0 to 23
      * @return the UTC-based {@link Date}
      */
-    public static Date of(int year, int month, int day, int hour){
+    public static Date of(int year, int month, int day, int hour) {
         Assert.isTrue(0 <= month && month <= 11, "month param must be a value from 0 (January) to 11 (December)");
         Assert.isTrue(1 <= day && day <= 31, "day param must be a value from 1 to 31");
         Assert.isTrue(0 <= hour && hour <= 23, "hour param must be a value from 0 to 23");
@@ -138,14 +165,14 @@ public static Date of(int year, int month, int day, int hour){
      * Creates an UTC-based {@Link Date} from the provided {@code year}, {@code month}, {@code day}, {@code hour} and {@code minute}.
      * Uses the current date and time, sets the specified {@code year}, {@code month}, {@code day}, {@code hour} and {@code minute}, and returns the Date converted to a UTC timestamp.
      *
-     * @param year  the year to represent
+     * @param year   the year to represent
      * @param month  the month-of-year to represent, from 0 (January) to 11 (December)
-     * @param day  the day-of-month to represent, from 1 to 31
-     * @param hour  the hour-of-day to represent, from 0 to 23
-     * @param minute  the minute-of-hour to represent, from 0 to 59
+     * @param day    the day-of-month to represent, from 1 to 31
+     * @param hour   the hour-of-day to represent, from 0 to 23
+     * @param minute the minute-of-hour to represent, from 0 to 59
      * @return the UTC-based {@link Date}
      */
-    public static Date of(int year, int month, int day, int hour, int minute){
+    public static Date of(int year, int month, int day, int hour, int minute) {
         Assert.isTrue(0 <= month && month <= 11, "month param must be a value from 0 (January) to 11 (December)");
         Assert.isTrue(1 <= day && day <= 31, "day param must be a value from 1 to 31");
         Assert.isTrue(0 <= hour && hour <= 23, "hour param must be a value from 0 to 23");
@@ -164,15 +191,15 @@ public static Date of(int year, int month, int day, int hour, int minute){
      * Creates an UTC-based {@Link Date} from the provided {@code year}, {@code month}, {@code day}, {@code hour}, {@code minute} and {@code second}.
      * Uses the current date and time, sets the specified {@code year}, {@code month}, {@code day}, {@code hour}, {@code minute} and {@code second}, and returns the Date converted to a UTC timestamp.
      *
-     * @param year  the year to represent
+     * @param year   the year to represent
      * @param month  the month-of-year to represent, from 0 (January) to 11 (December)
-     * @param day  the day-of-month to represent, from 1 to 31
-     * @param hour  the hour-of-day to represent, from 0 to 23
-     * @param minute  the minute-of-hour to represent, from 0 to 59
-     * @param second  the second-of-hour to represent, from 0 to 59
+     * @param day    the day-of-month to represent, from 1 to 31
+     * @param hour   the hour-of-day to represent, from 0 to 23
+     * @param minute the minute-of-hour to represent, from 0 to 59
+     * @param second the second-of-hour to represent, from 0 to 59
      * @return the UTC-based {@link Date}
      */
-    public static Date of(int year, int month, int day, int hour, int minute, int second){
+    public static Date of(int year, int month, int day, int hour, int minute, int second) {
         Assert.isTrue(0 <= month && month <= 11, "month param must be a value from 0 (January) to 11 (December)");
         Assert.isTrue(1 <= day && day <= 31, "day param must be a value from 1 to 31");
         Assert.isTrue(0 <= hour && hour <= 23, "hour param must be a value from 1 to 23");
@@ -193,16 +220,16 @@ public static Date of(int year, int month, int day, int hour, int minute, int se
      * Creates an UTC-based {@Link Date} from the provided {@code year}, {@code month}, {@code day}, {@code hour}, {@code minute} and {@code second}.
      * Uses the current date and time, sets the specified {@code year}, {@code month}, {@code day}, {@code hour}, {@code minute} and {@code second}, and returns the Date converted to a UTC timestamp.
      *
-     * @param year  the YEAR to represent
-     * @param month  the MONTH to represent, from 0 (January) to 11 (December)
-     * @param day  the DAY_OF_MONTH to represent, from 1 to 31
-     * @param hour  the HOUR_OF_DAY to represent, from 0 to 23
-     * @param minute  the MINUTE to represent, from 0 to 59
-     * @param second  the SECOND to represent, from 0 to 59
+     * @param year        the YEAR to represent
+     * @param month       the MONTH to represent, from 0 (January) to 11 (December)
+     * @param day         the DAY_OF_MONTH to represent, from 1 to 31
+     * @param hour        the HOUR_OF_DAY to represent, from 0 to 23
+     * @param minute      the MINUTE to represent, from 0 to 59
+     * @param second      the SECOND to represent, from 0 to 59
      * @param millisecond the MILLISECOND to represent, from 0 to 59
      * @return the UTC-based {@link Date}
      */
-    public static Date of(int year, int month, int day, int hour, int minute, int second, int millisecond){
+    public static Date of(int year, int month, int day, int hour, int minute, int second, int millisecond) {
         Assert.isTrue(0 <= month && month <= 11, "month param must be a value from 0 (January) to 11 (December)");
         Assert.isTrue(1 <= day && day <= 31, "day param must be a value from 1 to 31");
         Assert.isTrue(0 <= hour && hour <= 23, "hour param must be a value from 1 to 23");
@@ -225,18 +252,18 @@ private static long getTimeZoneOffset(long time, TimeZone from, TimeZone to) {
         int toOffset = to.getOffset(time);
         int diff = 0;
 
-        if (fromOffset >= 0){
-            if (toOffset > 0){
-                toOffset = -1*toOffset;
+        if (fromOffset >= 0) {
+            if (toOffset > 0) {
+                toOffset = -1 * toOffset;
             } else {
                 toOffset = Math.abs(toOffset);
             }
-            diff = (fromOffset+toOffset)*-1;
+            diff = (fromOffset + toOffset) * -1;
         } else {
-            if (toOffset <= 0){
-                toOffset = -1*Math.abs(toOffset);
+            if (toOffset <= 0) {
+                toOffset = -1 * Math.abs(toOffset);
             }
-            diff = (Math.abs(fromOffset)+toOffset);
+            diff = (Math.abs(fromOffset) + toOffset);
         }
         return diff;
     }

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

@@ -0,0 +1,59 @@
+package com.stormpath.sdk.provider;
+
+
+import com.stormpath.sdk.lang.Assert;
+
+import java.util.HashMap;
+import java.util.Map;
+
+/**
+ * A value specifying how to present the accessToken credential when interacting with the authorizationEndpoint and/or
+ * the tokenEndpoint.
+ * Possible values are bearer (token as part of authorization header), access_token and oauth_token (both of which are
+ * query parameters).
+ *
+ * Different OAuth2 providers support different ways to present the accessToken. Please read the provider's "OAuth2"
+ * implementation documentation in detail to identify and pick the type that they support. This allows us to support
+ * any current OAuth2 provider.
+ * Additionally, we can support new types as they emerge by updating this enum.
+ *
+ * @since 1.3.0
+ */
+public enum AccessTokenType {
+
+    BEARER("bearer"),
+    ACCESS_TOKEN_PARAMETER("access_token"),
+    OAUTH_TOKEN_PARAMETER("oauth_token");
+
+    private static final Map<String, AccessTokenType> TOKEN_TYPE_MAP;
+
+    static {
+        TOKEN_TYPE_MAP = new HashMap<>();
+
+        for (AccessTokenType accessTokenType : AccessTokenType.values()) {
+            TOKEN_TYPE_MAP.put(accessTokenType.nameKey, accessTokenType);
+        }
+    }
+
+    private String nameKey;
+
+    AccessTokenType(String nameKey) {
+        this.nameKey = nameKey;
+    }
+
+    public static AccessTokenType fromNameKey(String nameKey) {
+
+        Assert.notNull(nameKey, "accessTokenType is required.");
+
+        AccessTokenType accessTokenType = TOKEN_TYPE_MAP.get(nameKey.toLowerCase());
+
+        Assert.notNull(accessTokenType, "Invalid accessTokenType : " + nameKey);
+
+        return accessTokenType;
+    }
+
+    public String getNameKey() {
+        return this.nameKey;
+    }
+
+}

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

@@ -0,0 +1,51 @@
+package com.stormpath.sdk.provider;
+
+/**
+ * {@link CreateProviderRequestBuilder} interface for any Generic OAuth2 provider.
+ *
+ * @since 1.3.0
+ */
+public interface GenericOAuth2CreateProviderRequestBuilder extends CreateProviderRequestBuilder<GenericOAuth2CreateProviderRequestBuilder> {
+
+    /**
+     * Setter for the authorizationEndpoint for the OAuth2 provider.
+     *
+     * @param authorizationEndpoint the authorizationEndpoint for the OAuth2 provider.
+     * @return the builder instance for method chaining.
+     */
+    GenericOAuth2CreateProviderRequestBuilder setAuthorizationEndpoint(String authorizationEndpoint);
+
+    /**
+     * Setter for the tokenEndpoint for the OAuth2 provider.
+     *
+     * @param tokenEndpoint the tokenEndpoint for the OAuth2 provider.
+     * @return the builder instance for method chaining.
+     */
+    GenericOAuth2CreateProviderRequestBuilder setTokenEndpoint(String tokenEndpoint);
+
+    /**
+     * Setter for the resourceEndpoint for the OAuth2 provider.
+     *
+     * @param resourceEndpoint the resourceEndpoint for the OAuth2 provider.
+     * @return the builder instance for method chaining.
+     */
+    GenericOAuth2CreateProviderRequestBuilder setResourceEndpoint(String resourceEndpoint);
+
+    /**
+     * Setter for the accessTokenType for the OAuth2 provider.
+     *
+     * @param accessTokenType the accessTokenType for the OAuth2 provider.
+     * @return the builder instance for method chaining.
+     */
+    GenericOAuth2CreateProviderRequestBuilder setAccessTokenType(AccessTokenType accessTokenType);
+
+    /**
+     * Setter for the provider id of the OAuth2 provider(e.g. "amazon").
+     *
+     * @param providerId the provider id of the OAuth2 provider.
+     * @return the builder instance for method chaining.
+     */
+    GenericOAuth2CreateProviderRequestBuilder setClientId(String providerId);
+
+    GenericOAuth2CreateProviderRequestBuilder setProviderId(String providerId);
+}

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

@@ -0,0 +1,19 @@
+package com.stormpath.sdk.provider;
+
+/**
+ * {@link Provider} Resource for any Generic OAuth2 provider.
+ *
+ * @since 1.3.0
+ */
+public interface GenericOAuth2Provider extends OAuthProvider {
+
+    GenericOAuth2Provider setProviderId(String providerId);
+
+    String getAuthorizationEndpoint();
+
+    String getTokenEndpoint();
+
+    String getResourceEndpoint();
+
+    AccessTokenType getAccessType();
+}

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

@@ -0,0 +1,17 @@
+package com.stormpath.sdk.provider;
+
+/**
+ * {@link ProviderAccountRequestBuilder} interface for any Generic OAuth2 provider.
+ *
+ * @since 1.3.0
+ */
+public interface GenericOAuth2ProviderAccountRequestBuilder extends ProviderAccountRequestBuilder<GenericOAuth2ProviderAccountRequestBuilder> {
+
+    /**
+     * Setter for the provider id of the OAuth2 Provider (as provided when creating the provider directory).
+     *
+     * @param providerId the provider id of the OAuth2 Provider
+     * @return the builder instance for method chaining.
+     */
+    GenericOAuth2ProviderAccountRequestBuilder setProviderId(String providerId);
+}

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

@@ -0,0 +1,19 @@
+package com.stormpath.sdk.provider;
+
+/**
+ * {@link ProviderData} Resource for any Generic OAuth2 provider.
+ *
+ * @since 1.3.0
+ */
+public interface GenericOAuth2ProviderData extends ProviderData {
+
+    /**
+     * Getter for the OAuth2 provider's access token.
+     *
+     * @return the OAuth2 provider's access token.
+     */
+    String getAccessToken();
+
+    GenericOAuth2ProviderData setProviderId(String providerId);
+
+}

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

@@ -0,0 +1,9 @@
+package com.stormpath.sdk.provider;
+
+/**
+ * {@link ProviderRequestFactory} interface for any Generic OAuth2 provider.
+ *
+ * @since 1.3.0
+ */
+public interface GenericOAuth2ProviderRequestFactory extends ProviderRequestFactory<GenericOAuth2ProviderAccountRequestBuilder, GenericOAuth2CreateProviderRequestBuilder> {
+}