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.CreateSecurityRoleForm;
020import com.echothree.control.user.security.common.result.SecurityResultFactory;
021import com.echothree.model.control.party.common.PartyTypes;
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.security.server.entity.SecurityRole;
026import com.echothree.model.data.security.server.entity.SecurityRoleGroup;
027import com.echothree.model.data.user.common.pk.UserVisitPK;
028import com.echothree.util.common.command.BaseResult;
029import com.echothree.util.common.message.ExecutionErrors;
030import com.echothree.util.common.validation.FieldDefinition;
031import com.echothree.util.common.validation.FieldType;
032import com.echothree.util.server.control.BaseSimpleCommand;
033import com.echothree.util.server.control.CommandSecurityDefinition;
034import com.echothree.util.server.control.PartyTypeDefinition;
035import com.echothree.util.server.control.SecurityRoleDefinition;
036import com.echothree.util.server.persistence.Session;
037import java.util.Arrays;
038import java.util.Collections;
039import java.util.List;
040
041public class CreateSecurityRoleCommand
042        extends BaseSimpleCommand<CreateSecurityRoleForm> {
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.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
051                        new SecurityRoleDefinition(SecurityRoleGroups.SecurityRole.name(), SecurityRoles.Create.name())
052                        )))
053                )));
054        
055        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
056                new FieldDefinition("SecurityRoleGroupName", FieldType.ENTITY_NAME, true, null, null),
057                new FieldDefinition("SecurityRoleName", FieldType.ENTITY_NAME, true, null, null),
058                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
059                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
060                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
061                ));
062    }
063    
064    /** Creates a new instance of CreateSecurityRoleCommand */
065    public CreateSecurityRoleCommand(UserVisitPK userVisitPK, CreateSecurityRoleForm form) {
066        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
067    }
068    
069    @Override
070    protected BaseResult execute() {
071        var result = SecurityResultFactory.getCreateSecurityRoleResult();
072        var securityControl = Session.getModelController(SecurityControl.class);
073        String securityRoleGroupName = form.getSecurityRoleGroupName();
074        SecurityRoleGroup securityRoleGroup = securityControl.getSecurityRoleGroupByName(securityRoleGroupName);
075        SecurityRole securityRole = null;
076
077        if(securityRoleGroup != null) {
078            String securityRoleName = form.getSecurityRoleName();
079
080            securityRole = securityControl.getSecurityRoleByName(securityRoleGroup, securityRoleName);
081            
082            if(securityRole == null) {
083                var partyPK = getPartyPK();
084                var isDefault = Boolean.valueOf(form.getIsDefault());
085                var sortOrder = Integer.valueOf(form.getSortOrder());
086                var description = form.getDescription();
087                
088                securityRole = securityControl.createSecurityRole(securityRoleGroup, securityRoleName, isDefault, sortOrder, partyPK);
089                
090                if(description != null) {
091                    securityControl.createSecurityRoleDescription(securityRole, getPreferredLanguage(), description, partyPK);
092                }
093            } else {
094                addExecutionError(ExecutionErrors.DuplicateSecurityRoleName.name(), securityRoleGroupName, securityRoleName);
095            }
096        } else {
097            addExecutionError(ExecutionErrors.DuplicateSecurityRoleGroupName.name(), securityRoleGroupName);
098        }
099
100        if(securityRole != null) {
101            var basePK = securityRole.getPrimaryKey();
102            var securityRoleDetail = securityRole.getLastDetail();
103
104            result.setSecurityRoleGroupName(securityRoleDetail.getSecurityRole().getLastDetail().getSecurityRoleName());
105            result.setSecurityRoleName(securityRoleDetail.getSecurityRoleName());
106            result.setEntityRef(basePK.getEntityRef());
107        }
108
109        return result;
110    }
111    
112}