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.control.user.contact.server.command;
018
019import com.echothree.control.user.contact.common.form.DeleteContactMechanismForm;
020import com.echothree.model.control.contact.server.control.ContactControl;
021import com.echothree.model.control.contact.server.logic.ContactMechanismLogic;
022import com.echothree.model.control.party.common.PartyTypes;
023import com.echothree.model.control.security.common.SecurityRoleGroups;
024import com.echothree.model.control.security.common.SecurityRoles;
025import com.echothree.model.data.user.common.pk.UserVisitPK;
026import com.echothree.util.common.command.SecurityResult;
027import com.echothree.util.common.validation.FieldDefinition;
028import com.echothree.util.common.validation.FieldType;
029import com.echothree.util.common.command.BaseResult;
030import com.echothree.util.server.control.BaseSimpleCommand;
031import com.echothree.util.server.control.CommandSecurityDefinition;
032import com.echothree.util.server.control.PartyTypeDefinition;
033import com.echothree.util.server.control.SecurityRoleDefinition;
034import com.echothree.util.server.persistence.Session;
035import java.util.Arrays;
036import java.util.Collections;
037import java.util.List;
038import javax.enterprise.context.RequestScoped;
039
040@RequestScoped
041public class DeleteContactMechanismCommand
042        extends BaseSimpleCommand<DeleteContactMechanismForm> {
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(Collections.unmodifiableList(Arrays.asList(
049                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
050                new PartyTypeDefinition(PartyTypes.CUSTOMER.name(), null),
051                new PartyTypeDefinition(PartyTypes.VENDOR.name(), null),
052                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
053                        new SecurityRoleDefinition(SecurityRoleGroups.ContactMechanism.name(), SecurityRoles.Delete.name())
054                        )))
055                )));
056
057        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
058                new FieldDefinition("ContactMechanismName", FieldType.ENTITY_NAME, true, null, null)
059                ));
060    }
061    
062    /** Creates a new instance of DeleteContactMechanismCommand */
063    public DeleteContactMechanismCommand() {
064        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
065    }
066    
067    @Override
068    protected SecurityResult security() {
069        // Execute the standard security check using COMMAND_SECURITY_DEFINITION.
070        var securityResult = super.security();
071
072        if(securityResult == null) {
073            var partyTypeName = getPartyTypeName();
074
075            // If the executing Party's PartyType is CUSTOMER or VENDOR, then the specified ContactMechanism
076            // MUST belong to the executing Party.
077            if(partyTypeName.equals(PartyTypes.CUSTOMER.name()) || partyTypeName.equals(PartyTypes.VENDOR.name())) {
078                var contactControl = Session.getModelController(ContactControl.class);
079                var contactMechanismName = form.getContactMechanismName();
080                var contactMechanism = contactControl.getContactMechanismByNameForUpdate(contactMechanismName);
081
082                // If the specified ContactMechanism doesn't exist, that's OK - we'll report that later
083                // during executing of the command.
084                if(contactMechanism != null) {
085                    var partyContactMechanism = contactControl.getPartyContactMechanism(getParty(), contactMechanism);
086
087                    if(partyContactMechanism == null) {
088                        getInsufficientSecurityResult(); // Fail.
089                    }
090                }
091            }
092        }
093
094        return securityResult;
095    }
096
097    @Override
098    protected BaseResult execute() {
099        var contactMechanismName = form.getContactMechanismName();
100
101        ContactMechanismLogic.getInstance().deleteContactMechanism(this, contactMechanismName, getPartyPK());
102        
103        return null;
104    }
105    
106}