zydronium/google-nomulus
1
0
Fork 0
mirror of https://github.com/google/nomulus.git synced 2025-05-17 09:57:17 +02:00
Code Issues Projects Releases Packages Wiki Activity

Isolate customizable code in activity reporting

Browse source 
Modularize the code for DNS count reporting to allow it to be customized for
more flexible systems.
Tested:
  Uploaded to alpha with hacks to allow admin initiating and logging from the
  DnsCountQueryCoordinatorModule, verified that the provider function is invoked and
  that the action runs successfully.

-------------
Created by MOE: https://github.com/google/moe
MOE_MIGRATED_REVID=225225587
This commit is contained in:
mmuller 2018-12-12 11:48:08 -08:00 • committed by Michael Muller
parent 6966151bed
commit c396957d15
13 changed files with 208 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

58
java/google/registry/reporting/icann/DnsCountQueryCoordinator.java Normal file
View file

@ -0,0 +1,58 @@
// 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 year and month of the report. */
public YearMonth yearMonth;
/** The Google Cloud project id. */
public String projectId;
public Params(BigqueryConnection bigquery, YearMonth yearMonth, String projectId) {
this.bigquery = bigquery;
this.yearMonth = yearMonth;
this.projectId = projectId;
}
}
/** Creates the string used to query bigtable for DNS count information. */
String createQuery();
/** Do any necessry preparation for the DNS query. */
void prepareForQuery() throws Exception;
}