google-nomulus/java/google/registry/flows/custom/DomainPricingCustomLogic.java
jianglai 99c16dc345 Make domain pricing customizable
By refactoring TldSpecificLogicProxy (and renaming it to DomainPricingLogic) into
a FlowScope object that is injected into each flow, we can further inject a
DomainPricingCustomLogic into the pricer, which has hooks into each pricing
calls, e. g. getCreatePrice(), getRenewPrice(), etc.

The benefit of these customization hooks is that methods like getCreatePrice()
get called in multiple flows, such as DomainAllocateFlow,
DomainApplicationCreateFlow, and DomainCreateFlow. By customizing the return
value of getCreatePrice() itself, all of its callers gets the amended price.

This CL only includes the basic infrastructure needed, with no actual hooks
placed into each flow.

-------------
Created by MOE: https://github.com/google/moe
MOE_MIGRATED_REVID=140616990
2016-12-06 11:52:46 -05:00

81 lines
2.7 KiB
Java

// Copyright 2016 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.custom;
import com.google.auto.value.AutoValue;
import com.google.common.net.InternetDomainName;
import google.registry.flows.EppException;
import google.registry.flows.SessionMetadata;
import google.registry.flows.domain.DomainPricingLogic;
import google.registry.model.ImmutableObject;
import google.registry.model.domain.fee.BaseFee;
import google.registry.model.eppinput.EppInput;
import google.registry.model.registry.Registry;
import org.joda.time.DateTime;
/**
* A no-op base class to customize {@link DomainPricingLogic}.
*
* <p>Extend this class and override the hook(s) to perform custom logic.
*/
public class DomainPricingCustomLogic extends BaseFlowCustomLogic {
protected DomainPricingCustomLogic(EppInput eppInput, SessionMetadata sessionMetadata) {
super(eppInput, sessionMetadata);
}
/** A hook that customizes create price. */
@SuppressWarnings("unused")
public BaseFee customizeCreatePrice(CreatePriceParameters createPriceParameters)
throws EppException {
return createPriceParameters.createFee();
}
/** A class to encapsulate parameters for a call to {@link #customizeCreatePrice} . */
@AutoValue
public abstract static class CreatePriceParameters extends ImmutableObject {
public abstract BaseFee createFee();
public abstract Registry registry();
public abstract InternetDomainName domainName();
public abstract DateTime asOfDate();
public abstract int years();
public static Builder newBuilder() {
return new AutoValue_DomainPricingCustomLogic_CreatePriceParameters.Builder();
}
/** Builder for {@link CreatePriceParameters}. */
@AutoValue.Builder
public abstract static class Builder {
public abstract Builder setCreateFee(BaseFee createFee);
public abstract Builder setRegistry(Registry registry);
public abstract Builder setDomainName(InternetDomainName domainName);
public abstract Builder setAsOfDate(DateTime asOfDate);
public abstract Builder setYears(int years);
public abstract CreatePriceParameters build();
}
}
}