com.google.firebase.auth.UserImportHash Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of firebase-admin Show documentation

This is the official Firebase Admin Java SDK. Build extraordinary native JVM apps in minutes with Firebase. The Firebase platform can power your app’s backend, user authentication, static hosting, and more.

The newest version!

/*
 * Copyright 2017 Google 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.google.firebase.auth;

import static com.google.common.base.Preconditions.checkArgument;

import com.google.common.base.Strings;
import com.google.common.collect.ImmutableMap;
import java.util.Map;

/**
 * Represents a hash algorithm and the related configuration parameters used to hash user
 * passwords. An instance of this class must be specified if importing any users with password
 * hashes (see {@link UserImportOptions.Builder#setHash(UserImportHash)}.
 *
 * This is not expected to be extended in user code. Applications should use one of the provided
 * concrete implementations in the {@link com.google.firebase.auth.hash} package. See
 * documentation for more
 * details on available options.
 */
public abstract class UserImportHash {

  private final String name;

  protected UserImportHash(String name) {
    checkArgument(!Strings.isNullOrEmpty(name));
    this.name = name;
  }

  final Map getProperties() {
    return ImmutableMap.builder()
        .put("hashAlgorithm", name)
        .putAll(getOptions())
        .build();
  }

  protected abstract Map getOptions();
}