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.edit.SecurityEditFactory;
020import com.echothree.control.user.security.common.edit.SecurityRoleEdit;
021import com.echothree.control.user.security.common.form.EditSecurityRoleForm;
022import com.echothree.control.user.security.common.result.EditSecurityRoleResult;
023import com.echothree.control.user.security.common.result.SecurityResultFactory;
024import com.echothree.control.user.security.common.spec.SecurityRoleSpec;
025import com.echothree.model.control.party.common.PartyTypes;
026import com.echothree.model.control.security.common.SecurityRoleGroups;
027import com.echothree.model.control.security.common.SecurityRoles;
028import com.echothree.model.control.security.server.control.SecurityControl;
029import com.echothree.model.data.security.server.entity.SecurityRole;
030import com.echothree.model.data.security.server.entity.SecurityRoleGroup;
031import com.echothree.model.data.user.common.pk.UserVisitPK;
032import com.echothree.util.common.message.ExecutionErrors;
033import com.echothree.util.common.validation.FieldDefinition;
034import com.echothree.util.common.validation.FieldType;
035import com.echothree.util.common.command.EditMode;
036import com.echothree.util.server.control.BaseAbstractEditCommand;
037import com.echothree.util.server.control.CommandSecurityDefinition;
038import com.echothree.util.server.control.PartyTypeDefinition;
039import com.echothree.util.server.control.SecurityRoleDefinition;
040import com.echothree.util.server.persistence.Session;
041import java.util.Arrays;
042import java.util.Collections;
043import java.util.List;
044import javax.enterprise.context.RequestScoped;
045
046@RequestScoped
047public class EditSecurityRoleCommand
048        extends BaseAbstractEditCommand<SecurityRoleSpec, SecurityRoleEdit, EditSecurityRoleResult, SecurityRole, SecurityRole> {
049    
050    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
051    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
052    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
053    
054    static {
055        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
056                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
057                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
058                        new SecurityRoleDefinition(SecurityRoleGroups.SecurityRole.name(), SecurityRoles.Edit.name())
059                        )))
060                )));
061        
062        SPEC_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
063                new FieldDefinition("SecurityRoleGroupName", FieldType.ENTITY_NAME, true, null, null),
064                new FieldDefinition("SecurityRoleName", FieldType.ENTITY_NAME, true, null, null)
065                ));
066        
067        EDIT_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
068                new FieldDefinition("SecurityRoleName", FieldType.ENTITY_NAME, true, null, null),
069                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
070                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
071                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
072                ));
073    }
074    
075    /** Creates a new instance of EditSecurityRoleCommand */
076    public EditSecurityRoleCommand() {
077        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
078    }
079    
080    @Override
081    public EditSecurityRoleResult getResult() {
082        return SecurityResultFactory.getEditSecurityRoleResult();
083    }
084    
085    @Override
086    public SecurityRoleEdit getEdit() {
087        return SecurityEditFactory.getSecurityRoleEdit();
088    }
089    
090    SecurityRoleGroup securityRoleGroup = null;
091    
092    @Override
093    public SecurityRole getEntity(EditSecurityRoleResult result) {
094        var securityControl = Session.getModelController(SecurityControl.class);
095        SecurityRole securityRole = null;
096        var securityRoleGroupName = spec.getSecurityRoleGroupName();
097        
098        securityRoleGroup = securityControl.getSecurityRoleGroupByName(securityRoleGroupName);
099        
100        if(securityRoleGroup != null) {
101            var securityRoleName = spec.getSecurityRoleName();
102
103            if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
104                securityRole = securityControl.getSecurityRoleByName(securityRoleGroup, securityRoleName);
105            } else { // EditMode.UPDATE
106                securityRole = securityControl.getSecurityRoleByNameForUpdate(securityRoleGroup, securityRoleName);
107            }
108
109            if(securityRole != null) {
110                result.setSecurityRole(securityControl.getSecurityRoleTransfer(getUserVisit(), securityRole));
111            } else {
112                addExecutionError(ExecutionErrors.UnknownSecurityRoleName.name(), securityRoleGroupName, securityRoleGroupName, securityRoleName);
113            }
114        } else {
115            addExecutionError(ExecutionErrors.UnknownSecurityRoleGroupName.name(), securityRoleGroupName);
116        }
117
118        return securityRole;
119    }
120    
121    @Override
122    public SecurityRole getLockEntity(SecurityRole securityRole) {
123        return securityRole;
124    }
125    
126    @Override
127    public void fillInResult(EditSecurityRoleResult result, SecurityRole securityRole) {
128        var securityControl = Session.getModelController(SecurityControl.class);
129        
130        result.setSecurityRole(securityControl.getSecurityRoleTransfer(getUserVisit(), securityRole));
131    }
132    
133    @Override
134    public void doLock(SecurityRoleEdit edit, SecurityRole securityRole) {
135        var securityControl = Session.getModelController(SecurityControl.class);
136        var securityRoleDescription = securityControl.getSecurityRoleDescription(securityRole, getPreferredLanguage());
137        var securityRoleDetail = securityRole.getLastDetail();
138
139        edit.setSecurityRoleName(securityRoleDetail.getSecurityRoleName());
140        edit.setIsDefault(securityRoleDetail.getIsDefault().toString());
141        edit.setSortOrder(securityRoleDetail.getSortOrder().toString());
142
143        if(securityRoleDescription != null) {
144            edit.setDescription(securityRoleDescription.getDescription());
145        }
146    }
147    
148    @Override
149    public void canUpdate(SecurityRole securityRole) {
150        var securityControl = Session.getModelController(SecurityControl.class);
151        var securityRoleName = edit.getSecurityRoleName();
152        var duplicateSecurityRole = securityControl.getSecurityRoleByName(securityRoleGroup, securityRoleName);
153
154        if(duplicateSecurityRole != null && !securityRole.equals(duplicateSecurityRole)) {
155            addExecutionError(ExecutionErrors.DuplicateSecurityRoleName.name(), securityRoleGroup.getLastDetail().getSecurityRoleGroupName(), securityRoleName);
156        }
157    }
158    
159    @Override
160    public void doUpdate(SecurityRole securityRole) {
161        var securityControl = Session.getModelController(SecurityControl.class);
162        var partyPK = getPartyPK();
163        var securityRoleDetailValue = securityControl.getSecurityRoleDetailValueForUpdate(securityRole);
164        var securityRoleDescription = securityControl.getSecurityRoleDescriptionForUpdate(securityRole, getPreferredLanguage());
165        var description = edit.getDescription();
166
167        securityRoleDetailValue.setSecurityRoleName(edit.getSecurityRoleName());
168        securityRoleDetailValue.setIsDefault(Boolean.valueOf(edit.getIsDefault()));
169        securityRoleDetailValue.setSortOrder(Integer.valueOf(edit.getSortOrder()));
170
171        securityControl.updateSecurityRoleFromValue(securityRoleDetailValue, partyPK);
172
173        if(securityRoleDescription == null && description != null) {
174            securityControl.createSecurityRoleDescription(securityRole, getPreferredLanguage(), description, partyPK);
175        } else if(securityRoleDescription != null && description == null) {
176            securityControl.deleteSecurityRoleDescription(securityRoleDescription, partyPK);
177        } else if(securityRoleDescription != null && description != null) {
178            var securityRoleDescriptionValue = securityControl.getSecurityRoleDescriptionValue(securityRoleDescription);
179
180            securityRoleDescriptionValue.setDescription(description);
181            securityControl.updateSecurityRoleDescriptionFromValue(securityRoleDescriptionValue, partyPK);
182        }
183    }
184    
185}