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.PartySecurityRoleTemplateEdit;
020import com.echothree.control.user.security.common.edit.SecurityEditFactory;
021import com.echothree.control.user.security.common.form.EditPartySecurityRoleTemplateForm;
022import com.echothree.control.user.security.common.result.EditPartySecurityRoleTemplateResult;
023import com.echothree.control.user.security.common.result.SecurityResultFactory;
024import com.echothree.control.user.security.common.spec.PartySecurityRoleTemplateSpec;
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.PartySecurityRoleTemplate;
030import com.echothree.model.data.security.server.entity.PartySecurityRoleTemplateDescription;
031import com.echothree.model.data.security.server.entity.PartySecurityRoleTemplateDetail;
032import com.echothree.model.data.security.server.value.PartySecurityRoleTemplateDescriptionValue;
033import com.echothree.model.data.security.server.value.PartySecurityRoleTemplateDetailValue;
034import com.echothree.model.data.user.common.pk.UserVisitPK;
035import com.echothree.util.common.message.ExecutionErrors;
036import com.echothree.util.common.validation.FieldDefinition;
037import com.echothree.util.common.validation.FieldType;
038import com.echothree.util.common.command.EditMode;
039import com.echothree.util.server.control.BaseAbstractEditCommand;
040import com.echothree.util.server.control.CommandSecurityDefinition;
041import com.echothree.util.server.control.PartyTypeDefinition;
042import com.echothree.util.server.control.SecurityRoleDefinition;
043import com.echothree.util.server.persistence.Session;
044import java.util.Arrays;
045import java.util.Collections;
046import java.util.List;
047
048public class EditPartySecurityRoleTemplateCommand
049        extends BaseAbstractEditCommand<PartySecurityRoleTemplateSpec, PartySecurityRoleTemplateEdit, EditPartySecurityRoleTemplateResult, PartySecurityRoleTemplate, PartySecurityRoleTemplate> {
050    
051    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
052    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
053    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
054    
055    static {
056        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
057                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
058                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
059                        new SecurityRoleDefinition(SecurityRoleGroups.PartySecurityRoleTemplate.name(), SecurityRoles.Edit.name())
060                        )))
061                )));
062        
063        SPEC_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
064                new FieldDefinition("PartySecurityRoleTemplateName", FieldType.ENTITY_NAME, true, null, null)
065                ));
066        
067        EDIT_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
068                new FieldDefinition("PartySecurityRoleTemplateName", 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 EditPartySecurityRoleTemplateCommand */
076    public EditPartySecurityRoleTemplateCommand(UserVisitPK userVisitPK, EditPartySecurityRoleTemplateForm form) {
077        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
078    }
079    
080    @Override
081    public EditPartySecurityRoleTemplateResult getResult() {
082        return SecurityResultFactory.getEditPartySecurityRoleTemplateResult();
083    }
084    
085    @Override
086    public PartySecurityRoleTemplateEdit getEdit() {
087        return SecurityEditFactory.getPartySecurityRoleTemplateEdit();
088    }
089    
090    @Override
091    public PartySecurityRoleTemplate getEntity(EditPartySecurityRoleTemplateResult result) {
092        var securityControl = Session.getModelController(SecurityControl.class);
093        PartySecurityRoleTemplate partySecurityRoleTemplate = null;
094        String partySecurityRoleTemplateName = spec.getPartySecurityRoleTemplateName();
095
096        if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
097            partySecurityRoleTemplate = securityControl.getPartySecurityRoleTemplateByName(partySecurityRoleTemplateName);
098        } else { // EditMode.UPDATE
099            partySecurityRoleTemplate = securityControl.getPartySecurityRoleTemplateByNameForUpdate(partySecurityRoleTemplateName);
100        }
101
102        if(partySecurityRoleTemplate != null) {
103            result.setPartySecurityRoleTemplate(securityControl.getPartySecurityRoleTemplateTransfer(getUserVisit(), partySecurityRoleTemplate));
104        } else {
105            addExecutionError(ExecutionErrors.UnknownPartySecurityRoleTemplateName.name(), partySecurityRoleTemplateName);
106        }
107
108        return partySecurityRoleTemplate;
109    }
110    
111    @Override
112    public PartySecurityRoleTemplate getLockEntity(PartySecurityRoleTemplate partySecurityRoleTemplate) {
113        return partySecurityRoleTemplate;
114    }
115    
116    @Override
117    public void fillInResult(EditPartySecurityRoleTemplateResult result, PartySecurityRoleTemplate partySecurityRoleTemplate) {
118        var securityControl = Session.getModelController(SecurityControl.class);
119        
120        result.setPartySecurityRoleTemplate(securityControl.getPartySecurityRoleTemplateTransfer(getUserVisit(), partySecurityRoleTemplate));
121    }
122    
123    @Override
124    public void doLock(PartySecurityRoleTemplateEdit edit, PartySecurityRoleTemplate partySecurityRoleTemplate) {
125        var securityControl = Session.getModelController(SecurityControl.class);
126        PartySecurityRoleTemplateDescription partySecurityRoleTemplateDescription = securityControl.getPartySecurityRoleTemplateDescription(partySecurityRoleTemplate, getPreferredLanguage());
127        PartySecurityRoleTemplateDetail partySecurityRoleTemplateDetail = partySecurityRoleTemplate.getLastDetail();
128        
129        edit.setPartySecurityRoleTemplateName(partySecurityRoleTemplateDetail.getPartySecurityRoleTemplateName());
130        edit.setIsDefault(partySecurityRoleTemplateDetail.getIsDefault().toString());
131        edit.setSortOrder(partySecurityRoleTemplateDetail.getSortOrder().toString());
132
133        if(partySecurityRoleTemplateDescription != null) {
134            edit.setDescription(partySecurityRoleTemplateDescription.getDescription());
135        }
136    }
137        
138    @Override
139    public void canUpdate(PartySecurityRoleTemplate partySecurityRoleTemplate) {
140        var securityControl = Session.getModelController(SecurityControl.class);
141        String partySecurityRoleTemplateName = edit.getPartySecurityRoleTemplateName();
142        PartySecurityRoleTemplate duplicatePartySecurityRoleTemplate = securityControl.getPartySecurityRoleTemplateByName(partySecurityRoleTemplateName);
143
144        if(duplicatePartySecurityRoleTemplate != null && !partySecurityRoleTemplate.equals(duplicatePartySecurityRoleTemplate)) {
145            addExecutionError(ExecutionErrors.DuplicatePartySecurityRoleTemplateName.name(), partySecurityRoleTemplateName);
146        }
147    }
148    
149    @Override
150    public void doUpdate(PartySecurityRoleTemplate partySecurityRoleTemplate) {
151        var securityControl = Session.getModelController(SecurityControl.class);
152        var partyPK = getPartyPK();
153        PartySecurityRoleTemplateDetailValue partySecurityRoleTemplateDetailValue = securityControl.getPartySecurityRoleTemplateDetailValueForUpdate(partySecurityRoleTemplate);
154        PartySecurityRoleTemplateDescription partySecurityRoleTemplateDescription = securityControl.getPartySecurityRoleTemplateDescriptionForUpdate(partySecurityRoleTemplate, getPreferredLanguage());
155        String description = edit.getDescription();
156
157        partySecurityRoleTemplateDetailValue.setPartySecurityRoleTemplateName(edit.getPartySecurityRoleTemplateName());
158        partySecurityRoleTemplateDetailValue.setIsDefault(Boolean.valueOf(edit.getIsDefault()));
159        partySecurityRoleTemplateDetailValue.setSortOrder(Integer.valueOf(edit.getSortOrder()));
160
161        securityControl.updatePartySecurityRoleTemplateFromValue(partySecurityRoleTemplateDetailValue, partyPK);
162
163        if(partySecurityRoleTemplateDescription == null && description != null) {
164            securityControl.createPartySecurityRoleTemplateDescription(partySecurityRoleTemplate, getPreferredLanguage(), description, partyPK);
165        } else if(partySecurityRoleTemplateDescription != null && description == null) {
166            securityControl.deletePartySecurityRoleTemplateDescription(partySecurityRoleTemplateDescription, partyPK);
167        } else if(partySecurityRoleTemplateDescription != null && description != null) {
168            PartySecurityRoleTemplateDescriptionValue partySecurityRoleTemplateDescriptionValue = securityControl.getPartySecurityRoleTemplateDescriptionValue(partySecurityRoleTemplateDescription);
169
170            partySecurityRoleTemplateDescriptionValue.setDescription(description);
171            securityControl.updatePartySecurityRoleTemplateDescriptionFromValue(partySecurityRoleTemplateDescriptionValue, partyPK);
172        }
173    }
174    
175}