Merge FIS Android SDK into master branch

firebase-installations-interop/api.txt

@@ -0,0 +1,22 @@
+// Signature format: 2.0
+package com.google.firebase.installations {
+
+  public abstract class InstallationTokenResult {
+    ctor public InstallationTokenResult();
+    method @NonNull public static com.google.firebase.installations.InstallationTokenResult.Builder builder();
+    method @NonNull public abstract String getToken();
+    method @NonNull public abstract long getTokenCreationTimestamp();
+    method @NonNull public abstract long getTokenExpirationTimestamp();
+    method @NonNull public abstract com.google.firebase.installations.InstallationTokenResult.Builder toBuilder();
+  }
+
+  public abstract static class InstallationTokenResult.Builder {
+    ctor public InstallationTokenResult.Builder();
+    method @NonNull public abstract com.google.firebase.installations.InstallationTokenResult build();
+    method @NonNull public abstract com.google.firebase.installations.InstallationTokenResult.Builder setToken(@NonNull String);
+    method @NonNull public abstract com.google.firebase.installations.InstallationTokenResult.Builder setTokenCreationTimestamp(long);
+    method @NonNull public abstract com.google.firebase.installations.InstallationTokenResult.Builder setTokenExpirationTimestamp(long);
+  }
+
+}
+

firebase-installations-interop/firebase-installations-interop.gradle

@@ -0,0 +1,46 @@
+// Copyright 2018 Google LLC
+//
+// 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.
+
+
+plugins {
+    id 'firebase-library'
+}
+
+firebaseLibrary.publishJavadoc = false
+
+android {
+	compileSdkVersion project.targetSdkVersion
+	defaultConfig {
+		minSdkVersion project.minSdkVersion
+		targetSdkVersion project.targetSdkVersion
+		versionName version
+		testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
+	}
+	compileOptions {
+		sourceCompatibility JavaVersion.VERSION_1_8
+		targetCompatibility JavaVersion.VERSION_1_8
+	 }
+	 testOptions {
+	 	unitTests {
+			includeAndroidResources = true
+		}
+	}
+}
+
+dependencies {
+	implementation 'com.google.android.gms:play-services-tasks:17.0.0'
+
+	compileOnly "com.google.auto.value:auto-value-annotations:1.6.5"
+	annotationProcessor "com.google.auto.value:auto-value:1.6.2"
+}

firebase-installations-interop/gradle.properties

@@ -0,0 +1 @@
+version=17.1.1

firebase-installations-interop/src/main/AndroidManifest.xml

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- Copyright 2019 Google LLC -->
+<!-- -->
+<!-- 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. -->
+
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+    package="com.google.firebase.installations.interop" />

firebase-installations-interop/src/main/java/com/google/firebase/installations/FirebaseInstallationsApi.java

@@ -0,0 +1,61 @@
+// Copyright 2019 Google LLC
+//
+// 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.google.firebase.installations;
+
+import static java.lang.annotation.RetentionPolicy.SOURCE;
+
+import androidx.annotation.IntDef;
+import com.google.android.gms.tasks.Task;
+import java.lang.annotation.Retention;
+
+/**
+ * This is an interface of {@code FirebaseInstallations} that is only exposed to 2p via component
+ * injection.
+ *
+ * @hide
+ */
+public interface FirebaseInstallationsApi {
+
+  /** Specifies the options to get a FIS AuthToken. */
+  @IntDef({DO_NOT_FORCE_REFRESH, FORCE_REFRESH})
+  @Retention(SOURCE)
+  @interface AuthTokenOption {}
+  /**
+   * AuthToken is not refreshed until requested by the developer or if one doesn't exist, is expired
+   * or about to expire.
+   */
+  int DO_NOT_FORCE_REFRESH = 0;
+  /**
+   * AuthToken is forcefully refreshed on calling the {@link
+   * FirebaseInstallationsApi#getToken(int)}.
+   */
+  int FORCE_REFRESH = 1;
+
+  /**
+   * Async function that returns a globally unique identifier of this Firebase app installation.
+   * This is a url-safe base64 string of a 128-bit integer.
+   */
+  Task<String> getId();
+
+  /** Async function that returns a auth token(public key) of this Firebase app installation. */
+  Task<InstallationTokenResult> getToken(@AuthTokenOption int authTokenOption);
+
+  /**
+   * Async function that deletes this Firebase app installation from Firebase backend. This call
+   * would possibly lead Firebase Notification, Firebase RemoteConfig, Firebase Predictions or
+   * Firebase In-App Messaging not function properly.
+   */
+  Task<Void> delete();
+}

