001// --------------------------------------------------------------------------------
002// Copyright 2002-2026 Echo Three, LLC
003//
004// Licensed under the Apache License, Version 2.0 (the "License");
005// you may not use this file except in compliance with the License.
006// You may obtain a copy of the License at
007//
008//     http://www.apache.org/licenses/LICENSE-2.0
009//
010// Unless required by applicable law or agreed to in writing, software
011// distributed under the License is distributed on an "AS IS" BASIS,
012// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013// See the License for the specific language governing permissions and
014// limitations under the License.
015// --------------------------------------------------------------------------------
016
017package com.echothree.model.control.subscription.server.logic;
018
019import com.echothree.model.control.chain.common.ChainKinds;
020import com.echothree.model.control.chain.common.ChainTypes;
021import com.echothree.model.control.chain.common.ChainEntityRoleTypes;
022import com.echothree.model.control.chain.server.control.ChainControl;
023import com.echothree.model.control.chain.server.logic.ChainInstanceLogic;
024import com.echothree.model.control.chain.server.logic.ChainLogic;
025import com.echothree.model.control.chain.server.logic.ChainTypeLogic;
026import com.echothree.model.control.subscription.server.control.SubscriptionControl;
027import com.echothree.model.data.chain.server.entity.Chain;
028import com.echothree.model.data.chain.server.entity.ChainInstance;
029import com.echothree.model.data.subscription.server.entity.Subscription;
030import com.echothree.util.common.persistence.BasePK;
031import com.echothree.util.server.control.BaseLogic;
032import com.echothree.util.server.message.ExecutionErrorAccumulator;
033import javax.enterprise.context.ApplicationScoped;
034import javax.inject.Inject;
035
036@ApplicationScoped
037public class SubscriptionChainLogic
038        extends BaseLogic {
039
040    @Inject
041    ChainControl chainControl;
042
043    @Inject
044    SubscriptionControl subscriptionControl;
045
046    @Inject
047    protected ChainInstanceLogic chainInstanceLogic;
048
049    @Inject
050    protected ChainLogic chainLogic;
051
052    @Inject
053    protected ChainTypeLogic chainTypeLogic;
054
055    protected SubscriptionChainLogic() {
056        super();
057    }
058    
059    /** createChainInstance is different than the version in BaseChainLogic, it requires a Subscription parameter. Subscriptions
060     * are allowed to override the Chain being used in each SubscriptionType, so this takes that into account when choosing a
061     * Chain. If there is no SubscriptionTypeChain, then we fall back to the default for the ChainType, following the normal
062     * rules that take OfferChainTypes into account as well. If the chainTypeName == RENEWAL, then we immediately fall back to the
063     * default for the ChainType.
064     * 
065     * TODO: RENEWAL should really be based on the amount of time remaining in the Subscription, and not just fall back to the
066     * default. getSubscriptionTypeChainsBySubscriptionTypeAndChainType(...) could order by the remaining time, and then search
067     * for the one that's the best fit.
068     */
069    protected ChainInstance createChainInstance(final ExecutionErrorAccumulator eea, final String chainKindName, final String chainTypeName,
070            final Subscription subscription, final BasePK createdBy) {
071        var subscriptionType = subscription.getLastDetail().getSubscriptionType();
072        var chainType = chainTypeLogic.getChainTypeByName(eea, chainKindName, chainTypeName);
073        var party = subscription.getLastDetail().getParty();
074        var subscriptionTypeChains = chainTypeName.equals(ChainTypes.RENEWAL.name()) ? null
075                : subscriptionControl.getSubscriptionTypeChainsBySubscriptionTypeAndChainType(subscriptionType, chainType);
076        Chain chain;
077        ChainInstance chainInstance = null;
078        
079        if(subscriptionTypeChains == null || subscriptionTypeChains.isEmpty()) {
080            chain = chainLogic.getChain(eea, chainType, party);
081        } else {
082            chain = subscriptionTypeChains.iterator().next().getChain();
083        }
084        
085        if(chain != null) {
086            chainInstance = chainInstanceLogic.createChainInstance(eea, chainType, party, createdBy);
087        }
088        
089        return chainInstance;
090    }
091    
092    protected ChainInstance createSubscriptionChainInstance(final ExecutionErrorAccumulator eea, final String chainTypeName, final Subscription subscription,
093            final BasePK createdBy) {
094        var chainInstance = createChainInstance(eea, ChainKinds.SUBSCRIPTION.name(), chainTypeName, subscription, createdBy);
095        
096        if(chainInstance != null) {
097            var chainType = chainInstance.getLastDetail().getChain().getLastDetail().getChainType();
098        
099            chainControl.createChainInstanceEntityRole(chainInstance, chainControl.getChainEntityRoleTypeByName(chainType,
100                    ChainEntityRoleTypes.SUBSCRIPTION.name()), subscription.getPrimaryKey(), createdBy);
101        }
102        
103        return chainInstance;
104    }
105    
106    public ChainInstance createSubscriptionInitialChainInstance(final ExecutionErrorAccumulator eea, final Subscription subscription,
107            final BasePK createdBy) {
108        return createSubscriptionChainInstance(eea, ChainTypes.INITIAL.name(), subscription, createdBy);
109    }
110    
111    public ChainInstance createSubscriptionExpirationWarningChainInstance(final ExecutionErrorAccumulator eea, final Subscription subscription,
112            final BasePK createdBy) {
113        return createSubscriptionChainInstance(eea, ChainTypes.EXPIRATION_WARNING.name(), subscription, createdBy);
114    }
115    
116    /** TODO: Consider the RemainingTime in the SubscriptionDetail when choosing the Chain to use.
117     */
118    public ChainInstance createSubscriptionRenewalChainInstance(final ExecutionErrorAccumulator eea, final Subscription subscription,
119            final BasePK createdBy) {
120        return createSubscriptionChainInstance(eea, ChainTypes.RENEWAL.name(), subscription, createdBy);
121    }
122    
123    public ChainInstance createSubscriptionExpirationChainInstance(final ExecutionErrorAccumulator eea, final Subscription subscription,
124            final BasePK createdBy) {
125        return createSubscriptionChainInstance(eea, ChainTypes.EXPIRATION.name(), subscription, createdBy);
126    }
127    
128}