google-nomulus/java/google/registry/flows/custom/CustomLogicFactory.java
mcilwain 4d2e0941f3 Add a custom logic framework to provide pluggable extensibility
To add additional logic for flow code, write custom classes that extend the existing custom logic classes (of which DomainCreateFlowCustomLogic is the first provided example), along with a class that extends CustomLogicFactory to provide instances of the new custom logic classes. Then configure the fully qualified class name of your new custom logic factory in ConfigModule.provideCustomLogicFactoryClass().

-------------
Created by MOE: https://github.com/google/moe
MOE_MIGRATED_REVID=139221577
2016-11-15 15:19:32 -05:00

38 lines
1.6 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 google.registry.config.ConfigModule;
import google.registry.flows.SessionMetadata;
import google.registry.model.eppinput.EppInput;
/**
* A no-op base custom logic factory.
*
* <p>To add custom logic, extend this class, then configure it in
* {@link ConfigModule#provideCustomLogicFactoryClass}. The eppInput and sessionMetadata parameters
* are unused in the base implementation, but are provided so that custom implementations can
* optionally determine how to construct/choose which custom logic class to return. A common use
* case might be parsing TLD for domain-specific flows from the EppInput and then using that to
* choose a different custom logic implementation, or switching based on the registrar
* {@code clientId} in sessionMetadata.
*/
public class CustomLogicFactory {
public DomainCreateFlowCustomLogic forDomainCreateFlow(
EppInput eppInput, SessionMetadata sessionMetadata) {
return new DomainCreateFlowCustomLogic(eppInput, sessionMetadata);
}
}