firebase-installations-interop/src/main/java/com/google/firebase/installations/InstallationTokenResult.java

@@ -0,0 +1,62 @@
+// Copyright 2019 Google LLC
+//
+// 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.google.firebase.installations;
+
+import androidx.annotation.NonNull;
+import com.google.auto.value.AutoValue;
+
+/** This class represents a set of values describing a FIS Auth Token Result. */
+@AutoValue
+public abstract class InstallationTokenResult {
+
+  /** A new FIS Auth-Token, created for this Firebase Installation. */
+  @NonNull
+  public abstract String getToken();
+  /**
+   * The amount of time, in seconds, before the auth-token expires for this Firebase Installation.
+   */
+  @NonNull
+  public abstract long getTokenExpirationTimestamp();
+
+  /**
+   * The amount of time, in seconds, when the auth-token was created for this Firebase Installation.
+   */
+  @NonNull
+  public abstract long getTokenCreationTimestamp();
+
+  @NonNull
+  public abstract Builder toBuilder();
+
+  /** Returns a default Builder object to create an InstallationResponse object */
+  @NonNull
+  public static InstallationTokenResult.Builder builder() {
+    return new AutoValue_InstallationTokenResult.Builder();
+  }
+
+  @AutoValue.Builder
+  public abstract static class Builder {
+    @NonNull
+    public abstract Builder setToken(@NonNull String value);
+
+    @NonNull
+    public abstract Builder setTokenExpirationTimestamp(long value);
+
+    @NonNull
+    public abstract Builder setTokenCreationTimestamp(long value);
+
+    @NonNull
+    public abstract InstallationTokenResult build();
+  }
+}

firebase-installations/api.txt

