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 com.echothree.util.server.persistence.Session;
041import java.util.List;
042import javax.enterprise.context.Dependent;
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    /** Creates a new instance of EditSecurityRoleCommand */
074    public EditSecurityRoleCommand() {
075        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
076    }
077    
078    @Override
079    public EditSecurityRoleResult getResult() {
080        return SecurityResultFactory.getEditSecurityRoleResult();
081    }
082    
083    @Override
084    public SecurityRoleEdit getEdit() {
085        return SecurityEditFactory.getSecurityRoleEdit();
086    }
087    
088    SecurityRoleGroup securityRoleGroup = null;
089    
090    @Override
091    public SecurityRole getEntity(EditSecurityRoleResult result) {
092        var securityControl = Session.getModelController(SecurityControl.class);
093        SecurityRole securityRole = null;
094        var securityRoleGroupName = spec.getSecurityRoleGroupName();
095        
096        securityRoleGroup = securityControl.getSecurityRoleGroupByName(securityRoleGroupName);
097        
098        if(securityRoleGroup != null) {
099            var securityRoleName = spec.getSecurityRoleName();
100
101            if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
102                securityRole = securityControl.getSecurityRoleByName(securityRoleGroup, securityRoleName);
103            } else { // EditMode.UPDATE
104                securityRole = securityControl.getSecurityRoleByNameForUpdate(securityRoleGroup, securityRoleName);
105            }
106
107            if(securityRole != null) {
108                result.setSecurityRole(securityControl.getSecurityRoleTransfer(getUserVisit(), securityRole));
109            } else {
110                addExecutionError(ExecutionErrors.UnknownSecurityRoleName.name(), securityRoleGroupName, securityRoleGroupName, securityRoleName);
111            }
112        } else {
113            addExecutionError(ExecutionErrors.UnknownSecurityRoleGroupName.name(), securityRoleGroupName);
114        }
115
116        return securityRole;
117    }
118    
119    @Override
120    public SecurityRole getLockEntity(SecurityRole securityRole) {
121        return securityRole;
122    }
123    
124    @Override
125    public void fillInResult(EditSecurityRoleResult result, SecurityRole securityRole) {
126        var securityControl = Session.getModelController(SecurityControl.class);
127        
128        result.setSecurityRole(securityControl.getSecurityRoleTransfer(getUserVisit(), securityRole));
129    }
130    
131    @Override
132    public void doLock(SecurityRoleEdit edit, SecurityRole securityRole) {
133        var securityControl = Session.getModelController(SecurityControl.class);
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 securityControl = Session.getModelController(SecurityControl.class);
149        var securityRoleName = edit.getSecurityRoleName();
150        var duplicateSecurityRole = securityControl.getSecurityRoleByName(securityRoleGroup, securityRoleName);
151
152        if(duplicateSecurityRole != null && !securityRole.equals(duplicateSecurityRole)) {
153            addExecutionError(ExecutionErrors.DuplicateSecurityRoleName.name(), securityRoleGroup.getLastDetail().getSecurityRoleGroupName(), securityRoleName);
154        }
155    }
156    
157    @Override
158    public void doUpdate(SecurityRole securityRole) {
159        var securityControl = Session.getModelController(SecurityControl.class);
160        var partyPK = getPartyPK();
161        var securityRoleDetailValue = securityControl.getSecurityRoleDetailValueForUpdate(securityRole);
162        var securityRoleDescription = securityControl.getSecurityRoleDescriptionForUpdate(securityRole, getPreferredLanguage());
163        var description = edit.getDescription();
164
165        securityRoleDetailValue.setSecurityRoleName(edit.getSecurityRoleName());
166        securityRoleDetailValue.setIsDefault(Boolean.valueOf(edit.getIsDefault()));
167        securityRoleDetailValue.setSortOrder(Integer.valueOf(edit.getSortOrder()));
168
169        securityControl.updateSecurityRoleFromValue(securityRoleDetailValue, partyPK);
170
171        if(securityRoleDescription == null && description != null) {
172            securityControl.createSecurityRoleDescription(securityRole, getPreferredLanguage(), description, partyPK);
173        } else if(securityRoleDescription != null && description == null) {
174            securityControl.deleteSecurityRoleDescription(securityRoleDescription, partyPK);
175        } else if(securityRoleDescription != null && description != null) {
176            var securityRoleDescriptionValue = securityControl.getSecurityRoleDescriptionValue(securityRoleDescription);
177
178            securityRoleDescriptionValue.setDescription(description);
179            securityControl.updateSecurityRoleDescriptionFromValue(securityRoleDescriptionValue, partyPK);
180        }
181    }
182    
183}