google-nomulus/java/google/registry/tools/RegistryToolComponent.java

// Copyright 2017 The Nomulus Authors. All Rights Reserved.
//
// 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 google.registry.tools;

import dagger.BindsInstance;
import dagger.Component;
import google.registry.bigquery.BigqueryModule;
import google.registry.config.CredentialModule.LocalCredentialJson;
import google.registry.config.RegistryConfig.ConfigModule;
import google.registry.dns.writer.VoidDnsWriterModule;
import google.registry.dns.writer.clouddns.CloudDnsWriterModule;
import google.registry.dns.writer.dnsupdate.DnsUpdateWriterModule;
import google.registry.export.datastore.DatastoreAdminModule;
import google.registry.keyring.KeyringModule;
import google.registry.keyring.api.DummyKeyringModule;
import google.registry.keyring.api.KeyModule;
import google.registry.keyring.kms.KmsModule;
import google.registry.rde.RdeModule;
import google.registry.request.Modules.DatastoreServiceModule;
import google.registry.request.Modules.Jackson2Module;
import google.registry.request.Modules.URLFetchServiceModule;
import google.registry.request.Modules.UrlFetchTransportModule;
import google.registry.request.Modules.UserServiceModule;
import google.registry.tools.AuthModule.LocalCredentialModule;
import google.registry.util.AppEngineServiceUtilsImpl.AppEngineServiceUtilsModule;
import google.registry.util.SystemClock.SystemClockModule;
import google.registry.util.SystemSleeper.SystemSleeperModule;
import google.registry.whois.WhoisModule;
import javax.annotation.Nullable;
import javax.inject.Named;
import javax.inject.Singleton;

/**
 * Dagger component for Registry Tool.
 *
 * <p>Any command class with {@code @Inject} fields <i>must</i> be listed as a method here.
 * Otherwise {@link RegistryCli} will not be able to populate those fields after its instantiation.
 */
@Singleton
@Component(
    modules = {
      AppEngineAdminApiModule.class,
      AppEngineServiceUtilsModule.class,
      AuthModule.class,
      BigqueryModule.class,
      ConfigModule.class,
      CloudDnsWriterModule.class,
      DatastoreAdminModule.class,
      DatastoreServiceModule.class,
      DummyKeyringModule.class,
      DnsUpdateWriterModule.class,
      Jackson2Module.class,
      KeyModule.class,
      KeyringModule.class,
      KmsModule.class,
      LocalCredentialModule.class,
      RdeModule.class,
      RequestFactoryModule.class,
      SystemClockModule.class,
      SystemSleeperModule.class,
      URLFetchServiceModule.class,
      UrlFetchTransportModule.class,
      UserServiceModule.class,
      VoidDnsWriterModule.class,
      WhoisModule.class,
    })
interface RegistryToolComponent {
  void inject(CheckDomainClaimsCommand command);
  void inject(CheckDomainCommand command);
  void inject(CheckSnapshotCommand command);
  void inject(CountDomainsCommand command);
  void inject(CreateAnchorTenantCommand command);
  void inject(CreateCdnsTld command);
  void inject(CreateContactCommand command);
  void inject(CreateDomainCommand command);
  void inject(CreateTldCommand command);
  void inject(DeployInvoicingPipelineCommand command);
  void inject(DeploySpec11PipelineCommand command);
  void inject(EncryptEscrowDepositCommand command);
  void inject(GenerateAllocationTokensCommand command);
  void inject(GenerateDnsReportCommand command);
  void inject(GenerateEscrowDepositCommand command);
  void inject(GetKeyringSecretCommand command);
  void inject(GetOperationStatusCommand command);
  void inject(GhostrydeCommand command);
  void inject(ImportDatastoreCommand command);
  void inject(ListCursorsCommand command);
  void inject(ListDatastoreOperationsCommand command);
  void inject(LoadSnapshotCommand command);
  void inject(LockDomainCommand command);
  void inject(LoginCommand command);
  void inject(LogoutCommand command);
  void inject(PendingEscrowCommand command);
  void inject(RenewDomainCommand command);
  void inject(SendEscrowReportToIcannCommand command);
  void inject(SetNumInstancesCommand command);
  void inject(SetupOteCommand command);
  void inject(UnlockDomainCommand command);
  void inject(UnrenewDomainCommand command);
  void inject(UpdateCursorsCommand command);
  void inject(UpdateDomainCommand command);
  void inject(UpdateKmsKeyringCommand command);
  void inject(UpdateTldCommand command);
  void inject(ValidateEscrowDepositCommand command);
  void inject(WhoisQueryCommand command);

  AppEngineConnection appEngineConnection();

  @LocalCredentialJson
  String googleCredentialJson();

  @Component.Builder
  interface Builder {
    @BindsInstance
    Builder credentialFilename(@Nullable @Named("credentialFileName") String credentialFilename);

    RegistryToolComponent build();
  }
}