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.control.user.payment.server.command;
018
019import com.echothree.control.user.payment.common.form.CreatePaymentProcessorForm;
020import com.echothree.control.user.payment.common.result.PaymentResultFactory;
021import com.echothree.model.control.party.common.PartyTypes;
022import com.echothree.model.control.payment.server.control.PaymentProcessorControl;
023import com.echothree.model.control.payment.server.logic.PaymentProcessorTypeLogic;
024import com.echothree.model.control.security.common.SecurityRoleGroups;
025import com.echothree.model.control.security.common.SecurityRoles;
026import com.echothree.model.data.user.common.pk.UserVisitPK;
027import com.echothree.util.common.command.BaseResult;
028import com.echothree.util.common.message.ExecutionErrors;
029import com.echothree.util.common.validation.FieldDefinition;
030import com.echothree.util.common.validation.FieldType;
031import com.echothree.util.server.control.BaseSimpleCommand;
032import com.echothree.util.server.control.CommandSecurityDefinition;
033import com.echothree.util.server.control.PartyTypeDefinition;
034import com.echothree.util.server.control.SecurityRoleDefinition;
035import com.echothree.util.server.persistence.Session;
036import java.util.Arrays;
037import java.util.Collections;
038import java.util.List;
039
040public class CreatePaymentProcessorCommand
041        extends BaseSimpleCommand<CreatePaymentProcessorForm> {
042    
043    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
044    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
045    
046    static {
047        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
048                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
049                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
050                        new SecurityRoleDefinition(SecurityRoleGroups.PaymentProcessor.name(), SecurityRoles.Create.name())
051                        )))
052                )));
053
054        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
055                new FieldDefinition("PaymentProcessorName", FieldType.ENTITY_NAME, true, null, null),
056                new FieldDefinition("PaymentProcessorTypeName", FieldType.ENTITY_NAME, true, null, null),
057                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
058                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
059                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
060                ));
061    }
062    
063    /** Creates a new instance of CreatePaymentProcessorCommand */
064    public CreatePaymentProcessorCommand(UserVisitPK userVisitPK, CreatePaymentProcessorForm form) {
065        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
066    }
067    
068    @Override
069    protected BaseResult execute() {
070        var paymentProcessorControl = Session.getModelController(PaymentProcessorControl.class);
071        var result = PaymentResultFactory.getCreatePaymentProcessorResult();
072        var paymentProcessorName = form.getPaymentProcessorName();
073        var paymentProcessor = paymentProcessorControl.getPaymentProcessorByName(paymentProcessorName);
074        
075        if(paymentProcessor == null) {
076            var paymentProcessorTypeName = form.getPaymentProcessorTypeName();
077            var paymentProcessorType = PaymentProcessorTypeLogic.getInstance().getPaymentProcessorTypeByName(this, paymentProcessorTypeName);
078            
079            if(!hasExecutionErrors()) {
080                var partyPK = getPartyPK();
081                var isDefault = Boolean.valueOf(form.getIsDefault());
082                var sortOrder = Integer.valueOf(form.getSortOrder());
083                var description = form.getDescription();
084                
085                paymentProcessor = paymentProcessorControl.createPaymentProcessor(paymentProcessorName, paymentProcessorType,
086                        isDefault, sortOrder, partyPK);
087                
088                if(description != null) {
089                    var language = getPreferredLanguage();
090                    
091                    paymentProcessorControl.createPaymentProcessorDescription(paymentProcessor, language, description, partyPK);
092                }
093            }
094        } else {
095            addExecutionError(ExecutionErrors.DuplicatePaymentProcessorName.name(), paymentProcessorName);
096        }
097
098        if(paymentProcessor != null) {
099            result.setEntityRef(paymentProcessor.getPrimaryKey().getEntityRef());
100        }
101        
102        return result;
103    }
104    
105}