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.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;
038
039public class DeleteContactMechanismCommand
040        extends BaseSimpleCommand<DeleteContactMechanismForm> {
041
042    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
043    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
044
045    static {
046        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
047                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
048                new PartyTypeDefinition(PartyTypes.CUSTOMER.name(), null),
049                new PartyTypeDefinition(PartyTypes.VENDOR.name(), null),
050                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
051                        new SecurityRoleDefinition(SecurityRoleGroups.ContactMechanism.name(), SecurityRoles.Delete.name())
052                        )))
053                )));
054
055        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
056                new FieldDefinition("ContactMechanismName", FieldType.ENTITY_NAME, true, null, null)
057                ));
058    }
059    
060    /** Creates a new instance of DeleteContactMechanismCommand */
061    public DeleteContactMechanismCommand(UserVisitPK userVisitPK, DeleteContactMechanismForm form) {
062        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
063    }
064    
065    @Override
066    protected SecurityResult security() {
067        // Execute the standard security check using COMMAND_SECURITY_DEFINITION.
068        var securityResult = super.security();
069
070        if(securityResult == null) {
071            var partyTypeName = getPartyTypeName();
072
073            // If the executing Party's PartyType is CUSTOMER or VENDOR, then the specified ContactMechanism
074            // MUST belong to the executing Party.
075            if(partyTypeName.equals(PartyTypes.CUSTOMER.name()) || partyTypeName.equals(PartyTypes.VENDOR.name())) {
076                var contactControl = Session.getModelController(ContactControl.class);
077                var contactMechanismName = form.getContactMechanismName();
078                var contactMechanism = contactControl.getContactMechanismByNameForUpdate(contactMechanismName);
079
080                // If the specified ContactMechanism doesn't exist, that's OK - we'll report that later
081                // during executing of the command.
082                if(contactMechanism != null) {
083                    var partyContactMechanism = contactControl.getPartyContactMechanism(getParty(), contactMechanism);
084
085                    if(partyContactMechanism == null) {
086                        getInsufficientSecurityResult(); // Fail.
087                    }
088                }
089            }
090        }
091
092        return securityResult;
093    }
094
095    @Override
096    protected BaseResult execute() {
097        var contactMechanismName = form.getContactMechanismName();
098
099        ContactMechanismLogic.getInstance().deleteContactMechanism(this, contactMechanismName, getPartyPK());
100        
101        return null;
102    }
103    
104}