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.control.user.payment.server.command;
018
019import com.echothree.control.user.payment.common.form.GetPaymentProcessorForm;
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.PaymentProcessorLogic;
024import com.echothree.model.control.core.common.EventTypes;
025import com.echothree.model.control.security.common.SecurityRoleGroups;
026import com.echothree.model.control.security.common.SecurityRoles;
027import com.echothree.model.data.payment.server.entity.PaymentProcessor;
028import com.echothree.model.data.user.common.pk.UserVisitPK;
029import com.echothree.util.common.validation.FieldDefinition;
030import com.echothree.util.common.validation.FieldType;
031import com.echothree.util.common.command.BaseResult;
032import com.echothree.util.server.control.BaseSingleEntityCommand;
033import com.echothree.util.server.control.CommandSecurityDefinition;
034import com.echothree.util.server.control.PartyTypeDefinition;
035import com.echothree.util.server.control.SecurityRoleDefinition;
036import java.util.List;
037import javax.enterprise.context.Dependent;
038import javax.inject.Inject;
039
040@Dependent
041public class GetPaymentProcessorCommand
042        extends BaseSingleEntityCommand<PaymentProcessor, GetPaymentProcessorForm> {
043
044    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
045    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
046
047    static {
048        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
049                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
050                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
051                        new SecurityRoleDefinition(SecurityRoleGroups.PaymentProcessor.name(), SecurityRoles.Review.name())
052                ))
053        ));
054
055        FORM_FIELD_DEFINITIONS = List.of(
056                new FieldDefinition("PaymentProcessorName", FieldType.ENTITY_NAME, false, null, null),
057                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
058                new FieldDefinition("Uuid", FieldType.UUID, false, null, null)
059        );
060    }
061
062    @Inject
063    PaymentProcessorControl paymentProcessorControl;
064
065    @Inject
066    PaymentProcessorLogic paymentProcessorLogic;
067
068    /** Creates a new instance of GetPaymentProcessorCommand */
069    public GetPaymentProcessorCommand() {
070        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
071    }
072
073    @Override
074    protected PaymentProcessor getEntity() {
075        var paymentProcessor = paymentProcessorLogic.getPaymentProcessorByUniversalSpec(this, form, true);
076
077        if(paymentProcessor != null) {
078            sendEvent(paymentProcessor.getPrimaryKey(), EventTypes.READ, null, null, getPartyPK());
079        }
080
081        return paymentProcessor;
082    }
083
084    @Override
085    protected BaseResult getResult(PaymentProcessor paymentProcessor) {
086        var result = PaymentResultFactory.getGetPaymentProcessorResult();
087
088        if(paymentProcessor != null) {
089            result.setPaymentProcessor(paymentProcessorControl.getPaymentProcessorTransfer(getUserVisit(), paymentProcessor));
090        }
091
092        return result;
093    }
094
095}