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.SecurityRoleDescriptionEdit;
021import com.echothree.control.user.security.common.form.EditSecurityRoleDescriptionForm;
022import com.echothree.control.user.security.common.result.EditSecurityRoleDescriptionResult;
023import com.echothree.control.user.security.common.result.SecurityResultFactory;
024import com.echothree.control.user.security.common.spec.SecurityRoleDescriptionSpec;
025import com.echothree.model.control.party.common.PartyTypes;
026import com.echothree.model.control.party.server.control.PartyControl;
027import com.echothree.model.control.security.common.SecurityRoleGroups;
028import com.echothree.model.control.security.common.SecurityRoles;
029import com.echothree.model.control.security.server.control.SecurityControl;
030import com.echothree.model.data.party.server.entity.Language;
031import com.echothree.model.data.security.server.entity.SecurityRole;
032import com.echothree.model.data.security.server.entity.SecurityRoleDescription;
033import com.echothree.model.data.security.server.entity.SecurityRoleGroup;
034import com.echothree.model.data.security.server.value.SecurityRoleDescriptionValue;
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 EditSecurityRoleDescriptionCommand
050        extends BaseAbstractEditCommand<SecurityRoleDescriptionSpec, SecurityRoleDescriptionEdit, EditSecurityRoleDescriptionResult, SecurityRoleDescription, 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.Description.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                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
068                ));
069
070        EDIT_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
071                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L)
072                ));
073    }
074
075    /** Creates a new instance of EditSecurityRoleDescriptionCommand */
076    public EditSecurityRoleDescriptionCommand(UserVisitPK userVisitPK, EditSecurityRoleDescriptionForm form) {
077        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
078    }
079
080    @Override
081    public EditSecurityRoleDescriptionResult getResult() {
082        return SecurityResultFactory.getEditSecurityRoleDescriptionResult();
083    }
084
085    @Override
086    public SecurityRoleDescriptionEdit getEdit() {
087        return SecurityEditFactory.getSecurityRoleDescriptionEdit();
088    }
089
090    SecurityRoleGroup securityRoleGroup;
091    
092    @Override
093    public SecurityRoleDescription getEntity(EditSecurityRoleDescriptionResult result) {
094        var securityControl = Session.getModelController(SecurityControl.class);
095        SecurityRoleDescription securityRoleDescription = null;
096        String securityRoleGroupName = spec.getSecurityRoleGroupName();
097        
098        securityRoleGroup = securityControl.getSecurityRoleGroupByName(securityRoleGroupName);
099
100        if(securityRoleGroup != null) {
101            String securityRoleName = spec.getSecurityRoleName();
102            SecurityRole securityRole = securityControl.getSecurityRoleByName(securityRoleGroup, securityRoleName);
103
104            if(securityRole != null) {
105                var partyControl = Session.getModelController(PartyControl.class);
106                String languageIsoName = spec.getLanguageIsoName();
107                Language language = partyControl.getLanguageByIsoName(languageIsoName);
108
109                if(language != null) {
110                    if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
111                        securityRoleDescription = securityControl.getSecurityRoleDescription(securityRole, language);
112                    } else { // EditMode.UPDATE
113                        securityRoleDescription = securityControl.getSecurityRoleDescriptionForUpdate(securityRole, language);
114                    }
115
116                    if(securityRoleDescription == null) {
117                        addExecutionError(ExecutionErrors.UnknownSecurityRoleDescription.name(), securityRoleGroupName, securityRoleName, languageIsoName);
118                    }
119                } else {
120                    addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
121                }
122            } else {
123                addExecutionError(ExecutionErrors.UnknownSecurityRoleName.name(), securityRoleGroupName, securityRoleName);
124            }
125        } else {
126            addExecutionError(ExecutionErrors.UnknownSecurityRoleGroupName.name(), securityRoleGroupName);
127        }
128
129        return securityRoleDescription;
130    }
131
132    @Override
133    public SecurityRole getLockEntity(SecurityRoleDescription securityRoleDescription) {
134        return securityRoleDescription.getSecurityRole();
135    }
136
137    @Override
138    public void fillInResult(EditSecurityRoleDescriptionResult result, SecurityRoleDescription securityRoleDescription) {
139        var securityControl = Session.getModelController(SecurityControl.class);
140
141        result.setSecurityRoleDescription(securityControl.getSecurityRoleDescriptionTransfer(getUserVisit(), securityRoleDescription));
142    }
143
144    @Override
145    public void doLock(SecurityRoleDescriptionEdit edit, SecurityRoleDescription securityRoleDescription) {
146        edit.setDescription(securityRoleDescription.getDescription());
147    }
148
149    @Override
150    public void doUpdate(SecurityRoleDescription securityRoleDescription) {
151        var securityControl = Session.getModelController(SecurityControl.class);
152        SecurityRoleDescriptionValue securityRoleDescriptionValue = securityControl.getSecurityRoleDescriptionValue(securityRoleDescription);
153        
154        securityRoleDescriptionValue.setDescription(edit.getDescription());
155        
156        securityControl.updateSecurityRoleDescriptionFromValue(securityRoleDescriptionValue, getPartyPK());
157    }
158
159}