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.security.server.command;
018
019import com.echothree.control.user.security.common.form.GetPartySecurityRoleTemplateRoleForm;
020import com.echothree.control.user.security.common.result.GetPartySecurityRoleTemplateRoleResult;
021import com.echothree.control.user.security.common.result.SecurityResultFactory;
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.control.security.server.control.SecurityControl;
026import com.echothree.model.data.security.server.entity.PartySecurityRoleTemplate;
027import com.echothree.model.data.security.server.entity.PartySecurityRoleTemplateRole;
028import com.echothree.model.data.security.server.entity.SecurityRole;
029import com.echothree.model.data.security.server.entity.SecurityRoleGroup;
030import com.echothree.model.data.user.common.pk.UserVisitPK;
031import com.echothree.util.common.message.ExecutionErrors;
032import com.echothree.util.common.validation.FieldDefinition;
033import com.echothree.util.common.validation.FieldType;
034import com.echothree.util.common.command.BaseResult;
035import com.echothree.util.server.control.BaseSimpleCommand;
036import com.echothree.util.server.control.CommandSecurityDefinition;
037import com.echothree.util.server.control.PartyTypeDefinition;
038import com.echothree.util.server.control.SecurityRoleDefinition;
039import com.echothree.util.server.persistence.Session;
040import java.util.Arrays;
041import java.util.Collections;
042import java.util.List;
043
044public class GetPartySecurityRoleTemplateRoleCommand
045        extends BaseSimpleCommand<GetPartySecurityRoleTemplateRoleForm> {
046    
047    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
048    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
049    
050    static {
051        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
052                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
053                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
054                        new SecurityRoleDefinition(SecurityRoleGroups.PartySecurityRoleTemplateRole.name(), SecurityRoles.Review.name())
055                        )))
056                )));
057        
058        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
059                new FieldDefinition("PartySecurityRoleTemplateName", FieldType.ENTITY_NAME, true, null, null),
060                new FieldDefinition("SecurityRoleGroupName", FieldType.ENTITY_NAME, true, null, null),
061                new FieldDefinition("SecurityRoleName", FieldType.ENTITY_NAME, true, null, null)
062                ));
063    }
064    
065    /** Creates a new instance of GetPartySecurityRoleTemplateRoleCommand */
066    public GetPartySecurityRoleTemplateRoleCommand(UserVisitPK userVisitPK, GetPartySecurityRoleTemplateRoleForm form) {
067        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
068    }
069    
070    @Override
071    protected BaseResult execute() {
072        var securityControl = Session.getModelController(SecurityControl.class);
073        GetPartySecurityRoleTemplateRoleResult result = SecurityResultFactory.getGetPartySecurityRoleTemplateRoleResult();
074        String partySecurityRoleTemplateName = form.getPartySecurityRoleTemplateName();
075        PartySecurityRoleTemplate partySecurityRoleTemplate = securityControl.getPartySecurityRoleTemplateByName(partySecurityRoleTemplateName);
076        
077        if(partySecurityRoleTemplate != null) {
078            String securityRoleGroupName = form.getSecurityRoleGroupName();
079            SecurityRoleGroup securityRoleGroup = securityControl.getSecurityRoleGroupByName(securityRoleGroupName);
080            
081            if(securityRoleGroup != null) {
082                String securityRoleName = form.getSecurityRoleName();
083                SecurityRole securityRole = securityControl.getSecurityRoleByName(securityRoleGroup, securityRoleName);
084                
085                if(securityRole != null) {
086                    PartySecurityRoleTemplateRole partySecurityRoleTemplateRole = securityControl.getPartySecurityRoleTemplateRole(partySecurityRoleTemplate,
087                            securityRole);
088                    
089                    if(partySecurityRoleTemplateRole != null) {
090                        result.setPartySecurityRoleTemplateRole(securityControl.getPartySecurityRoleTemplateRoleTransfer(getUserVisit(),
091                                partySecurityRoleTemplateRole));
092                    } else {
093                        addExecutionError(ExecutionErrors.UnknownPartySecurityRoleTemplateRole.name(), partySecurityRoleTemplateName, securityRoleGroupName,
094                                securityRoleName);
095                    }
096                } else {
097                    addExecutionError(ExecutionErrors.UnknownSecurityRoleName.name(), securityRoleGroupName, securityRoleName);
098                }
099            } else {
100                addExecutionError(ExecutionErrors.UnknownSecurityRoleGroupName.name(), securityRoleGroupName);
101            }
102        } else {
103            addExecutionError(ExecutionErrors.UnknownPartySecurityRoleTemplateName.name(), partySecurityRoleTemplateName);
104        }
105        
106        return result;
107    }
108    
109}