google-nomulus/java/google/registry/reporting/icann/DnsCountQueryCoordinator.java
guyben 4097dae3b2 Only inject @Parameter-created variables in the Action itself
Icann reports have 3 parameter-provided injections:

- yearMonth
- subdir
- reportType

We move all of them away from the "inner classes" and only @Inject them in the Actions themselves.

This has 2 benefits:
- it's much clearer what all the parameter inputs of the Actions are
- the "inner injected classes" don't assume anything about the Action that uses them - they will work just as well for JSON actions as for "regular" actions.

-------------
Created by MOE: https://github.com/google/moe
MOE_MIGRATED_REVID=233625765
2019-02-13 16:07:45 -05:00

54 lines
1.8 KiB
Java

// Copyright 2018 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.reporting.icann;
import google.registry.bigquery.BigqueryConnection;
import org.joda.time.YearMonth;
/**
* Methods for preparing and querying DNS statistics.
*
* <p>DNS systems may have different ways of providing this information, so it's useful to
* modularize this.
*
* <p>Derived classes must provide a constructor that accepts a
* {@link google.registry.reporting.icann.DnsCountQueryCoordinator.Params}. To override this,
* define dnsCountQueryCoordinatorClass in your config file.
*/
public interface DnsCountQueryCoordinator {
/**
* Class to carry parameters for a new coordinator.
*
* If your report query requires any additional parameters, add them here.
*/
public class Params {
public BigqueryConnection bigquery;
/** The Google Cloud project id. */
public String projectId;
public Params(BigqueryConnection bigquery, String projectId) {
this.bigquery = bigquery;
this.projectId = projectId;
}
}
/** Creates the string used to query bigtable for DNS count information. */
String createQuery(YearMonth yearMonth);
/** Do any necessry preparation for the DNS query. */
void prepareForQuery(YearMonth yearMonth) throws Exception;
}