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