com.google.crypto.tink.aead.AeadFactory Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of tink-android Show documentation

Tink is a small cryptographic library that provides a safe, simple, agile and fast way to accomplish some common cryptographic tasks.

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.crypto.tink.aead;

import com.google.crypto.tink.Aead;
import com.google.crypto.tink.KeysetHandle;
import com.google.crypto.tink.RegistryConfiguration;
import java.security.GeneralSecurityException;

/**
 * Deprecated class to create {@code Aead} primitives. Instead of using this class, make sure that
 * the {@code AeadWrapper} is registered in your binary, then call {@code
 * keysetHandle.getPrimitive(RegistryConfiguration.get(), Aead.class)} instead. The required
 * registration happens automatically if you called one of the following in your binary:
 *
 * 
 *   {@code HybridConfig.register()}
 *   
{@code AeadConfig.register()}
 *   
{@code TinkConfig.register()}
 * 
 *
 * @deprecated Use {@code keysetHandle.getPrimitive(RegistryConfiguration.get(), Aead.class)} after
 *     registering the {@code AeadWrapper} instead.
 * @since 1.0.0
 */
@Deprecated
public final class AeadFactory {
  /**
   * @return a Aead primitive from a {@code keysetHandle}.
   * @deprecated Use {@code keysetHandle.getPrimitive(RegistryConfiguration.get(), Aead.class)}
   *     after registering the {@code AeadWrapper} instead.
   */
  @Deprecated
  public static Aead getPrimitive(KeysetHandle keysetHandle)
      throws GeneralSecurityException {
    AeadWrapper.register();
    return keysetHandle.getPrimitive(RegistryConfiguration.get(), Aead.class);
  }

  private AeadFactory() {}
}