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.CreateSecurityRoleGroupForm;
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.SecurityRoleGroup;
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;
039
040public class CreateSecurityRoleGroupCommand
041        extends BaseSimpleCommand<CreateSecurityRoleGroupForm> {
042    
043    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
044    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
045    
046    static {
047        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
048                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
049                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
050                        new SecurityRoleDefinition(SecurityRoleGroups.SecurityRoleGroup.name(), SecurityRoles.Create.name())
051                        )))
052                )));
053        
054        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
055                new FieldDefinition("SecurityRoleGroupName", FieldType.ENTITY_NAME, true, null, null),
056                new FieldDefinition("ParentSecurityRoleGroupName", FieldType.ENTITY_NAME, false, null, null),
057                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
058                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
059                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
060                ));
061    }
062    
063    /** Creates a new instance of CreateSecurityRoleGroupCommand */
064    public CreateSecurityRoleGroupCommand(UserVisitPK userVisitPK, CreateSecurityRoleGroupForm form) {
065        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
066    }
067    
068    @Override
069    protected BaseResult execute() {
070        var result = SecurityResultFactory.getCreateSecurityRoleGroupResult();
071        var securityControl = Session.getModelController(SecurityControl.class);
072        String securityRoleGroupName = form.getSecurityRoleGroupName();
073        SecurityRoleGroup securityRoleGroup = securityControl.getSecurityRoleGroupByName(securityRoleGroupName);
074        
075        if(securityRoleGroup == null) {
076            String parentSecurityRoleGroupName = form.getParentSecurityRoleGroupName();
077            SecurityRoleGroup parentSecurityRoleGroup = null;
078            
079            if(parentSecurityRoleGroupName != null) {
080                parentSecurityRoleGroup = securityControl.getSecurityRoleGroupByName(parentSecurityRoleGroupName);
081            }
082            
083            if(parentSecurityRoleGroupName == null || parentSecurityRoleGroup != 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                securityRoleGroup = securityControl.createSecurityRoleGroup(securityRoleGroupName, parentSecurityRoleGroup,
090                        isDefault, sortOrder, partyPK);
091                
092                if(description != null) {
093                    securityControl.createSecurityRoleGroupDescription(securityRoleGroup, getPreferredLanguage(),
094                            description, partyPK);
095                }
096            } else {
097                addExecutionError(ExecutionErrors.UnknownParentSecurityRoleGroupName.name(), parentSecurityRoleGroupName);
098            }
099        } else {
100            addExecutionError(ExecutionErrors.DuplicateSecurityRoleGroupName.name(), securityRoleGroupName);
101        }
102
103        if(securityRoleGroup != null) {
104            var basePK = securityRoleGroup.getPrimaryKey();
105
106            result.setSecurityRoleGroupName(securityRoleGroup.getLastDetail().getSecurityRoleGroupName());
107            result.setEntityRef(basePK.getEntityRef());
108        }
109
110        return result;
111    }
112    
113}