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