Package google.registry.flows.custom

Class DomainRenewFlowCustomLogic

java.lang.Object

google.registry.flows.custom.BaseFlowCustomLogic

google.registry.flows.custom.DomainRenewFlowCustomLogic

public class DomainRenewFlowCustomLogic
extends BaseFlowCustomLogic

A no-op base class for DomainRenewFlow custom logic.

Extend this class and override the hook(s) to perform custom logic.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	DomainRenewFlowCustomLogic.AfterValidationParameters	A class to encapsulate parameters for a call to afterValidation(google.registry.flows.custom.DomainRenewFlowCustomLogic.AfterValidationParameters).
static final record	DomainRenewFlowCustomLogic.BeforeResponseParameters	A record to encapsulate parameters for a call to beforeResponse(google.registry.flows.custom.DomainRenewFlowCustomLogic.BeforeResponseParameters).
static final record	DomainRenewFlowCustomLogic.BeforeResponseReturnData	A record to encapsulate parameters for the return values from a call to beforeResponse(google.registry.flows.custom.DomainRenewFlowCustomLogic.BeforeResponseParameters).
static final record	DomainRenewFlowCustomLogic.BeforeSaveParameters	A record to encapsulate parameters for a call to beforeSave(google.registry.flows.custom.DomainRenewFlowCustomLogic.BeforeSaveParameters).

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DomainRenewFlowCustomLogic(EppInput eppInput, SessionMetadata sessionMetadata, FlowMetadata flowMetadata)

Method Summary

Modifier and Type	Method	Description
void	afterValidation(DomainRenewFlowCustomLogic.AfterValidationParameters parameters)	A hook that runs at the end of the validation step to perform additional validation.
DomainRenewFlowCustomLogic.BeforeResponseReturnData	beforeResponse(DomainRenewFlowCustomLogic.BeforeResponseParameters parameters)	A hook that runs before the response is returned.
EntityChanges	beforeSave(DomainRenewFlowCustomLogic.BeforeSaveParameters parameters)	A hook that runs before new entities are persisted, allowing them to be changed.
void	beforeValidation()	A hook that runs before any validation.

Methods inherited from class google.registry.flows.custom.BaseFlowCustomLogic

getEppInput, getFlowMetadata, getSessionMetadata

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DomainRenewFlowCustomLogic

protected DomainRenewFlowCustomLogic(EppInput eppInput,
 SessionMetadata sessionMetadata,
 FlowMetadata flowMetadata)

Method Details

beforeValidation

public void beforeValidation()
                      throws EppException

A hook that runs before any validation. This is useful to e.g. add allowable extensions.

Throws:

EppException

afterValidation

public void afterValidation(DomainRenewFlowCustomLogic.AfterValidationParameters parameters)
                     throws EppException

A hook that runs at the end of the validation step to perform additional validation.

Throws:

EppException

beforeSave

public EntityChanges beforeSave(DomainRenewFlowCustomLogic.BeforeSaveParameters parameters)
                         throws EppException

A hook that runs before new entities are persisted, allowing them to be changed.

It returns the actual entity changes that should be persisted to the database. It is important to be careful when changing the flow behavior for existing entities, because the core logic across many different flows expects the existence of these entities and many of the fields on them.

Throws:

EppException

beforeResponse

public DomainRenewFlowCustomLogic.BeforeResponseReturnData beforeResponse(DomainRenewFlowCustomLogic.BeforeResponseParameters parameters)
                                                                   throws EppException

A hook that runs before the response is returned.

This takes the Domain and EppResponse.ResponseExtensions as input and returns them, potentially with modifications.

Throws:

EppException