mirror of
https://github.com/google/nomulus.git
synced 2025-05-06 23:17:51 +02:00
91c2558feb
As part of b/36599833, this makes FlowRunner log the appropriate ICANN activity report field name for each flow it runs as part of a structured JSON log statement which can be parsed to generate ICANN activity reports (under the key "icannActivityReportField"). In order to support this, we introduce an annotation for Flow classes called @ReportingSpec and a corresponding enum of values for this annotation, which is IcannReportingTypes.ActivityReportField, that stores the mapping of constant enum values to field names. The mapping from flows to fields is fairly obvious, with three exceptions: - Application flows are all accounted under domains, since applications are technically just deferred domain creates within the EPP protocol - ClaimsCheckFlow is counted as a domain check - DomainAllocateFlow is counted as a domain create In addition, I've added tests to all the corresponding flows that we are indeed logging what we expect. We'll also need to log the TLD for this to be useful, but I'm doing that in a follow-up CL. ------------- Created by MOE: https://github.com/google/moe MOE_MIGRATED_REVID=151283411
96 lines
4.3 KiB
Java
96 lines
4.3 KiB
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.flows.contact;
|
|
|
|
import static google.registry.flows.FlowUtils.validateClientIsLoggedIn;
|
|
import static google.registry.flows.ResourceFlowUtils.loadAndVerifyExistence;
|
|
import static google.registry.flows.ResourceFlowUtils.verifyOptionalAuthInfo;
|
|
import static google.registry.model.EppResourceUtils.isLinked;
|
|
|
|
import com.google.common.base.Optional;
|
|
import com.google.common.collect.ImmutableSet;
|
|
import com.googlecode.objectify.Key;
|
|
import google.registry.flows.EppException;
|
|
import google.registry.flows.ExtensionManager;
|
|
import google.registry.flows.Flow;
|
|
import google.registry.flows.FlowModule.ClientId;
|
|
import google.registry.flows.FlowModule.TargetId;
|
|
import google.registry.flows.annotations.ReportingSpec;
|
|
import google.registry.model.contact.ContactInfoData;
|
|
import google.registry.model.contact.ContactResource;
|
|
import google.registry.model.eppcommon.AuthInfo;
|
|
import google.registry.model.eppcommon.StatusValue;
|
|
import google.registry.model.eppoutput.EppResponse;
|
|
import google.registry.model.reporting.IcannReportingTypes.ActivityReportField;
|
|
import google.registry.util.Clock;
|
|
import javax.inject.Inject;
|
|
import org.joda.time.DateTime;
|
|
|
|
/**
|
|
* An EPP flow that returns information about a contact.
|
|
*
|
|
* <p>The response includes the contact's postal info, phone numbers, emails, the authInfo which can
|
|
* be used to request a transfer and the details of the contact's most recent transfer if it has
|
|
* ever been transferred. Any registrar can see any contact's information, but the authInfo is only
|
|
* visible to the registrar that owns the contact or to a registrar that already supplied it.
|
|
*
|
|
* @error {@link google.registry.flows.ResourceFlowUtils.ResourceDoesNotExistException}
|
|
*/
|
|
@ReportingSpec(ActivityReportField.CONTACT_INFO)
|
|
public final class ContactInfoFlow implements Flow {
|
|
|
|
@Inject ExtensionManager extensionManager;
|
|
@Inject Clock clock;
|
|
@Inject @ClientId String clientId;
|
|
@Inject @TargetId String targetId;
|
|
@Inject Optional<AuthInfo> authInfo;
|
|
@Inject EppResponse.Builder responseBuilder;
|
|
@Inject ContactInfoFlow() {}
|
|
|
|
@Override
|
|
public final EppResponse run() throws EppException {
|
|
DateTime now = clock.nowUtc();
|
|
extensionManager.validate(); // There are no legal extensions for this flow.
|
|
validateClientIsLoggedIn(clientId);
|
|
ContactResource contact = loadAndVerifyExistence(ContactResource.class, targetId, now);
|
|
verifyOptionalAuthInfo(authInfo, contact);
|
|
boolean includeAuthInfo =
|
|
clientId.equals(contact.getCurrentSponsorClientId()) || authInfo.isPresent();
|
|
ImmutableSet.Builder<StatusValue> statusValues = new ImmutableSet.Builder<>();
|
|
statusValues.addAll(contact.getStatusValues());
|
|
if (isLinked(Key.create(contact), now)) {
|
|
statusValues.add(StatusValue.LINKED);
|
|
}
|
|
return responseBuilder
|
|
.setResData(ContactInfoData.newBuilder()
|
|
.setContactId(contact.getContactId())
|
|
.setRepoId(contact.getRepoId())
|
|
.setStatusValues(statusValues.build())
|
|
.setPostalInfos(contact.getPostalInfosAsList())
|
|
.setVoiceNumber(contact.getVoiceNumber())
|
|
.setFaxNumber(contact.getFaxNumber())
|
|
.setEmailAddress(contact.getEmailAddress())
|
|
.setCurrentSponsorClientId(contact.getCurrentSponsorClientId())
|
|
.setCreationClientId(contact.getCreationClientId())
|
|
.setCreationTime(contact.getCreationTime())
|
|
.setLastEppUpdateClientId(contact.getLastEppUpdateClientId())
|
|
.setLastEppUpdateTime(contact.getLastEppUpdateTime())
|
|
.setLastTransferTime(contact.getLastTransferTime())
|
|
.setAuthInfo(includeAuthInfo ? contact.getAuthInfo() : null)
|
|
.setDisclose(contact.getDisclose())
|
|
.build())
|
|
.build();
|
|
}
|
|
}
|