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