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.CreateSecurityRoleDescriptionForm;
020import com.echothree.model.control.party.common.PartyTypes;
021import com.echothree.model.control.party.server.control.PartyControl;
022import com.echothree.model.control.security.common.SecurityRoleGroups;
023import com.echothree.model.control.security.common.SecurityRoles;
024import com.echothree.model.control.security.server.control.SecurityControl;
025import com.echothree.model.data.party.server.entity.Language;
026import com.echothree.model.data.security.server.entity.SecurityRole;
027import com.echothree.model.data.security.server.entity.SecurityRoleDescription;
028import com.echothree.model.data.security.server.entity.SecurityRoleGroup;
029import com.echothree.model.data.user.common.pk.UserVisitPK;
030import com.echothree.util.common.message.ExecutionErrors;
031import com.echothree.util.common.validation.FieldDefinition;
032import com.echothree.util.common.validation.FieldType;
033import com.echothree.util.common.command.BaseResult;
034import com.echothree.util.server.control.BaseSimpleCommand;
035import com.echothree.util.server.control.CommandSecurityDefinition;
036import com.echothree.util.server.control.PartyTypeDefinition;
037import com.echothree.util.server.control.SecurityRoleDefinition;
038import com.echothree.util.server.persistence.Session;
039import java.util.Arrays;
040import java.util.Collections;
041import java.util.List;
042
043public class CreateSecurityRoleDescriptionCommand
044        extends BaseSimpleCommand<CreateSecurityRoleDescriptionForm> {
045    
046    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
047    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
048    
049    static {
050        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
051                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
052                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
053                        new SecurityRoleDefinition(SecurityRoleGroups.SecurityRoleGroup.name(), SecurityRoles.Description.name())
054                        )))
055                )));
056        
057        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
058                new FieldDefinition("SecurityRoleGroupName", FieldType.ENTITY_NAME, true, null, null),
059                new FieldDefinition("SecurityRoleName", FieldType.ENTITY_NAME, true, null, null),
060                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null),
061                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L)
062                ));
063    }
064    
065    /** Creates a new instance of CreateSecurityRoleDescriptionCommand */
066    public CreateSecurityRoleDescriptionCommand(UserVisitPK userVisitPK, CreateSecurityRoleDescriptionForm 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        String securityRoleGroupName = form.getSecurityRoleGroupName();
074        SecurityRoleGroup securityRoleGroup = securityControl.getSecurityRoleGroupByName(securityRoleGroupName);
075        
076        if(securityRoleGroup != null) {
077            String securityRoleName = form.getSecurityRoleName();
078            SecurityRole securityRole = securityControl.getSecurityRoleByName(securityRoleGroup, securityRoleName);
079            
080            if(securityRole != null) {
081                var partyControl = Session.getModelController(PartyControl.class);
082                String languageIsoName = form.getLanguageIsoName();
083                Language language = partyControl.getLanguageByIsoName(languageIsoName);
084                
085                if(language != null) {
086                    SecurityRoleDescription securityRoleDescription = securityControl.getSecurityRoleDescription(securityRole, language);
087                    
088                    if(securityRoleDescription == null) {
089                        var description = form.getDescription();
090                        
091                        securityControl.createSecurityRoleDescription(securityRole, language, description, getPartyPK());
092                    } else {
093                        addExecutionError(ExecutionErrors.DuplicateSecurityRoleDescription.name(), securityRoleGroupName, securityRoleName, languageIsoName);
094                    }
095                } else {
096                    addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
097                }
098            } else {
099                addExecutionError(ExecutionErrors.UnknownSecurityRoleName.name(), securityRoleGroupName, securityRoleName);
100            }
101        } else {
102            addExecutionError(ExecutionErrors.UnknownSecurityRoleGroupName.name(), securityRoleGroupName);
103        }
104        
105        return null;
106    }
107    
108}