Package google.registry.flows.custom

Class BaseFlowCustomLogic

java.lang.Object

google.registry.flows.custom.BaseFlowCustomLogic

Direct Known Subclasses:

DomainCheckFlowCustomLogic, DomainCreateFlowCustomLogic, DomainDeleteFlowCustomLogic, DomainInfoFlowCustomLogic, DomainPricingCustomLogic, DomainRenewFlowCustomLogic, DomainUpdateFlowCustomLogic

public abstract class BaseFlowCustomLogic
extends Object

An abstract base class for all flow custom logic that stores the flow's EppInput and SessionMetadata for convenience. Both of these are immutable.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BaseFlowCustomLogic(EppInput eppInput, SessionMetadata sessionMetadata, FlowMetadata flowMetadata)	Constructs a BaseFlowCustomLogic for the specified EPP flow state.

Method Summary

Modifier and Type	Method	Description
protected Optional<EppInput>	getEppInput()	Returns the EppInput, which may be empty outside a flow context.
protected Optional<FlowMetadata>	getFlowMetadata()	Returns the FlowMetadata, which may be empty outside a flow context.
protected Optional<SessionMetadata>	getSessionMetadata()	Returns the SessionMetadata, which may be empty outside a flow context.

Methods inherited from class java.lang.Object

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

Constructor Details

BaseFlowCustomLogic

protected BaseFlowCustomLogic(@Nullable
 EppInput eppInput,
 @Nullable
 SessionMetadata sessionMetadata,
 @Nullable
 FlowMetadata flowMetadata)

Constructs a BaseFlowCustomLogic for the specified EPP flow state.

Note that it is possible for the EPP flow state to be absent, which happens when the custom logic is running outside the context of an EPP flow (e.g. DomainPricingCustomLogic in backend actions).

Method Details

getEppInput

protected Optional<EppInput> getEppInput()

Returns the EppInput, which may be empty outside a flow context.

getSessionMetadata

protected Optional<SessionMetadata> getSessionMetadata()

Returns the SessionMetadata, which may be empty outside a flow context.

getFlowMetadata

protected Optional<FlowMetadata> getFlowMetadata()

Returns the FlowMetadata, which may be empty outside a flow context.