Source code

001// --------------------------------------------------------------------------------
002// Copyright 2002-2025 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.payment.server.transfer;
018
019import com.echothree.model.control.comment.common.CommentConstants;
020import com.echothree.model.control.contact.common.transfer.PartyContactMechanismTransfer;
021import com.echothree.model.control.contact.server.control.ContactControl;
022import com.echothree.model.control.core.server.control.EntityInstanceControl;
023import static com.echothree.model.control.customer.common.workflow.CustomerCreditCardPaymentMethodConstants.Workflow_CUSTOMER_CREDIT_CARD_PAYMENT_METHOD;
024import com.echothree.model.control.party.common.transfer.NameSuffixTransfer;
025import com.echothree.model.control.party.common.transfer.PersonalTitleTransfer;
026import com.echothree.model.control.party.server.control.PartyControl;
027import com.echothree.model.control.payment.common.PaymentMethodTypes;
028import com.echothree.model.control.payment.common.PaymentOptions;
029import com.echothree.model.control.payment.common.transfer.PartyPaymentMethodTransfer;
030import com.echothree.model.control.payment.server.control.PartyPaymentMethodControl;
031import com.echothree.model.control.payment.server.control.PaymentMethodControl;
032import com.echothree.model.control.security.common.SecurityRoleGroups;
033import com.echothree.model.control.security.common.SecurityRoles;
034import com.echothree.model.control.security.server.logic.SecurityRoleLogic;
035import com.echothree.model.control.user.server.control.UserControl;
036import com.echothree.model.control.workflow.common.transfer.WorkflowEntityStatusTransfer;
037import com.echothree.model.control.workflow.server.control.WorkflowControl;
038import com.echothree.model.data.core.server.entity.EntityInstance;
039import com.echothree.model.data.payment.server.entity.PartyPaymentMethod;
040import com.echothree.model.data.user.server.entity.UserVisit;
041import com.echothree.util.common.string.StringUtils;
042import com.echothree.util.common.transfer.ListWrapper;
043import com.echothree.util.server.persistence.Session;
044import javax.enterprise.context.RequestScoped;
045
046@RequestScoped
047public class PartyPaymentMethodTransferCache
048        extends BasePaymentTransferCache<PartyPaymentMethod, PartyPaymentMethodTransfer> {
049    
050    ContactControl contactControl = Session.getModelController(ContactControl.class);
051    EntityInstanceControl entityInstanceControl = Session.getModelController(EntityInstanceControl.class);
052    PartyControl partyControl = Session.getModelController(PartyControl.class);
053    PartyPaymentMethodControl partyPaymentMethodControl = Session.getModelController(PartyPaymentMethodControl.class);
054    PaymentMethodControl paymentMethodControl = Session.getModelController(PaymentMethodControl.class);
055    WorkflowControl workflowControl = Session.getModelController(WorkflowControl.class);
056
057    boolean needToMaskChecked = false;
058
059    boolean includeNumber;
060    boolean includeSecurityCode;
061    boolean includePartyPaymentMethodContactMechanisms;
062    boolean includeComments;
063    boolean maskNumberAndSecurityCode;
064
065    /** Creates a new instance of PartyPaymentMethodTransferCache */
066    protected PartyPaymentMethodTransferCache() {
067        super();
068
069        var options = session.getOptions();
070        if(options != null) {
071            setIncludeUuid(options.contains(PaymentOptions.PartyPaymentMethodIncludeUuid));
072            includeNumber = options.contains(PaymentOptions.PartyPaymentMethodIncludeNumber);
073            includeSecurityCode = options.contains(PaymentOptions.PartyPaymentMethodIncludeSecurityCode);
074            includePartyPaymentMethodContactMechanisms = options.contains(PaymentOptions.PartyPaymentMethodIncludePartyPaymentMethodContactMechanisms);
075            includeComments = options.contains(PaymentOptions.PartyPaymentMethodIncludeComments);
076        }
077        
078        setIncludeEntityInstance(true);
079    }
080
081    @Override
082    public PartyPaymentMethodTransfer getTransfer(UserVisit userVisit, PartyPaymentMethod partyPaymentMethod) {
083        var partyPaymentMethodTransfer = get(partyPaymentMethod);
084
085        // Additional security check to determine if the PAN or security code should be masked.
086        if(!needToMaskChecked) {
087            if(includeNumber || includeSecurityCode) {
088                var userControl = Session.getModelController(UserControl.class);
089
090                if(!SecurityRoleLogic.getInstance().hasSecurityRoleUsingNames(null, userControl.getPartyFromUserVisit(userVisit),
091                        SecurityRoleGroups.PartyPaymentMethod.name(), SecurityRoles.CreditCard.name())) {
092                    includeNumber = false;
093                    includeSecurityCode = false;
094                    maskNumberAndSecurityCode = true;
095                }
096            }
097
098            needToMaskChecked = true;
099        }
100
101        if(partyPaymentMethodTransfer == null) {
102            var partyPaymentMethodDetail = partyPaymentMethod.getLastDetail();
103            var partyPaymentMethodName = partyPaymentMethodDetail.getPartyPaymentMethodName();
104            var partyTransfer = partyControl.getPartyTransfer(userVisit, partyPaymentMethodDetail.getParty());
105            var description = partyPaymentMethodDetail.getDescription();
106            var paymentMethodTransfer = paymentMethodControl.getPaymentMethodTransfer(userVisit, partyPaymentMethodDetail.getPaymentMethod());
107            var paymentMethodTypeName = paymentMethodTransfer.getPaymentMethodType().getPaymentMethodTypeName();
108            var deleteWhenUnused = partyPaymentMethodDetail.getDeleteWhenUnused();
109            var isDefault = partyPaymentMethodDetail.getIsDefault();
110            var sortOrder = partyPaymentMethodDetail.getSortOrder();
111            WorkflowEntityStatusTransfer partyPaymentMethodStatusTransfer = null;
112            String number = null;
113            Integer expirationMonth = null;
114            Integer expirationYear = null;
115            PersonalTitleTransfer personalTitleTransfer = null;
116            String firstName = null;
117            String middleName = null;
118            String lastName = null;
119            NameSuffixTransfer nameSuffixTransfer = null;
120            String name = null;
121            PartyContactMechanismTransfer billingPartyContactMechanismTransfer = null;
122            String issuerName = null;
123            PartyContactMechanismTransfer issuerPartyContactMechanismTransfer = null;
124            String securityCode = null;
125            EntityInstance entityInstance = null;
126            
127            if(paymentMethodTypeName.equals(PaymentMethodTypes.CREDIT_CARD.name())) {
128                var partyPaymentMethodCreditCard = partyPaymentMethodControl.getPartyPaymentMethodCreditCard(partyPaymentMethod);
129                
130                if(partyPaymentMethodCreditCard != null) {
131                    var partyPaymentMethodCreditCardSecurityCode = partyPaymentMethodControl.getPartyPaymentMethodCreditCardSecurityCode(partyPaymentMethod);
132                    
133                    if(includeNumber || maskNumberAndSecurityCode) {
134                        var decodedNumber = partyPaymentMethodControl.decodePartyPaymentMethodCreditCardNumber(partyPaymentMethodCreditCard);
135
136                        if(decodedNumber != null) {
137                            number = includeNumber? partyPaymentMethodControl.decodePartyPaymentMethodCreditCardNumber(partyPaymentMethodCreditCard): StringUtils.getInstance().mask(decodedNumber, 'X', 4);
138                        }
139                    }
140                    
141                    expirationMonth = partyPaymentMethodCreditCard.getExpirationMonth();
142                    expirationYear = partyPaymentMethodCreditCard.getExpirationYear();
143                    var personalTitle = partyPaymentMethodCreditCard.getPersonalTitle();
144                    personalTitleTransfer = personalTitle == null? null: partyControl.getPersonalTitleTransfer(userVisit, personalTitle);
145                    firstName = partyPaymentMethodCreditCard.getFirstName();
146                    middleName = partyPaymentMethodCreditCard.getMiddleName();
147                    lastName = partyPaymentMethodCreditCard.getLastName();
148                    var nameSuffix = partyPaymentMethodCreditCard.getNameSuffix();
149                    nameSuffixTransfer = nameSuffix == null? null: partyControl.getNameSuffixTransfer(userVisit, nameSuffix);
150                    name = partyPaymentMethodCreditCard.getName();
151                    var billingPartyContactMechanism = partyPaymentMethodCreditCard.getBillingPartyContactMechanism();
152                    billingPartyContactMechanismTransfer = billingPartyContactMechanism == null? null: contactControl.getPartyContactMechanismTransfer(userVisit, billingPartyContactMechanism);
153                    issuerName = partyPaymentMethodCreditCard.getIssuerName();
154                    var issuerPartyContactMechanism = partyPaymentMethodCreditCard.getIssuerPartyContactMechanism();
155                    issuerPartyContactMechanismTransfer = issuerPartyContactMechanism == null? null: contactControl.getPartyContactMechanismTransfer(userVisit, issuerPartyContactMechanism);
156                    
157                    if(partyPaymentMethodCreditCardSecurityCode != null) {
158                        if(includeSecurityCode || maskNumberAndSecurityCode) {
159                            var decodedSecurityCode = partyPaymentMethodControl.decodePartyPaymentMethodCreditCardSecurityCodeSecurityCode(partyPaymentMethodCreditCardSecurityCode);
160
161                            if(decodedSecurityCode != null) {
162                                securityCode = includeNumber? partyPaymentMethodControl.decodePartyPaymentMethodCreditCardNumber(partyPaymentMethodCreditCard): StringUtils.getInstance().mask(decodedSecurityCode, 'X');
163                            }
164                        }
165                    }
166                    
167                    entityInstance = entityInstanceControl.getEntityInstanceByBasePK(partyPaymentMethod.getPrimaryKey());
168                    partyPaymentMethodStatusTransfer = workflowControl.getWorkflowEntityStatusTransferByEntityInstanceUsingNames(userVisit,
169                            Workflow_CUSTOMER_CREDIT_CARD_PAYMENT_METHOD, entityInstance);
170                }
171            }
172            
173            partyPaymentMethodTransfer = new PartyPaymentMethodTransfer(partyPaymentMethodName, partyTransfer, description,
174                    paymentMethodTransfer, deleteWhenUnused, isDefault, sortOrder,
175                    partyPaymentMethodStatusTransfer, number, expirationMonth, expirationYear, personalTitleTransfer, firstName,
176                    middleName, lastName, nameSuffixTransfer, name, billingPartyContactMechanismTransfer, issuerName,
177                    issuerPartyContactMechanismTransfer, securityCode);
178            put(userVisit, partyPaymentMethod, partyPaymentMethodTransfer);
179            
180            if(includePartyPaymentMethodContactMechanisms) {
181                partyPaymentMethodTransfer.setPartyPaymentMethodContactMechanisms(new ListWrapper<>(partyPaymentMethodControl.getPartyPaymentMethodContactMechanismTransfersByPartyPaymentMethod(userVisit, partyPaymentMethod)));
182            }
183
184            if(includeComments) {
185                setupComments(userVisit, partyPaymentMethod, entityInstance, partyPaymentMethodTransfer, CommentConstants.CommentType_PARTY_PAYMENT_METHOD);
186            }
187        }
188        
189        return partyPaymentMethodTransfer;
190    }
191    
192}