@@ -0,0 +1,150 @@
+// Signature format: 2.0
+package com.google.firebase.installations {
+
+  public class FirebaseInstallations {
+    method @NonNull public Task<Void> delete();
+    method @NonNull public Task<String> getId();
+    method @NonNull public static com.google.firebase.installations.FirebaseInstallations getInstance();
+    method @NonNull public static com.google.firebase.installations.FirebaseInstallations getInstance(@NonNull FirebaseApp);
+    method @NonNull public Task<InstallationTokenResult> getToken(int);
+  }
+
+  public class FirebaseInstallationsException {
+    ctor public FirebaseInstallationsException(@NonNull com.google.firebase.installations.FirebaseInstallationsException.Status);
+    ctor public FirebaseInstallationsException(@NonNull String, @NonNull com.google.firebase.installations.FirebaseInstallationsException.Status);
+    ctor public FirebaseInstallationsException(@NonNull String, @NonNull com.google.firebase.installations.FirebaseInstallationsException.Status, @NonNull Throwable);
+    method @NonNull public com.google.firebase.installations.FirebaseInstallationsException.Status getStatus();
+  }
+
+  public enum FirebaseInstallationsException.Status {
+    enum_constant public static final com.google.firebase.installations.FirebaseInstallationsException.Status BAD_CONFIG;
+  }
+
+  public class RandomFidGenerator {
+    ctor public RandomFidGenerator();
+    method @NonNull public String createRandomFid();
+  }
+
+}
+
+package com.google.firebase.installations.local {
+
+  public class IidStore {
+    ctor public IidStore();
+    method @Nullable public String readIid();
+  }
+
+  public class PersistedInstallation {
+    ctor public PersistedInstallation(@NonNull FirebaseApp);
+    method public void clearForTesting();
+    method @NonNull public com.google.firebase.installations.local.PersistedInstallationEntry insertOrUpdatePersistedInstallationEntry(@NonNull com.google.firebase.installations.local.PersistedInstallationEntry);
+    method @NonNull public com.google.firebase.installations.local.PersistedInstallationEntry readPersistedInstallationEntryValue();
+  }
+
+  public enum PersistedInstallation.RegistrationStatus {
+    enum_constant public static final com.google.firebase.installations.local.PersistedInstallation.RegistrationStatus ATTEMPT_MIGRATION;
+    enum_constant public static final com.google.firebase.installations.local.PersistedInstallation.RegistrationStatus NOT_GENERATED;
+    enum_constant public static final com.google.firebase.installations.local.PersistedInstallation.RegistrationStatus REGISTERED;
+    enum_constant public static final com.google.firebase.installations.local.PersistedInstallation.RegistrationStatus REGISTER_ERROR;
+    enum_constant public static final com.google.firebase.installations.local.PersistedInstallation.RegistrationStatus UNREGISTERED;
+  }
+
+  public abstract class PersistedInstallationEntry {
+    ctor public PersistedInstallationEntry();
+    method @NonNull public static com.google.firebase.installations.local.PersistedInstallationEntry.Builder builder();
+    method @Nullable public abstract String getAuthToken();
+    method public abstract long getExpiresInSecs();
+    method @Nullable public abstract String getFirebaseInstallationId();
+    method @Nullable public abstract String getFisError();
+    method @Nullable public abstract String getRefreshToken();
+    method @NonNull public abstract com.google.firebase.installations.local.PersistedInstallation.RegistrationStatus getRegistrationStatus();
+    method public abstract long getTokenCreationEpochInSecs();
+    method public boolean isErrored();
+    method public boolean isNotGenerated();
+    method public boolean isRegistered();
+    method public boolean isUnregistered();
+    method public boolean shouldAttemptMigration();
+    method @NonNull public abstract com.google.firebase.installations.local.PersistedInstallationEntry.Builder toBuilder();
+    method @NonNull public com.google.firebase.installations.local.PersistedInstallationEntry withAuthToken(@NonNull String, long, long);
+    method @NonNull public com.google.firebase.installations.local.PersistedInstallationEntry withClearedAuthToken();
+    method @NonNull public com.google.firebase.installations.local.PersistedInstallationEntry withFisError(@NonNull String);
+    method @NonNull public com.google.firebase.installations.local.PersistedInstallationEntry withNoGeneratedFid();
+    method @NonNull public com.google.firebase.installations.local.PersistedInstallationEntry withRegisteredFid(@NonNull String, @NonNull String, long, @Nullable String, long);
+    method @NonNull public com.google.firebase.installations.local.PersistedInstallationEntry withUnregisteredFid(@NonNull String);
+    field @NonNull public static com.google.firebase.installations.local.PersistedInstallationEntry INSTANCE;
+  }
+
+  public abstract static class PersistedInstallationEntry.Builder {
+    ctor public PersistedInstallationEntry.Builder();
+    method @NonNull public abstract com.google.firebase.installations.local.PersistedInstallationEntry build();
+    method @NonNull public abstract com.google.firebase.installations.local.PersistedInstallationEntry.Builder setAuthToken(@Nullable String);
+    method @NonNull public abstract com.google.firebase.installations.local.PersistedInstallationEntry.Builder setExpiresInSecs(long);
+    method @NonNull public abstract com.google.firebase.installations.local.PersistedInstallationEntry.Builder setFirebaseInstallationId(@NonNull String);
+    method @NonNull public abstract com.google.firebase.installations.local.PersistedInstallationEntry.Builder setFisError(@Nullable String);
+    method @NonNull public abstract com.google.firebase.installations.local.PersistedInstallationEntry.Builder setRefreshToken(@Nullable String);
+    method @NonNull public abstract com.google.firebase.installations.local.PersistedInstallationEntry.Builder setRegistrationStatus(@NonNull com.google.firebase.installations.local.PersistedInstallation.RegistrationStatus);
+    method @NonNull public abstract com.google.firebase.installations.local.PersistedInstallationEntry.Builder setTokenCreationEpochInSecs(long);
+  }
+
+}
+
+package com.google.firebase.installations.remote {
+
+  public class FirebaseInstallationServiceClient {
+    ctor public FirebaseInstallationServiceClient(@NonNull Context, @Nullable UserAgentPublisher, @Nullable HeartBeatInfo);
+    method @NonNull public com.google.firebase.installations.remote.InstallationResponse createFirebaseInstallation(@NonNull String, @NonNull String, @NonNull String, @NonNull String);
+    method @NonNull public void deleteFirebaseInstallation(@NonNull String, @NonNull String, @NonNull String, @NonNull String);
+    method @NonNull public com.google.firebase.installations.remote.TokenResult generateAuthToken(@NonNull String, @NonNull String, @NonNull String, @NonNull String);
+  }
+
+  public abstract class InstallationResponse {
+    ctor public InstallationResponse();
+    method @NonNull public static com.google.firebase.installations.remote.InstallationResponse.Builder builder();
+    method @Nullable public abstract com.google.firebase.installations.remote.TokenResult getAuthToken();
+    method @Nullable public abstract String getFid();
+    method @Nullable public abstract String getRefreshToken();
+    method @Nullable public abstract com.google.firebase.installations.remote.InstallationResponse.ResponseCode getResponseCode();
+    method @Nullable public abstract String getUri();
+    method @NonNull public abstract com.google.firebase.installations.remote.InstallationResponse.Builder toBuilder();
+  }
+
+  public abstract static class InstallationResponse.Builder {
+    ctor public InstallationResponse.Builder();
+    method @NonNull public abstract com.google.firebase.installations.remote.InstallationResponse build();
+    method @NonNull public abstract com.google.firebase.installations.remote.InstallationResponse.Builder setAuthToken(@NonNull com.google.firebase.installations.remote.TokenResult);
+    method @NonNull public abstract com.google.firebase.installations.remote.InstallationResponse.Builder setFid(@NonNull String);
+    method @NonNull public abstract com.google.firebase.installations.remote.InstallationResponse.Builder setRefreshToken(@NonNull String);
+    method @NonNull public abstract com.google.firebase.installations.remote.InstallationResponse.Builder setResponseCode(@NonNull com.google.firebase.installations.remote.InstallationResponse.ResponseCode);
+    method @NonNull public abstract com.google.firebase.installations.remote.InstallationResponse.Builder setUri(@NonNull String);
+  }
+
+  public enum InstallationResponse.ResponseCode {
+    enum_constant public static final com.google.firebase.installations.remote.InstallationResponse.ResponseCode BAD_CONFIG;
+    enum_constant public static final com.google.firebase.installations.remote.InstallationResponse.ResponseCode OK;
+  }
+
+  public abstract class TokenResult {
+    ctor public TokenResult();
+    method @NonNull public static com.google.firebase.installations.remote.TokenResult.Builder builder();
+    method @Nullable public abstract com.google.firebase.installations.remote.TokenResult.ResponseCode getResponseCode();
+    method @Nullable public abstract String getToken();
+    method @NonNull public abstract long getTokenExpirationTimestamp();
+    method @NonNull public abstract com.google.firebase.installations.remote.TokenResult.Builder toBuilder();
+  }
+
+  public abstract static class TokenResult.Builder {
+    ctor public TokenResult.Builder();
+    method @NonNull public abstract com.google.firebase.installations.remote.TokenResult build();
+    method @NonNull public abstract com.google.firebase.installations.remote.TokenResult.Builder setResponseCode(@NonNull com.google.firebase.installations.remote.TokenResult.ResponseCode);
+    method @NonNull public abstract com.google.firebase.installations.remote.TokenResult.Builder setToken(@NonNull String);
+    method @NonNull public abstract com.google.firebase.installations.remote.TokenResult.Builder setTokenExpirationTimestamp(long);
+  }
+
+  public enum TokenResult.ResponseCode {
+    enum_constant public static final com.google.firebase.installations.remote.TokenResult.ResponseCode AUTH_ERROR;
+    enum_constant public static final com.google.firebase.installations.remote.TokenResult.ResponseCode BAD_CONFIG;
+    enum_constant public static final com.google.firebase.installations.remote.TokenResult.ResponseCode OK;
+  }
+
+}
+