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