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